Dela via

Snabbstart: Använda Azure Cosmos DB för NoSQL med Azure SDK för Python

  • Artikel
  • Gäller för:
    ✅ NoSQL

I den här snabbstarten distribuerar du ett grundläggande Azure Cosmos DB for Table-program med hjälp av Azure SDK för Python. Azure Cosmos DB for Table är ett schemalöst datalager som gör att program kan lagra strukturerade tabelldata i molnet. Du lär dig hur du skapar tabeller, rader och utför grundläggande uppgifter i din Azure Cosmos DB-resurs med hjälp av Azure SDK för Python.

API-referensdokumentation Biblioteks källkodspaket | (PyPI) | Azure Developer CLI |

Förutsättningar

  • Azure Developer CLI
  • Docker Desktop
  • Python 3.12

Om du inte har något Azure-konto skapar du ett kostnadsfritt konto innan du börjar.

Initiera projektet

Använd Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för tabellkonto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

  1. Öppna en terminal i en tom katalog.

  2. Om du inte redan är autentiserad autentiserar du till Azure Developer CLI med .azd auth login Följ stegen som anges av verktyget för att autentisera till CLI med dina önskade Azure-autentiseringsuppgifter.

    azd auth login

  3. Använd azd init för att initiera projektet.

    azd init --template cosmos-db-nosql-python-quickstart

  4. Under initieringen konfigurerar du ett unikt miljönamn.

  5. Distribuera Azure Cosmos DB-kontot med .azd up Bicep-mallarna distribuerar också ett exempelwebbprogram.

    azd up

  6. Under etableringsprocessen väljer du din prenumeration, önskad plats och målresursgrupp. Vänta tills etableringsprocessen har slutförts. Processen kan ta ungefär fem minuter.

  7. När etableringen av dina Azure-resurser är klar inkluderas en URL till det webbprogram som körs i utdata.

    Deploying services (azd deploy)

  (✓) Done: Deploying service web
- Endpoint: <https://[container-app-sub-domain].azurecontainerapps.io>

SUCCESS: Your application was provisioned and deployed to Azure in 5 minutes 0 seconds.

  8. Använd URL:en i konsolen för att navigera till webbprogrammet i webbläsaren. Observera utdata från appen som körs.

Skärmbild av webbprogrammet som körs.

Installera klientbiblioteket

Klientbiblioteket är tillgängligt via Python Package Index som azure-cosmos bibliotek.

  1. Öppna en terminal och navigera till /src mappen.

    cd ./src

  2. Om det inte redan är installerat installerar du azure-cosmos paketet med .pip install

    pip install azure-cosmos

  3. Installera även paketet om det azure-identity inte redan är installerat.

    pip install azure-identity

  4. Öppna och granska filen src/requirements.txt för att verifiera att båda posterna azure-cosmos och azure-identity finns.

Objektmodell

Name beskrivning
CosmosClient Den här klassen är den primära klientklassen och används för att hantera kontoomfattande metadata eller databaser.
DatabaseProxy Den här klassen representerar en databas i kontot.
ContainerProxy Den här klassen används främst för att utföra läs-, uppdaterings- och borttagningsåtgärder på antingen containern eller objekten som lagras i containern.
PartitionKey Den här klassen representerar en logisk partitionsnyckel. Den här klassen krävs för många vanliga åtgärder och frågor.

Kodexempel

Exempelkoden i mallen använder en databas med namnet cosmicworks och containern med namnet products. Containern products innehåller information som namn, kategori, kvantitet, en unik identifierare och en försäljningsflagga för varje produkt. Containern använder egenskapen /category som en logisk partitionsnyckel.

Autentisera klienten

Det här exemplet skapar en ny instans av typen och autentiserar CosmosClient med hjälp av en DefaultAzureCredential instans.

credential = DefaultAzureCredential()

client = CosmosClient(url="<azure-cosmos-db-nosql-account-endpoint>", credential=credential)

Hämta en databas

Använd client.get_database_client för att hämta den befintliga databasen med namnet cosmicworks.

database = client.get_database_client("cosmicworks")

Hämta en container

Hämta den befintliga products containern med .database.get_container_client

container = database.get_container_client("products")

Skapa ett objekt

Skapa ett nytt objekt med alla medlemmar som du vill serialisera till JSON. I det här exemplet har typen en unik identifierare och fält för kategori, namn, kvantitet, pris och försäljning. Skapa ett objekt i containern med .container.upsert_item Den här metoden "upserts" objektet ersätter objektet effektivt om det redan finns.

new_item = {
    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "sale": False,
}

created_item = container.upsert_item(new_item)

Läsa ett objekt

Utför en punktläsningsåtgärd med hjälp av både de unika identifierarna (id) och partitionsnyckelfälten. Använd container.read_item för att effektivt hämta det specifika objektet.

existing_item = container.read_item(
    item="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

Frågeobjekt

Utför en fråga över flera objekt i en container med hjälp av container.GetItemQueryIterator. Hitta alla objekt i en angiven kategori med den här parameteriserade frågan:

SELECT * FROM products p WHERE p.category = @category

queryText = "SELECT * FROM products p WHERE p.category = @category"

results = container.query_items(
    query=queryText,
    parameters=[
        dict(
            name="@category",
            value="gear-surf-surfboards",
        )
    ],
    enable_cross_partition_query=False,
)

Loopa igenom resultatet av frågan.

items = [item for item in results]

output = json.dumps(items, indent=True)

Utforska dina data

Använd Visual Studio Code-tillägget för Azure Cosmos DB för att utforska dina NoSQL-data. Du kan utföra grundläggande databasåtgärder, inklusive, men inte begränsat till:

  • Köra frågor med hjälp av en klippbok eller frågeredigeraren
  • Ändra, uppdatera, skapa och ta bort objekt
  • Importera massdata från andra källor
  • Hantera databaser och containrar

Mer information finns i Använda Visual Studio Code-tillägget för att utforska Azure Cosmos DB för NoSQL-data.

Rensa resurser

När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.

azd down

Relaterat innehåll