Schnellstart: Durchlaufen von Vertices und Kanten mit der Gremlin-Konsole und Azure Cosmos DB for Apache Gremlin

Artikel
10/09/2023

GILT FÜR: Gremlin

Azure Cosmos DB for Apache Gremlin ist ein vollständig verwalteter Graphdatenbankdienst, der das beliebte Graphcomputingframework Apache Tinkerpop mit der Abfragesprache Gremlin implementiert. Die API für Gremlin ermöglicht mit einem Dienst, der mit minimalem Verwaltungsaufwand beliebig wachsen und skaliert werden kann, einen reibungslosen Einstieg in die Verwendung von Gremlin.

In dieser Schnellstartanleitung verwenden Sie die Gremlin-Konsole, um eine Verbindung mit einem neu erstellten Azure Cosmos DB for Gremlin-Konto herzustellen.

Voraussetzungen

Ein Azure-Konto mit einem aktiven Abonnement.
- Kein Azure-Abonnement? Registrieren Sie sich für ein kostenloses Azure-Konto.
- Sie möchten kein Azure-Abonnement? Sie können Azure Cosmos DB kostenlos testen, ohne dass ein Abonnement erforderlich ist.
Docker-Host
- Sie haben Docker nicht installiert? Probieren Sie diese Schnellstartanleitung in GitHub Codespaces aus.
Azure-Befehlszeilenschnittstelle (CLI)

Azure Cloud Shell

Azure hostet Azure Cloud Shell, eine interaktive Shell-Umgebung, die Sie über Ihren Browser nutzen können. Sie können entweder Bash oder PowerShell mit Cloud Shell verwenden, um mit Azure-Diensten zu arbeiten. Sie können die vorinstallierten Befehle von Cloud Shell verwenden, um den Code in diesem Artikel auszuführen, ohne etwas in Ihrer lokalen Umgebung installieren zu müssen.

Starten von Azure Cloud Shell:

Option	Beispiel/Link
Wählen Sie rechts oben in einem Code- oder Befehlsblock die Option Ausprobieren aus. Durch die Auswahl von Ausprobieren wird der Code oder Befehl nicht automatisch in Cloud Shell kopiert.
Rufen Sie https://shell.azure.com auf, oder klicken Sie auf die Schaltfläche Cloud Shell starten, um Cloud Shell im Browser zu öffnen.
Wählen Sie im Azure-Portal rechts oben im Menü die Schaltfläche Cloud Shell aus.

So verwenden Sie Azure Cloud Shell:

Starten Sie Cloud Shell.
Wählen Sie die Schaltfläche Kopieren für einen Codeblock (oder Befehlsblock) aus, um den Code oder Befehl zu kopieren.
Fügen Sie den Code oder Befehl mit STRG+UMSCHALT+V unter Windows und Linux oder CMD+UMSCHALT+V unter macOS in die Cloud Shell-Sitzung ein.
Drücken Sie die EINGABETASTE, um den Code oder Befehl auszuführen.

Erstellen eines API für Gremlin-Kontos und relevanter Ressourcen

Das API für Gremlin-Konto sollte vor der Verwendung der Gremlin-Konsole erstellt werden. Darüber hinaus ist es hilfreich, wenn die Datenbank und der Graph bereits vorhanden sind.

Erstellen Sie Shellvariablen für accountName, resourceGroupName und location.

# Variable for resource group name
resourceGroupName="msdocs-cosmos-gremlin-quickstart"
location="westus"

# Variable for account name with a randomly generated suffix

let suffix=$RANDOM*$RANDOM
accountName="msdocs-gremlin-$suffix"

