Schnellstart: Erstellen einer .NET Framework- oder Core-Anwendung mithilfe des Gremlin-API-Kontos für Azure Cosmos DBQuickstart: Build a .NET Framework or Core application using the Azure Cosmos DB Gremlin API account

Azure Cosmos DB ist ein global verteilter Datenbankdienst von Microsoft mit mehreren Modellen.Azure Cosmos DB is Microsoft's globally distributed multi-model database service. Sie können schnell Dokument-, Schlüssel/Wert- und Graph-Datenbanken erstellen und abfragen und dabei stets die Vorteile der globalen Verteilung und der horizontalen Skalierung nutzen, die Azure Cosmos DB zugrunde liegen.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.

In dieser Schnellstartanleitung wird veranschaulicht, wie Sie mithilfe des Azure-Portals ein Gremlin-API-Konto, eine Datenbank und einen Graph (Container) für Azure Cosmos DB erstellen.This quickstart demonstrates how to create an Azure Cosmos DB Gremlin API account, database, and graph (container) using the Azure portal. Anschließend erstellen Sie eine Konsolenanwendung mithilfe des Open-Source-Treibers Gremlin.Net und führen diese aus.You then build and run a console app built using the open-source driver Gremlin.Net.

VoraussetzungenPrerequisites

Falls Sie Visual Studio 2019 noch nicht installiert haben, können Sie die kostenlose Visual Studio 2019 Community-Edition herunterladen und verwenden.If you don't already have Visual Studio 2019 installed, you can download and use the free Visual Studio 2019 Community Edition. Aktivieren Sie beim Setup von Visual Studio die Option Azure-Entwicklung.Make sure that you enable Azure development during the Visual Studio setup.

Wenn Sie kein Azure-Abonnement besitzen, erstellen Sie ein kostenloses Konto, bevor Sie beginnen.If you don't have an Azure subscription, create a free account before you begin.

Erstellen eines DatenbankkontosCreate a database account

  1. Melden Sie sich in einem neuen Browserfenster beim Azure-Portal an.In a new browser window, sign in to the Azure portal.

  2. Klicken Sie auf Ressourcen erstellen > Datenbanken > Azure Cosmos DB.Click Create a resource > Databases > Azure Cosmos DB.

    Bereich „Datenbanken“ im Azure-Portal

  3. Geben Sie auf der Seite Azure Cosmos DB-Konto erstellen die Einstellungen für das neue Azure Cosmos DB-Konto ein.In the Create Azure Cosmos DB Account page, enter the settings for the new Azure Cosmos DB account.

    EinstellungSetting WertValue BESCHREIBUNGDescription
    SubscriptionSubscription Ihr AbonnementYour subscription Wählen Sie das Azure-Abonnement aus, das Sie für dieses Azure Cosmos DB-Konto verwenden möchten.Select the Azure subscription that you want to use for this Azure Cosmos DB account.
    RessourcengruppeResource Group Neu erstellenCreate new

    Derselbe eindeutige Name wie für die IDThen enter the same unique name as provided in ID
    Wählen Sie Neu erstellen.Select Create new. Geben Sie dann einen neuen Ressourcengruppenname für Ihr Konto ein.Then enter a new resource-group name for your account. Verwenden Sie der Einfachheit halber denselben Namen wie bei Ihrer ID.For simplicity, use the same name as your ID.
    KontonameAccount Name Geben Sie einen eindeutigen Namen ein.Enter a unique name Geben Sie einen eindeutigen Namen ein, der Ihr Azure Cosmos DB-Konto identifiziert.Enter a unique name to identify your Azure Cosmos DB account. Da documents.azure.com an die ID angefügt wird, die Sie für die URI-Erstellung angeben, muss die ID eindeutig sein.Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique ID.

    Die ID darf nur Kleinbuchstaben, Zahlen und den Bindestrich (-) enthalten.The ID can use only lowercase letters, numbers, and the hyphen (-) character. Sie muss zwischen 3 und 31 Zeichen lang sein.It must be between 3 and 31 characters in length.
    APIAPI Gremlin (Graph)Gremlin (graph) Die API bestimmt den Typ des zu erstellenden Kontos.The API determines the type of account to create. Azure Cosmos DB stellt fünf APIs bereit: Core (SQL)-API für Dokumentdatenbanken, Gremlin-API für Graphdatenbanken, MongoDB-API für Dokumentdatenbanken, Azure Table und Cassandra.Azure Cosmos DB provides five APIs: Core(SQL) for document databases, Gremlin for graph databases, MongoDB for document databases, Azure Table, and Cassandra. Derzeit müssen Sie ein separates Konto für jede API erstellen.Currently, you must create a separate account for each API.

    Wählen Sie Gremlin (graph) aus, da Sie mit dieser Schnellstartanleitung eine Tabelle erstellen, die mit der Gremlin-API verwendet werden kann.Select Gremlin (graph) because in this quickstart you are creating a table that works with the Gremlin API.

    Erfahren Sie mehr über die Graph-API.Learn more about the Graph API.
    LocationLocation Wählen Sie die Region aus, die Ihren Benutzern am nächsten liegt.Select the region closest to your users Wählen Sie einen geografischen Standort aus, an dem Ihr Azure Cosmos DB-Konto gehostet werden soll.Select a geographic location to host your Azure Cosmos DB account. Verwenden Sie einen Standort, der Ihren Benutzern am nächsten liegt, um ihnen einen schnellen Zugriff auf die Daten zu gewähren.Use the location that's closest to your users to give them the fastest access to the data.

    Wählen Sie Bewerten + erstellen aus.Select Review+Create. Sie können die Abschnitte Netzwerk und Tags überspringen.You can skip the Network and Tags section.

    Der Abschnitt „Neues Konto“ für Azure Cosmos DB

  4. Die Kontoerstellung dauert einige Minuten.The account creation takes a few minutes. Warten Sie, bis das Portal die Seite Herzlichen Glückwunsch! Ihr Azure Cosmos DB-Konto wurde erstellt anzeigt.Wait for the portal to display the Congratulations! Your Azure Cosmos DB account was created page.

    Der Bereich „Benachrichtigungen“ im Azure-Portal

