Azure Cosmos DB: Build a .NET Framework or Core application using the Graph API

Azure Cosmos DB is Microsoft’s globally distributed multi-model database service. You can quickly create and query document, key/value, and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Azure Cosmos DB.

This quick start demonstrates how to create an Azure Cosmos DB account, database, and graph (container) using the Azure portal. You then build and run a console app built on the Graph API (preview).

Prerequisites

If you don’t already have Visual Studio 2017 installed, you can download and use the free Visual Studio 2017 Community Edition. Make sure that you enable Azure development during the Visual Studio setup.

If you already have Visual Studio 2017 installed, make sure to be installed up to Visual Studio 2017 Update 3.

If you don't have an Azure subscription, create a free account before you begin.

Create a database account

  1. In a new browser window, sign in to the Azure portal.

  2. Click New > Databases > Azure Cosmos DB.

    Azure portal "Databases" pane

  3. In the New account page, enter the settings for the new Azure Cosmos DB account.

    Setting Suggested value Description
    ID Enter a unique name Enter a unique name to identify this Azure Cosmos DB account. Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique but identifiable ID.

    The ID can contain only lowercase letters, numbers, and the hyphen (-) character, and it must contain 3 to 50 characters.
    API Gremlin (graph) The API determines the type of account to create. Azure Cosmos DB provides five APIs to suits the needs of your application: SQL (document database), Gremlin (graph database), MongoDB (document database), Azure Table, and Cassandra, each which currently require a separate account.

    Select Gremlin (graph) because in this quickstart you are creating a graph that is queryable using Gremlin syntax.

    Learn more about the Graph API
    Subscription Your subscription Select Azure subscription that you want to use for this Azure Cosmos DB account.
    Resource group Enter the same unique name as provided above in ID Enter a new resource-group name for your account. For simplicity, you can use the same name as your ID.
    Location Select the region closest to your users Select geographic location in which to host your Azure Cosmos DB account. Use the location that's closest to your users to give them the fastest access to the data.
    Enable geo-redundancy Leave blank This creates a replicated version of your database in a second (paired) region. Leave this blank.
    Pin to dashboard Select Select this box so that your new database account is added to your portal dashboard for easy access.

    Then click Create.

    The new account blade for Azure Cosmos DB

  4. The account creation takes a few minutes. During account creation the portal displays the Deploying Azure Cosmos DB tile on the right side, you may need to scroll right on your dashboard to see the tile. There is also a progress bar displayed near the top of the screen. You can watch either area for progress.

    The Azure portal Notifications pane

    Once the account is created, the Congratulations! Your Azure Cosmos DB account was created page is displayed.

Add a graph

You can now use the Data Explorer tool in the Azure portal to create a graph database.

  1. In the Azure portal, in the menu on the left, select Data Explorer (Preview).

  2. Under Data Explorer (Preview), select New Graph. Then fill in the page by using the following information:

    Data Explorer in the Azure portal

    Setting Suggested value Description
    Database id sample-database Enter sample-database as the name for the new database. Database names must be between 1 and 255 characters and can't contain / \ # ? or a trailing space.
    Graph id sample-graph Enter sample-graph as the name for your new collection. Graph names have the same character requirements as database IDs.
    Storage capacity 10 GB Leave the default value. This is the storage capacity of the database.
    Throughput 400 RUs Leave the default value. You can scale up the throughput later if you want to reduce latency.
    Partition key /firstName A partition key that distributes data evenly to each partition. Selecting the correct partition key is important in creating a performant graph. For more information, see Designing for partitioning.
  3. After the form is filled out, select OK.

Clone the sample application

Now let's clone a Graph API app from github, set the connection string, and run it. You'll see how easy it is to work with data programmatically.

This sample project is using .NET Core project format and has been configured to target the following frameworks:

  • netcoreapp2.0
  • net461
  1. Open a git terminal window, such as git bash, and cd to a working directory.

  2. Run the following command to clone the sample repository.

    git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-dotnet-getting-started.git
    
  3. Then open Visual Studio and open the solution file.

Review the code

