Freigeben über


Schnellstart: Azure Cosmos DB für Apache Gremlin-Clientbibliothek für Python

Von Bedeutung

Suchen Sie nach einer Datenbanklösung für hochskalige Szenarien mit einer Vereinbarung über verfügbarkeitsbasierte Servicelevels (Service Level Agreement, SLA) von 99,999% Verfügbarkeit, sofortige Automatische Skalierung und automatisches Failover über mehrere Regionen hinweg? Betrachten Sie Azure Cosmos DB für NoSQL.

Möchten Sie ein OLAP-Diagramm (Online Analytical Processing) implementieren oder eine vorhandene Apache Gremlin-Anwendung migrieren? Betrachten Sie Graph in Microsoft Fabric.

Erste Schritte mit der Azure Cosmos DB für Apache Gremlin-Clientbibliothek für Python zum Speichern, Verwalten und Abfragen unstrukturierter Daten. Führen Sie die Schritte in diesem Handbuch aus, um ein neues Konto zu erstellen, eine Python-Clientbibliothek zu installieren, eine Verbindung mit dem Konto herzustellen, allgemeine Vorgänge auszuführen und Ihre endgültigen Beispieldaten abzufragen.

Quellcode der Bibliothek | Paket (PyPi)

Voraussetzungen

  • Ein Azure-Abonnement

    • Wenn Sie noch kein Azure-Abonnement haben, erstellen Sie ein kostenloses Konto, bevor Sie beginnen.
  • Die neueste Version der Azure CLI in Azure Cloud Shell.

    • Wenn Sie CLI-Referenzbefehle lieber lokal ausführen möchten, melden Sie sich mit dem az login Befehl bei der Azure CLI an.
  • Python 3.12 oder höher

Einrichten

Richten Sie zunächst die Konto- und Entwicklungsumgebung für diesen Leitfaden ein. In diesem Abschnitt erfahren Sie, wie Sie ein Konto erstellen, die Anmeldeinformationen des Kontos abrufen und Ihre Entwicklungsumgebung vorbereiten.

Erstellen eines Kontos

Erstellen Sie zunächst eine API für Apache Gremlin-Konto. Nachdem das Konto erstellt wurde, erstellen Sie die Datenbank- und Diagrammressourcen.

  1. Wenn Sie noch keine Zielressourcengruppe haben, verwenden Sie den az group create Befehl, um eine neue Ressourcengruppe in Ihrem Abonnement zu erstellen.

    az group create \
        --name "<resource-group-name>" \
        --location "<location>"
    
  2. Verwenden Sie den az cosmosdb create Befehl, um ein neues Azure Cosmos DB für Apache Gremlin-Konto mit Standardeinstellungen zu erstellen.

    az cosmosdb create \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --locations "regionName=<location>" \
        --capabilities "EnableGremlin"
    
  3. Erstellen Sie eine neue Datenbank mit az cosmosdb gremlin database create dem Namen cosmicworks.

    az cosmosdb gremlin database create \
        --resource-group "<resource-group-name>" \
        --account-name "<account-name>" \
        --name "cosmicworks"
    
  4. Verwenden Sie den az cosmosdb gremlin graph create Befehl, um ein neues Diagramm mit dem Namen productszu erstellen.

    az cosmosdb gremlin graph create \
        --resource-group "<resource-group-name>" \
        --account-name "<account-name>" \
        --database-name "cosmicworks" \
        --name "products" \
        --partition-key-path "/category"
    

Abrufen von Anmeldeinformationen