Hinzufügen eines GraphsAdd a graph

Sie können nun mithilfe des Daten-Explorer-Tools im Azure-Portal eine Diagrammdatenbank erstellen.You can now use the Data Explorer tool in the Azure portal to create a graph database.

  1. Wählen Sie Daten-Explorer > New Graph (Neues Diagramm) aus.Select Data Explorer > New Graph.

    Der Bereich Add Graph (Graph hinzufügen) wird rechts angezeigt. Möglicherweise müssen Sie nach rechts scrollen, damit Sie ihn sehen.The Add Graph area is displayed on the far right, you may need to scroll right to see it.

    „Daten-Explorer“ im Azure-Portal, Seite „Graph hinzufügen“

  2. Geben Sie auf der Seite Graph hinzufügen die Einstellungen für den neuen Graphen ein.In the Add graph page, enter the settings for the new graph.

    EinstellungSetting Empfohlener WertSuggested value BESCHREIBUNGDescription
    Datenbank-IDDatabase ID sample-databasesample-database Geben Sie sample-database als Namen für die neue Datenbank ein.Enter sample-database as the name for the new database. Datenbanknamen müssen zwischen 1 und 255 Zeichen lang sein und dürfen weder / \ # ? noch nachgestellte Leerzeichen enthalten.Database names must be between 1 and 255 characters, and cannot contain / \ # ? or a trailing space.
    ThroughputThroughput 400 RUs400 RUs Ändern Sie den Durchsatz in 400 Anforderungseinheiten pro Sekunde (RU/s).Change the throughput to 400 request units per second (RU/s). Sie können den Durchsatz später zentral hochskalieren, wenn Sie Wartezeiten reduzieren möchten.If you want to reduce latency, you can scale up the throughput later.
    Graph-IDGraph ID sample-graphsample-graph Geben Sie sample-graph als Namen für die neue Sammlung ein.Enter sample-graph as the name for your new collection. Für Diagrammnamen gelten dieselben Zeichenanforderungen wie für Datenbank-IDs.Graph names have the same character requirements as database IDs.
    PartitionsschlüsselPartition Key /pk/pk Alle Cosmos DB-Konten benötigen zum horizontalen Skalieren einen Partitionsschlüssel.All Cosmos DB accounts need a partition key to horizontally scale. Informationen zum Auswählen eines geeigneten Partitionsschlüssels finden Sie unter Verwenden eines partitionierten Graphen in Azure Cosmos DB.Learn how to select an appropriate partition key in the Graph Data Partitioning article.
  3. Wählen Sie OK aus, nachdem Sie das Formular ausgefüllt haben.Once the form is filled out, select OK.

