Snabbstart: Azure Cosmos DB för Apache Gremlin-klientbiblioteket för Python

Kom igång med Azure Cosmos DB för Apache Gremlin-klientbiblioteket för Python för att lagra, hantera och fråga ostrukturerade data. Följ stegen i den här guiden för att skapa ett nytt konto, installera ett Python-klientbibliotek, ansluta till kontot, utföra vanliga åtgärder och köra frågor mot dina slutliga exempeldata.

Paket för bibliotekskällkod | (PyPi)

Förutsättningar

• En prenumeration på Azure

  • Om du inte har en Azure-prenumeration, skapa ett gratis konto innan du börjar.

• Den senaste versionen av Azure CLI i Azure Cloud Shell.

  • Om du föredrar att köra CLI-referenskommandon lokalt loggar du in på Azure CLI med hjälp az login av kommandot .

• Python 3.12 eller senare

Konfigurera

Konfigurera först konto- och utvecklingsmiljön för den här guiden. Det här avsnittet beskriver hur du skapar ett konto, hämtar dess autentiseringsuppgifter och sedan förbereder utvecklingsmiljön.

Skapa ett konto

Börja med att skapa ett API för Apache Gremlin-konto. När kontot har skapats skapar du databas- och grafresurserna.

Hämta autentiseringsuppgifter

Hämta nu lösenordet för klientbiblioteket som ska användas för att skapa en anslutning till det nyligen skapade kontot.

Förbereda utvecklingsmiljön

Konfigurera sedan utvecklingsmiljön med ett nytt projekt och klientbiblioteket. Det här steget är det sista nödvändiga kravet innan du går vidare till resten av den här guiden.

1. Starta i en tom mapp.

2. gremlinpython Importera paketet från Python Package Index (PyPI).

   pip install gremlinpython
   

3. Skapa filen app.py .

Objektmodell

Kodexempel

• Autentisera klient
• Lägg till data
• Läsa data
• Fråga efter data

Autentisera klient

Börja med att autentisera klienten med de autentiseringsuppgifter som samlats in tidigare i den här guiden.

1. Öppna filen app.py i din integrerade utvecklingsmiljö (IDE).

2. Importera följande typer från gremlin_python.driver biblioteket:

   • gremlin_python.driver.client
   • gremlin_python.driver.serializer

   from gremlin_python.driver import client, serializer
   

3. Skapa strängvariabler för de autentiseringsuppgifter som samlats in tidigare i den här guiden. Namnge variablerna hostname och primary_key.

   hostname = "<host>"
   primary_key = "<key>"
   

4. Skapa ett Client objekt med hjälp av de autentiseringsuppgifter och konfigurationsvariabler som skapades i föregående steg. Namnge variabeln 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()
   )
   

Infoga data

Infoga sedan nya hörn- och kantdata i diagrammet. Innan du skapar nya data rensar du grafen över befintliga data.

1. Kör frågan g.V().drop() för att rensa alla hörn och kanter från diagrammet.

   client.submit("g.V().drop()").all().result()
   

2. Skapa en Gremlin-fråga som lägger till en nod.

   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. Lägg till en nod för en enskild produkt.

   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. Lägg till ytterligare två hörn för två extra produkter.

   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. Skapa en annan Gremlin-fråga som lägger till en kant.

   insert_edge_query = (
       "g.V([prop_partition_key, prop_source_id])"
       ".addE('replaces')"
       ".to(g.V([prop_partition_key, prop_target_id]))"
   )
   

6. Lägg till två kanter.

   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()
   

Läs data

Läs sedan data som tidigare infogats i diagrammet.

1. Skapa en fråga som läser en nod med hjälp av det unika identifierar- och partitionsnyckelvärdet.

   read_vertex_query = "g.V([prop_partition_key, prop_id])"
   

2. Läs sedan en nod genom att ange de obligatoriska parametrarna.

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

Fråga efter data

Slutligen använder du en fråga för att hitta alla data som matchar en specifik bläddering eller filter i diagrammet.

1. Skapa en fråga som hittar alla hörn som passerar ut från ett specifikt hörn.

   find_vertices_query = (
       "g.V().hasLabel('product')"
       ".has('category', prop_partition_key)"
       ".has('name', prop_name)"
       ".outE('replaces').inV()"
   )
   

2. Kör frågan med specifikationen av Montau Turtle Surfboard-produkten.

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

3. Iterera över frågeresultatet.

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

Kör koden

Kör det nyligen skapade programmet med hjälp av en terminal i programkatalogen.

python app.py

Rensa resurser

När du inte längre behöver kontot tar du bort kontot från din Azure-prenumeration genom att ta bort resursen.

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