Rufen Sie nun das Kennwort für die Clientbibliothek ab, um eine Verbindung mit dem vor Kurzem erstellten Konto herzustellen.

  1. Verwenden Sie az cosmosdb show, um den Host für das Konto zu erhalten.

    az cosmosdb show \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --query "{host:name}"
    
  2. Notieren Sie den Wert der Eigenschaft host aus der Ausgabe des vorherigen Befehls. Der Wert dieser Eigenschaft ist der Host, den Sie später in dieser Anleitung verwenden, um eine Verbindung mit dem Konto mit der Bibliothek herzustellen.

  3. Verwenden Sie az cosmosdb keys list, um die Schlüssel für das Konto zu erhalten.

    az cosmosdb keys list \
        --resource-group "<resource-group-name>" \
        --name "<account-name>" \
        --type "keys"
    
  4. Notieren Sie den Wert der Eigenschaft primaryMasterKey aus der Ausgabe des vorherigen Befehls. Der Wert dieser Eigenschaft ist der Schlüssel , den Sie später in diesem Handbuch verwenden, um eine Verbindung mit dem Konto mit der Bibliothek herzustellen.

Vorbereiten der Entwicklungsumgebung

Konfigurieren Sie dann Ihre Entwicklungsumgebung mit einem neuen Projekt und der Clientbibliothek. Dieser Schritt ist die letzte erforderliche Voraussetzung, bevor Sie mit dem Rest dieses Handbuchs fortfahren.

  1. Starten Sie in einem leeren Ordner.

  2. Importieren Sie das gremlinpython Paket aus Python Package Index (PyPI).

    pip install gremlinpython
    
  3. Erstellen Sie die Datei app.py.

Objektmodell

BESCHREIBUNG
GremlinClient Stellt den Client dar, der zum Herstellen einer Verbindung und Interaktion mit dem Gremlin-Server verwendet wird.
GraphTraversalSource Wird verwendet, um Gremlin-Traversals zu konstruieren und auszuführen

Codebeispiele

Authentifizieren des Clients

Beginnen Sie damit, den Client mithilfe der Anmeldeinformationen zu authentifizieren, die zuvor in diesem Handbuch gesammelt wurden.

  1. Öffnen Sie die datei app.py in Ihrer integrierten Entwicklungsumgebung (IDE).

  2. Importieren Sie die folgenden Typen aus der gremlin_python.driver Bibliothek:

    • gremlin_python.driver.client
    • gremlin_python.driver.serializer
    from gremlin_python.driver import client, serializer
    
  3. Erstellen Sie String-Variablen für die zuvor in diesem Handbuch gesammelten Anmeldeinformationen. Benennen Sie die Variablen hostname und primary_key.

    hostname = "<host>"
    primary_key = "<key>"
    
  4. Erstellen Sie ein Client Objekt mit den Anmeldeinformationen und Konfigurationsvariablen, die in den vorherigen Schritten erstellt wurden. Geben Sie der Variablen den Namen client.

    client = client.Client(
        url=f"wss://{hostname}.gremlin.cosmos.azure.com:443/",
        traversal_source="g",
        username="/dbs/cosmicworks/colls/products",
        password=f"{primary_key}",
        message_serializer=serializer.GraphSONSerializersV2d0()
    )
    

Einfügen von Daten