Klonen der BeispielanwendungClone the sample application

Klonen Sie eine Gremlin-API-App aus GitHub, legen Sie die Verbindungszeichenfolge fest, und führen Sie sie aus.Now let's clone a Gremlin API app from GitHub, set the connection string, and run it. Sie werden feststellen, wie einfach Sie programmgesteuert mit Daten arbeiten können.You'll see how easy it is to work with data programmatically.

  1. Öffnen Sie eine Eingabeaufforderung, erstellen Sie einen neuen Ordner namens „git-samples“, und schließen Sie die Eingabeaufforderung.Open a command prompt, create a new folder named git-samples, then close the command prompt.

    md "C:\git-samples"
    
  2. Öffnen Sie ein Git-Terminalfenster (z.B. git bash), und verwenden Sie den Befehl cd, um in den neuen Ordner zu gelangen und dort die Beispiel-App zu installieren.Open a git terminal window, such as git bash, and use the cd command to change to the new folder to install the sample app.

    cd "C:\git-samples"
    
  3. Führen Sie den folgenden Befehl aus, um das Beispielrepository zu klonen.Run the following command to clone the sample repository. Dieser Befehl erstellt eine Kopie der Beispiel-App auf Ihrem Computer.This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-gremlindotnet-getting-started.git
    
  4. Öffnen Sie anschließend Visual Studio und die Projektmappendatei.Then open Visual Studio and open the solution file.

  5. Stellen Sie die NuGet-Pakete im Projekt wieder her.Restore the NuGet packages in the project. Diese sollten den Treiber „Gremlin.Net“ und das Paket „Newtonsoft.Json“ umfassen.This should include the Gremlin.Net driver, as well as the Newtonsoft.Json package.

  6. Sie können den Treiber „Gremlin.Net“ aber auch manuell mithilfe des NuGet-Paket-Managers oder des NuGet-Befehlszeilentools installieren:You can also install the Gremlin.Net driver manually using the Nuget package manager, or the nuget command-line utility:

    nuget install Gremlin.Net
    

Überprüfen des CodesReview the code

Dieser Schritt ist optional.This step is optional. Wenn Sie erfahren möchten, wie die Datenbankressourcen im Code erstellt werden, können Sie sich die folgenden Codeausschnitte ansehen.If you're interested in learning how the database resources are created in the code, you can review the following snippets. Andernfalls können Sie mit Aktualisieren der Verbindungszeichenfolge fortfahren.Otherwise, you can skip ahead to Update your connection string.

