Delen via

Quickstart: Azure Cosmos DB for NoSQL gebruiken met Azure SDK voor Python

  • Artikel
  • Van toepassing op:
    ✅ NoSQL

In deze quickstart implementeert u een eenvoudige Azure Cosmos DB for Table-toepassing met behulp van de Azure SDK voor Python. Azure Cosmos DB for Table is een schemaloos gegevensarchief waarmee toepassingen gestructureerde tabelgegevens in de cloud kunnen opslaan. U leert hoe u tabellen, rijen maakt en basistaken uitvoert in uw Azure Cosmos DB-resource met behulp van de Azure SDK voor Python.

API-referentiedocumentatiebibliotheek | broncodepakket | (PyPI) | Azure Developer CLI

Vereisten

  • Azure Developer CLI
  • Docker Desktop
  • Python 3.12

Als u geen Azure-account hebt, maak dan een gratis account aan voordat u begint.

Het project initialiseren

Gebruik de Azure Developer CLI (azd) om een Azure Cosmos DB for Table-account te maken en een in een container geplaatste voorbeeldtoepassing te implementeren. De voorbeeldtoepassing maakt gebruik van de clientbibliotheek voor het beheren, maken, lezen en opvragen van voorbeeldgegevens.

  1. Open een terminal in een lege map.

  2. Als u nog niet bent geverifieerd, moet u zich verifiëren bij de Azure Developer CLI met behulp van azd auth login. Volg de stappen die door het hulpprogramma zijn opgegeven om te verifiëren bij de CLI met behulp van uw favoriete Azure-referenties.

    azd auth login

  3. Gebruik azd init dit om het project te initialiseren.

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

  4. Configureer tijdens de initialisatie een unieke omgevingsnaam.

  5. Implementeer het Azure Cosmos DB-account met behulp van azd up. De Bicep-sjablonen implementeren ook een voorbeeldwebtoepassing.

    azd up

  6. Selecteer tijdens het inrichtingsproces uw abonnement, gewenste locatie en doelresourcegroep. Wacht tot het inrichtingsproces is voltooid. Het proces kan ongeveer vijf minuten duren.

  7. Zodra het inrichten van uw Azure-resources is voltooid, wordt er een URL naar de actieve webtoepassing opgenomen in de uitvoer.

    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. Gebruik de URL in de console om naar uw webtoepassing in de browser te navigeren. Bekijk de uitvoer van de actieve app.

Schermopname van de actieve webtoepassing.

De clientbibliotheek installeren

De clientbibliotheek is beschikbaar via de Python Package Index, als bibliotheek azure-cosmos .

  1. Open een terminal en navigeer naar de /src map.

    cd ./src

  2. Als dit nog niet is geïnstalleerd, installeert u het azure-cosmos pakket met behulp van pip install.

    pip install azure-cosmos

  3. Installeer ook het azure-identity pakket als dat nog niet is geïnstalleerd.

    pip install azure-identity

  4. Open en controleer het src/requirements.txt-bestand om te controleren of de azure-cosmos en azure-identity beide vermeldingen bestaan.

Objectmodel

Name Beschrijving
CosmosClient Deze klasse is de primaire clientklasse en wordt gebruikt voor het beheren van metagegevens of databases voor het hele account.
DatabaseProxy Deze klasse vertegenwoordigt een database binnen het account.
ContainerProxy Deze klasse wordt voornamelijk gebruikt om lees-, update- en verwijderbewerkingen uit te voeren op de container of de items die zijn opgeslagen in de container.
PartitionKey Deze klasse vertegenwoordigt een logische partitiesleutel. Deze klasse is vereist voor veel algemene bewerkingen en query's.

Codevoorbeelden

De voorbeeldcode in de sjabloon maakt gebruik van een database met de naam cosmicworks en container.products De products container bevat details zoals naam, categorie, hoeveelheid, een unieke id en een verkoopvlag voor elk product. De container gebruikt de /category eigenschap als een logische partitiesleutel.

De client verifiëren

In dit voorbeeld wordt een nieuw exemplaar van het CosmosClient type gemaakt en wordt geverifieerd met behulp van een DefaultAzureCredential exemplaar.

credential = DefaultAzureCredential()

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

Een database ophalen

Gebruik client.get_database_client deze om de bestaande database met de naam cosmicworksop te halen.

database = client.get_database_client("cosmicworks")

Een container ophalen

Haal de bestaande products container op met behulp van database.get_container_client.

container = database.get_container_client("products")

Een item maken

Bouw een nieuw object met alle leden die u in JSON wilt serialiseren. In dit voorbeeld heeft het type een unieke id en velden voor categorie, naam, hoeveelheid, prijs en verkoop. Maak een item in de container met behulp van container.upsert_item. Met deze methode wordt het item effectief vervangen als het al bestaat.

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)

Een item lezen

Voer een puntleesbewerking uit met behulp van zowel de unieke id (id) als de partitiesleutelvelden. Gebruik container.read_item dit om het specifieke item efficiënt op te halen.

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

Query-items

Voer een query uit op meerdere items in een container met behulp van container.GetItemQueryIterator. Zoek alle items in een opgegeven categorie met behulp van deze geparameteriseerde query:

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

Doorloop de resultaten van de query.

items = [item for item in results]

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

Resources opschonen

Wanneer u de voorbeeldtoepassing of resources niet meer nodig hebt, verwijdert u de bijbehorende implementatie en alle resources.

azd down

Gerelateerde inhoud