Melden Sie sich mithilfe von az login bei der Azure CLI an, falls Sie dies noch nicht getan haben.
Verwenden Sie az group create, um eine neue Ressourcengruppe in Ihrem Abonnement zu erstellen.
```
az group create \
    --name $resourceGroupName \
    --location $location
```
Verwenden Sie az cosmosdb create, um ein neues „API für Gremlin“-Konto mit Standardeinstellungen zu erstellen.
```
az cosmosdb create \
    --resource-group $resourceGroupName \
    --name $accountName \
    --capabilities "EnableGremlin" \
    --locations regionName=$location \
    --enable-free-tier true
```
Hinweis

Sie können pro Azure-Abonnement maximal ein Azure Cosmos DB-Konto im Free-Tarif einrichten und müssen sich beim Erstellen des Kontos anmelden. Ist dieser Befehl zum Anwenden des tarifspezifischen Rabatts für den Free-Tarif nicht erfolgreich, bedeutet dies, dass bereits ein anderes Konto im Abonnement mit dem Free-Tarif aktiviert wurde.

Rufen Sie mithilfe von az cosmosdb show den API für Gremlin-Endpunkt NAME für das Konto ab:

az cosmosdb show \
    --resource-group $resourceGroupName \
    --name $accountName \
    --query "name"

Ermitteln Sie mit az-cosmosdb-keys-list den SCHLÜSSEL in der Liste der Schlüssel für das Konto:

az cosmosdb keys list \
    --resource-group $resourceGroupName \
    --name $accountName \
    --type "keys" \
    --query "primaryMasterKey"

Notieren Sie sich die Werte für NAME und SCHLÜSSEL. Sie verwenden diese Anmeldeinformationen später.

Erstellen Sie mithilfe von az cosmosdb gremlin database create eine Datenbank mit der Bezeichnung cosmicworks:

az cosmosdb gremlin database create \
    --resource-group $resourceGroupName \
    --account-name $accountName \
    --name "cosmicworks"

Erstellen Sie mithilfe von az cosmosdb gremlin graph create einen Graphen. Nennen Sie den Graphen products, und legen Sie den Durchsatz auf 400 und den Partitionsschlüsselpfad auf /category fest.

az cosmosdb gremlin graph create \
    --resource-group $resourceGroupName \
    --account-name $accountName \
    --database-name "cosmicworks" \
    --name "products" \
    --partition-key-path "/category" \
    --throughput 400

Starten und Konfigurieren der Gremlin-Konsole mithilfe von Docker

Für die Gremlin-Konsole verwendet diese Schnellstartanleitung das Containerimage tinkerpop/gremlin-console von Docker Hub. Dieses Image stellt sicher, dass Sie die geeignete Version der Konsole (3.4) für die Verbindung mit der API für Gremlin verwenden. Sobald die Konsole ausgeführt wird, stellen Sie eine Verbindung von Ihrem lokalen Docker-Host mit dem API für Gremlin-Remotekonto her.

Rufen Sie Version 3.4 des Containerimages tinkerpop/gremlin-console ab.
```
docker pull tinkerpop/gremlin-console:3.4
```

Erstellen Sie einen leeren Arbeitsordner. Erstellen Sie im leeren Ordner eine Datei vom Typ remote-secure.yaml. Fügen Sie der Datei diese YAML-Konfiguration hinzu.

hosts: [<account-name>.gremlin.cosmos.azure.com]
port: 443
username: /dbs/cosmicworks/colls/products
password: <account-key>
connectionPool: {
  enableSsl: true,
  sslEnabledProtocols: [TLSv1.2]
}
serializer: {
  className: org.apache.tinkerpop.gremlin.driver.ser.GraphSONMessageSerializerV2d0,
  config: {
    serializeResultToString: true
  }
}

Hinweis

Ersetzen Sie die Platzhalter <account-name> und <account-key> durch die Werte für NAME und SCHLÜSSEL, die Sie zuvor in dieser Schnellstartanleitung abgerufen haben.