Die folgenden Codeausschnitte stammen alle aus der Datei „Program.cs“.The following snippets are all taken from the Program.cs file.

  • Legen Sie Ihre Verbindungsparameter auf der Grundlage des weiter oben erstellten Kontos fest (Zeile 19):Set your connection parameters based on the account created above (Line 19):

    private static string hostname = "your-endpoint.gremlin.cosmosdb.azure.com";
    private static int port = 443;
    private static string authKey = "your-authentication-key";
    private static string database = "your-database";
    private static string collection = "your-graph-container";
    
  • Die auszuführenden Gremlin-Befehle sind in einem Wörterbuch aufgeführt (Zeile 26):The Gremlin commands to be executed are listed in a Dictionary (Line 26):

    private static Dictionary<string, string> gremlinQueries = new Dictionary<string, string>
    {
        { "Cleanup",        "g.V().drop()" },
        { "AddVertex 1",    "g.addV('person').property('id', 'thomas').property('firstName', 'Thomas').property('age', 44).property('pk', 'pk')" },
        { "AddVertex 2",    "g.addV('person').property('id', 'mary').property('firstName', 'Mary').property('lastName', 'Andersen').property('age', 39).property('pk', 'pk')" },
        { "AddVertex 3",    "g.addV('person').property('id', 'ben').property('firstName', 'Ben').property('lastName', 'Miller').property('pk', 'pk')" },
        { "AddVertex 4",    "g.addV('person').property('id', 'robin').property('firstName', 'Robin').property('lastName', 'Wakefield').property('pk', 'pk')" },
        { "AddEdge 1",      "g.V('thomas').addE('knows').to(g.V('mary'))" },
        { "AddEdge 2",      "g.V('thomas').addE('knows').to(g.V('ben'))" },
        { "AddEdge 3",      "g.V('ben').addE('knows').to(g.V('robin'))" },
        { "UpdateVertex",   "g.V('thomas').property('age', 44)" },
        { "CountVertices",  "g.V().count()" },
        { "Filter Range",   "g.V().hasLabel('person').has('age', gt(40))" },
        { "Project",        "g.V().hasLabel('person').values('firstName')" },
        { "Sort",           "g.V().hasLabel('person').order().by('firstName', decr)" },
        { "Traverse",       "g.V('thomas').out('knows').hasLabel('person')" },
        { "Traverse 2x",    "g.V('thomas').out('knows').hasLabel('person').out('knows').hasLabel('person')" },
        { "Loop",           "g.V('thomas').repeat(out()).until(has('id', 'robin')).path()" },
        { "DropEdge",       "g.V('thomas').outE('knows').where(inV().has('id', 'mary')).drop()" },
        { "CountEdges",     "g.E().count()" },
        { "DropVertex",     "g.V('thomas').drop()" },
    };
    
  • Erstellen Sie ein GremlinServer-Verbindungsobjekt mit den weiter oben angegebenen Parametern (Zeile 52):Create a GremlinServer connection object using the parameters provided above (Line 52):

    var gremlinServer = new GremlinServer(hostname, port, enableSsl: true, 
                                                    username: "/dbs/" + database + "/colls/" + collection, 
                                                    password: authKey);
    
  • Erstellen Sie ein neues GremlinClient-Objekt (Zeile 56):Create a new GremlinClient object (Line 56):

    var gremlinClient = new GremlinClient(gremlinServer, new GraphSON2Reader(), new GraphSON2Writer(), GremlinClient.GraphSON2MimeType);
    
  • Führen Sie die einzelnen Gremlin-Abfragen mit dem GremlinClient-Objekt mit einer asynchronen Aufgabe aus (Zeile 63).Execute each Gremlin query using the GremlinClient object with an async task (Line 63). Dadurch werden die Gremlin-Abfragen aus dem weiter oben definierten Wörterbuch gelesen (Zeile 26):This will read the Gremlin queries from the dictionary defined above (Line 26):

    var results = await gremlinClient.SubmitAsync<dynamic>(query.Value);
    
  • Rufen Sie die Ergebnisse ab, und lesen Sie die als Wörterbuch formatierten Werte unter Verwendung der Klasse JsonSerializer aus „Newtonsoft.Json“:Retrieve the result and read the values, which are formatted as a dictionary, using the JsonSerializer class from Newtonsoft.Json:

    foreach (var result in results)
    {
        // The vertex results are formed as dictionaries with a nested dictionary for their properties
        string output = JsonConvert.SerializeObject(result);
        Console.WriteLine(String.Format("\tResult:\n\t{0}", output));
    }
    

Aktualisieren der VerbindungszeichenfolgeUpdate your connection string