Fügen Sie als Nächstes neue Vertex- und Randdaten in das Diagramm ein. Löschen Sie vor dem Erstellen der neuen Daten das Diagramm aller vorhandenen Daten.

  1. Führen Sie die g.V().drop() Abfrage aus, um alle Scheitelpunkte und Kanten aus dem Diagramm zu löschen.

    client.submit("g.V().drop()").all().result()
    
  2. Erstellen Sie eine Gremlin-Abfrage, die einen Scheitelpunkt hinzufügt.

    insert_vertex_query = (
        "g.addV('product')"
        ".property('id', prop_id)"
        ".property('name', prop_name)"
        ".property('category', prop_category)"
        ".property('quantity', prop_quantity)"
        ".property('price', prop_price)"
        ".property('clearance', prop_clearance)"
    )
    
  3. Fügen Sie einen Vertex für ein einzelnes Produkt hinzu.

    client.submit(
        message=insert_vertex_query,
        bindings={
            "prop_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
            "prop_name": "Yamba Surfboard",
            "prop_category": "gear-surf-surfboards",
            "prop_quantity": 12,
            "prop_price": 850.00,
            "prop_clearance": False,
        },
    ).all().result()
    
  4. Fügen Sie zwei weitere Scheitelpunkte für zwei zusätzliche Produkte hinzu.

    client.submit(
        message=insert_vertex_query,
        bindings={
            "prop_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
            "prop_name": "Montau Turtle Surfboard",
            "prop_category": "gear-surf-surfboards",
            "prop_quantity": 5,
            "prop_price": 600.00,
            "prop_clearance": True,
        },
    ).all().result()
    
    client.submit(
        message=insert_vertex_query,
        bindings={
            "prop_id": "cccccccc-2222-3333-4444-dddddddddddd",
            "prop_name": "Noosa Surfboard",
            "prop_category": "gear-surf-surfboards",
            "prop_quantity": 31,
            "prop_price": 1100.00,
            "prop_clearance": False,
        },
    ).all().result()
    
  5. Erstellen Sie eine weitere Gremlin-Abfrage, die einen Rand hinzufügt.

    insert_edge_query = (
        "g.V([prop_partition_key, prop_source_id])"
        ".addE('replaces')"
        ".to(g.V([prop_partition_key, prop_target_id]))"
    )
    
  6. Fügen Sie zwei Kanten hinzu.

    client.submit(
        message=insert_edge_query,
        bindings={
            "prop_partition_key": "gear-surf-surfboards",
            "prop_source_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
            "prop_target_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
        },
    ).all().result()
    
    client.submit(
        message=insert_edge_query,
        bindings={
            "prop_partition_key": "gear-surf-surfboards",
            "prop_source_id": "bbbbbbbb-1111-2222-3333-cccccccccccc",
            "prop_target_id": "cccccccc-2222-3333-4444-dddddddddddd",
        },
    ).all().result()
    

Daten lesen

Lesen Sie dann Daten, die zuvor in das Diagramm eingefügt wurden.

  1. Erstellen Sie eine Abfrage, die einen Scheitelpunkt mithilfe des eindeutigen Bezeichners und des Partitionsschlüsselwerts liest.

    read_vertex_query = "g.V([prop_partition_key, prop_id])"
    
  2. Lesen Sie dann einen Scheitelpunkt, indem Sie die erforderlichen Parameter angeben.

    matched_item = client.submit(
        message=read_vertex_query,
        bindings={
            "prop_partition_key": "gear-surf-surfboards",
            "prop_id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb"
        }
    ).one()
    

Abfragedaten

Verwenden Sie schließlich eine Abfrage, um alle Daten zu finden, die einem bestimmten Traversal oder Filter im Diagramm entsprechen.

  1. Erstellen Sie eine Abfrage, die alle Scheitelpunkte findet, die von einem bestimmten Scheitelpunkt aus durchlaufen werden.

    find_vertices_query = (
        "g.V().hasLabel('product')"
        ".has('category', prop_partition_key)"
        ".has('name', prop_name)"
        ".outE('replaces').inV()"
    )
    
  2. Führen Sie die Abfrage aus, die das Montau Turtle Surfboard Produkt angibt.

    find_results = client.submit(
        message=find_vertices_query,
        bindings={
            "prop_partition_key": "gear-surf-surfboards",
            "prop_name": "Montau Turtle Surfboard",
        },
    ).all().result()
    
  3. Durchlaufen Sie die Abfrageergebnisse.

    for result in find_results:
        # Do something here with each result
    

Ausführen des Codes

Führen Sie die neu erstellte Anwendung mit einem Terminal in Ihrem Anwendungsverzeichnis aus.

python app.py

Bereinigen von Ressourcen

Wenn Sie das Konto nicht mehr benötigen, entfernen Sie das Konto aus Ihrem Azure-Abonnement, indem Sie die Ressource löschen .

az cosmosdb delete \
    --resource-group "<resource-group-name>" \
    --name "<account-name>"