Let's make a quick review of what's happening in the app. Open the Program.cs file and you'll find that these lines of code create the Azure Cosmos DB resources.

  • The DocumentClient is initialized. In the preview, we added a graph extension API on the Azure Cosmos DB client. We are working on a standalone graph client decoupled from the Azure Cosmos DB client and resources.

    using (DocumentClient client = new DocumentClient(
        new Uri(endpoint),
        authKey,
        new ConnectionPolicy { ConnectionMode = ConnectionMode.Direct, ConnectionProtocol = Protocol.Tcp }))
    
  • A new database is created.

    Database database = await client.CreateDatabaseIfNotExistsAsync(new Database { Id = "graphdb" });
    
  • A new graph is created.

    DocumentCollection graph = await client.CreateDocumentCollectionIfNotExistsAsync(
        UriFactory.CreateDatabaseUri("graphdb"),
        new DocumentCollection { Id = "graph" },
        new RequestOptions { OfferThroughput = 1000 });
    
  • A series of Gremlin steps are executed using the CreateGremlinQuery method.

    // The CreateGremlinQuery method extensions allow you to execute Gremlin queries and iterate
    // results asychronously
    IDocumentQuery<dynamic> query = client.CreateGremlinQuery<dynamic>(graph, "g.V().count()");
    while (query.HasMoreResults)
    {
        foreach (dynamic result in await query.ExecuteNextAsync())
        {
            Console.WriteLine($"\t {JsonConvert.SerializeObject(result)}");
        }
    }
    

Update your connection string

Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. In the Azure portal, click Keys.

    Copy the first portion of the URI value.

    View and copy an access key in the Azure portal, Keys page

  2. In Visual Studio 2017, open the appsettings.json file and paste the value over FILLME in the endpoint.

    "endpoint": "https://FILLME.documents.azure.com:443/",

    The endpoint value should now look like this:

    "endpoint": "https://testgraphacct.documents.azure.com:443/",

  3. If you created your graph database account before November 27th, 2017, change documents to graphs in the endpoint value. If you created your graph database account on or after November 27th, 2017, change documents to gremlin.cosmosdb in the endpoint value.

    The endpoint value should now look like this:

    "endpoint": "https://testgraphacct.graphs.azure.com:443/", or "endpoint": "https://testgraphacct.gremlin.cosmosdb.azure.com:443/",

  4. Copy your PRIMARY KEY value from the portal, and make it the value of the AuthKey key in App.config, then save your changes.

    "authkey": "FILLME"

  5. Save the appsettings.json file.

You've now updated your app with all the info it needs to communicate with Azure Cosmos DB.

Run the console app

Before running the application, it is recommended that you update the Microsoft.Azure.Graphs package to the latest version.

  1. In Visual Studio, right-click on the GraphGetStarted project in Solution Explorer and then click Manage NuGet Packages.

  2. In the NuGet Package Manager Updates tab, type Microsoft.Azure.Graphs and check the Includes prerelease box.

  3. From the results, update the Microsoft.Azure.Graphs library to the latest version of the package. This installs the Azure Cosmos DB graph extension library package and all dependencies.

    If you get a message about reviewing changes to the solution, click OK. If you get a message about license acceptance, click I accept.

  4. Click CTRL + F5 to run the application.

    The console window displays the vertexes and edges being added to the graph. When the script completes, press ENTER twice to close the console window.

Browse using the Data Explorer

You can now go back to Data Explorer in the Azure portal and browse and query your new graph data.

  1. In Data Explorer, the new database appears in the Graphs pane. Expand graphdb, graphcollz, and then click Graph.

  2. Click the Apply Filter button to use the default query to view all the verticies in the graph. The data generated by the sample app is displayed in the Graphs pane.

    You can zoom in and out of the graph, you can expand the graph display space, add additional verticies, and move verticies on the display surface.

    View the graph in Data Explorer in the Azure portal

Review SLAs in the Azure portal

The throughput, storage, availability, latency, and consistency of the resources in your account are monitored in the Azure portal. Let's take a quick look at these metrics.

  1. Click Metrics in the navigation menu.

    Metrics in the Azure portal

  2. Click through each of the tabs so you're aware of the metrics Azure Cosmos DB provides.

    Each chart that's associated with the Azure Cosmos DB Service Level Agreements (SLAs) provides a line that shows if any of the SLAs have been violated. Azure Cosmos DB makes monitoring your SLAs transparent with this suite of metrics.

    Azure Cosmos DB metrics suite

Clean up resources

If you're not going to continue to use this app, delete all resources created by this quickstart in the Azure portal with the following steps:

  1. From the left-hand menu in the Azure portal, click Resource groups and then click the name of the resource you created.
  2. On your resource group page, click Delete, type the name of the resource to delete in the text box, and then click Delete.

Next steps

In this quickstart, you've learned how to create an Azure Cosmos DB account, create a graph using the Data Explorer, and run an app. You can now build more complex queries and implement powerful graph traversal logic using Gremlin.