Wechseln Sie nun zurück zum Azure-Portal, um die Informationen der Verbindungszeichenfolge abzurufen und in die App zu kopieren.Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. Navigieren Sie im Azure-Portal zu Ihrem Graphdatenbankkonto.From the Azure portal, navigate to your graph database account. Auf der Registerkarte Übersicht werden zwei Endpunkte angezeigt:In the Overview tab, you can see two endpoints-

    .NET SDK-URI: Dieser Wert wird verwendet, wenn Sie unter Verwendung der Bibliothek „Microsoft.Azure.Graphs“ eine Verbindung mit dem Graphkonto herstellen..NET SDK URI - This value is used when you connect to the graph account by using Microsoft.Azure.Graphs library.

    Gremlin-Endpunkt: Dieser Wert wird verwendet, wenn Sie unter Verwendung der Bibliothek „Gremlin.Net“ eine Verbindung mit dem Graphkonto herstellen.Gremlin Endpoint - This value is used when you connect to the graph account by using Gremlin.Net library.

    Endpunkt kopieren

    Kopieren Sie zum Ausführen dieses Beispiels den Wert für Gremlin-Endpunkt, und löschen Sie die Portnummer am Ende. Der URI sieht dann wie folgt aus: https://<your cosmos db account name>.gremlin.cosmosdb.azure.comTo run this sample, copy the Gremlin Endpoint value, delete the port number at the end, that is the URI becomes https://<your cosmos db account name>.gremlin.cosmosdb.azure.com

  2. Fügen Sie den Wert in Zeile 19 von „Program.cs“ ein, sodass er your-endpoint in der Variablen hostname ersetzt.In Program.cs paste the value over your-endpoint in the hostname variable in line 19.

    "private static string hostname = "<your cosmos db account name>.gremlin.cosmosdb.azure.com";

    Der Endpunktwert sollte nun wie folgt aussehen:The endpoint value should now look like this:

    "private static string hostname = "testgraphacct.gremlin.cosmosdb.azure.com";

  3. Navigieren Sie als Nächstes zur Registerkarte Schlüssel, kopieren Sie den Wert für PRIMÄRSCHLÜSSEL aus dem Portal, und fügen Sie ihn in die Variable authkey ein, sodass er den Platzhalter "your-authentication-key" in Zeile 21 ersetzt.Next, navigate to the Keys tab and copy PRIMARY KEY value from the portal, and paste it in the authkey variable, replacing the "your-authentication-key" placeholder in line 21.

    private static string authKey = "your-authentication-key";

  4. Fügen Sie den Datenbanknamen aus den Informationen der weiter oben erstellten Datenbank in die Variable database ein (Zeile 22).Using the information of the database created above, paste the database name inside of the database variable in line 22.

    private static string database = "your-database";

  5. Fügen Sie den Namen der Sammlung (der gleichzeitig der Graphname ist) aus den Informationen des weiter oben erstellten Containers in die Variable collection ein (Zeile 23).Similarly, using the information of the container created above, paste the collection (which is also the graph name) inside of the collection variable in line 23.

    private static string collection = "your-collection-or-graph";

  6. Speichern Sie die Datei "Program.cs".Save the Program.cs file.

Sie haben die App nun mit allen erforderlichen Informationen für die Kommunikation mit Azure Cosmos DB aktualisiert.You've now updated your app with all the info it needs to communicate with Azure Cosmos DB.

Ausführen der KonsolenanwendungRun the console app

Drücken Sie STRG+F5, um die Anwendung auszuführen.Click CTRL + F5 to run the application. Die Anwendung gibt sowohl die Gremlin-Abfragebefehle als auch die Ergebnisse in der Konsole aus.The application will print both the Gremlin query commands and results in the console.

Im Konsolenfenster werden die Scheitelpunkte und Ränder angezeigt, die dem Graph hinzugefügt werden.The console window displays the vertexes and edges being added to the graph. Drücken Sie nach Abschluss des Skripts die EINGABETASTE, um das Konsolenfenster zu schließen.When the script completes, press ENTER to close the console window.

Durchsuchen mit dem Daten-ExplorerBrowse using the Data Explorer