Öffnen Sie ein neues Terminal im Kontext Ihres Arbeitsordners, der die Datei remote-secure.yaml enthält.
Führen Sie das Docker-Containerimage im interaktiven Modus (--interactive --tty) aus. Binden Sie den aktuellen Arbeitsordner unbedingt im Pfad /opt/gremlin-console/conf/ innerhalb des Containers ein.
```
docker run -it --mount type=bind,source=.,target=/opt/gremlin-console/conf/ tinkerpop/gremlin-console:3.4
```
Stellen Sie im Gremlin-Konsolencontainer mithilfe der Konfigurationsdatei remote-secure.yaml eine Verbindung mit dem Remotekonto (API für Gremlin) her.
```
:remote connect tinkerpop.server conf/remote-secure.yaml
```

Erstellen und Durchlaufen von Vertices und Kanten

Nachdem die Konsole mit dem Konto verbunden wurde, verwenden Sie die Gremlin-Standardsyntax, um Vertices und Kanten zu erstellen und zu durchlaufen.

Fügen Sie einen Vertex für product mit den folgenden Eigenschaften hinzu:

Wert

label product

id 68719518371

name Kiama classic surfboard

price 285.55

category surfboards
```
:> g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')
```
Wichtig

Vergessen Sie nicht das Präfix :>. Dieses Präfix ist für die Remoteausführung des Befehls erforderlich.
Fügen Sie einen weiteren Vertex vom Typ product mit den folgenden Eigenschaften hinzu:

Wert

label product

id 68719518403

name Montau Turtle Surfboard

price 600

category surfboards
```
:> g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600).property('category', 'surfboards')
```
Erstellen Sie eine Kante namens replaces, um eine Beziehung zwischen den beiden Produkten zu definieren.
```
:> g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))
```
Zählen Sie alle Vertices innerhalb des Graphen.
```
:> g.V().count()
```

	Wert
label	`product`
id	`68719518371`
`name`	`Kiama classic surfboard`
`price`	`285.55`
`category`	`surfboards`

	Wert
label	`product`
id	`68719518403`
`name`	`Montau Turtle Surfboard`
`price`	`600`
`category`	`surfboards`

Durchlaufen Sie den Graphen, um alle Vertices zu suchen, die durch Kiama classic surfboard ersetzt werden.

:> g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Kiama classic surfboard').inE('replaces').outV()

Durchlaufen Sie den Graphen, um alle Vertices zu suchen, die durch Montau Turtle Surfboard ersetzt werden.

:> g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()

Bereinigen von Ressourcen

Wenn Sie das API für Gremlin-Konto nicht mehr benötigen, löschen Sie die entsprechende Ressourcengruppe.

Erstellen Sie eine Shell-Variable für resourceGroupName, wenn sie noch nicht vorhanden ist.
```
# Variable for resource group name
resourceGroupName="msdocs-cosmos-gremlin-quickstart"
```
Verwenden Sie az group delete, um die Ressourcengruppe zu löschen:
```
az group delete \
    --name $resourceGroupName
```

Wie haben wir das Problem gelöst?

Azure Cosmos DB for Apache Gremlin hat unser Problem gelöst, indem Gremlin als Dienst angeboten wurde. Mit diesem Angebot müssen Sie keine eigenen Gremlin-Serverinstanzen verwenden und keine eigene Infrastruktur verwalten. Darüber hinaus können Sie Ihre Lösung skalieren, wenn Ihre Anforderungen im Laufe der Zeit zunehmen.

Um eine Verbindung mit dem API für Gremlin-Konto herzustellen, haben Sie das Containerimage tinkerpop/gremlin-console verwendet, um die Gremlin-Konsole auf eine Weise auszuführen, die keine lokale Installation erforderte. Anschließend haben Sie die in der Datei remote-secure.yaml gespeicherte Konfiguration verwendet, um eine Verbindung vom ausgeführten Container mit dem API für Gremlin-Konto herzustellen. Von dort aus haben Sie mehrere gängige Gremlin-Befehle ausgeführt.

Nächster Schritt

Erstellen und Abfragen von Daten mithilfe von Azure Cosmos DB for Apache Gremlin