Sie können nun zum Daten-Explorer im Azure-Portal zurückkehren und die neuen Graph-Daten durchsuchen und abfragen.You can now go back to Data Explorer in the Azure portal and browse and query your new graph data.

  1. Im Daten-Explorer wird die neue Datenbank im Diagrammbereich angezeigt.In Data Explorer, the new database appears in the Graphs pane. Erweitern Sie den Datenbank- und den Containerknoten, und klicken Sie anschließend auf Graph.Expand the database and container nodes, and then click Graph.

  2. Klicken Sie auf die Schaltfläche Filter anwenden, um die Standardabfrage zum Anzeigen aller Scheitelpunkte im Diagramm zu verwenden.Click the Apply Filter button to use the default query to view all the vertices in the graph. Die von der Beispiel-App generierten Daten werden im Graphen-Bereich angezeigt.The data generated by the sample app is displayed in the Graphs pane.

    Sie können die Diagrammansicht vergrößern und verkleinern, den Anzeigebereich des Diagramms erweitern, zusätzliche Scheitelpunkte hinzufügen und Scheitelpunkte auf der Anzeigeoberfläche verschieben.You can zoom in and out of the graph, you can expand the graph display space, add additional vertices, and move vertices on the display surface.

    Anzeigen des Diagramms im Daten-Explorer im Azure-Portal

Überprüfen von SLAs im Azure-PortalReview SLAs in the Azure portal

Im Azure-Portal werden Durchsatz, Speicher, Verfügbarkeit, Wartezeit und Konsistenz Ihres Cosmos DB-Kontos überwacht.The Azure portal monitors your Cosmos DB account throughput, storage, availability, latency, and consistency. Diagramme für Metriken einer Azure Cosmos DB-SLA (Service Level Agreement, Vereinbarung zum Servicelevel) zeigen den SLA-Wert im Vergleich zur tatsächlichen Leistung.Charts for metrics associated with an Azure Cosmos DB Service Level Agreement (SLA) show the SLA value compared to actual performance. Diese Sammlung von Metriken macht die Überwachung Ihrer SLAs transparent.This suite of metrics makes monitoring your SLAs transparent.

So überprüfen Sie Metriken und SLAs:To review metrics and SLAs:

  1. Wählen Sie im Navigationsmenü Ihres Cosmos DB-Kontos die Option Metrik aus.Select Metrics in your Cosmos DB account's navigation menu.

  2. Wählen Sie eine Registerkarte (etwa Wartezeit) und auf der rechten Seite einen Zeitraum aus.Select a tab such as Latency, and select a timeframe on the right. Vergleichen Sie Zeilen Tatsächlich und SLA in den Diagrammen.Compare the Actual and SLA lines on the charts.

    Azure Cosmos DB-Metriken

  3. Überprüfen Sie die Metriken auf den anderen Registerkarten.Review the metrics on the other tabs.

Bereinigen von RessourcenClean up resources

Wenn Sie Ihre Web-App und das Azure Cosmos DB-Konto fertiggestellt haben, können Sie die erstellten Azure-Ressourcen löschen, damit keine weiteren Gebühren anfallen.When you're done with your web app and Azure Cosmos DB account, you can delete the Azure resources you created so you don't incur more charges. So löschen Sie die Ressourcen:To delete the resources:

  1. Wählen Sie ganz links im Azure-Portal Ressourcengruppen aus.In the Azure portal, select Resource groups on the far left. Wenn das linke Menü reduziert ist, wählen Sie die Schaltfläche Erweitern aus, um es zu erweitern.If the left menu is collapsed, select Expand button to expand it.

  2. Wählen Sie die Ressourcengruppe aus, die Sie für diesen Schnellstart erstellt haben.Select the resource group you created for this quickstart.

    Auswählen der zu löschenden Ressourcengruppe

  3. Wählen Sie im neuen Fenster Ressourcengruppe löschen aus.In the new window, select Delete resource group.

    Löschen der Ressourcengruppe

  4. Geben Sie in dem nächsten Fenster den Namen der zu löschenden Ressourcengruppe ein, und wählen Sie dann Löschen aus.In the next window, enter the name of the resource group to delete, and then select Delete.

Nächste SchritteNext steps

In diesem Schnellstart haben Sie gelernt, wie Sie ein Azure Cosmos DB-Konto erstellen, einen Graph mit dem Daten-Explorer erstellen und eine App ausführen.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. Nun können Sie komplexere Abfragen erstellen und leistungsfähige Logik zum Traversieren von Graphen mit Gremlin implementieren.You can now build more complex queries and implement powerful graph traversal logic using Gremlin.