Quickstart: Azure Cosmos DB for NoSQL-bibliotheek voor Python

Artikel
01/10/2024

VAN TOEPASSING OP: NoSQL

Ga aan de slag met de Azure Cosmos DB for NoSQL-clientbibliotheek voor Python om gegevens in uw containers op te vragen en algemene bewerkingen uit te voeren op afzonderlijke items. Volg deze stappen om een minimale oplossing in uw omgeving te implementeren met behulp van de Azure Developer CLI.

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

Vereisten

Een Azure-account met een actief abonnement. Gratis een account maken
Een GitHub-account

Een Azure-account met een actief abonnement. Gratis een account maken
Azure Developer CLI
Docker Desktop

Instellen

Implementeer de ontwikkelcontainer van dit project in uw omgeving. Gebruik vervolgens de Azure Developer CLI (azd) om een Azure Cosmos DB for NoSQL-account te maken en een containervoorbeeldtoepassing te implementeren. De voorbeeldtoepassing maakt gebruik van de clientbibliotheek voor het beheren, maken, lezen en opvragen van voorbeeldgegevens.

Belangrijk

GitHub-accounts bevatten gratis rechten voor opslag en kernuren. Zie inbegrepen opslag- en kernuren voor GitHub-accounts voor meer informatie.

Open een terminal in de hoofdmap van het project.
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
```
Gebruik azd init dit om het project te initialiseren.
```
azd init
```
Configureer tijdens de initialisatie een unieke omgevingsnaam.

Tip

De omgevingsnaam wordt ook gebruikt als de naam van de doelresourcegroep. Voor deze quickstart kunt u overwegen .msdocs-cosmos-db-
Implementeer het Azure Cosmos DB-account met behulp van azd up. De Bicep-sjablonen implementeren ook een voorbeeldwebtoepassing.
```
azd up
```
Selecteer tijdens het inrichtingsproces uw abonnement en gewenste locatie. Wacht tot het inrichtingsproces is voltooid. Het proces kan ongeveer vijf minuten duren.

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.

Gebruik de URL in de console om naar uw webtoepassing in de browser te navigeren. Bekijk de uitvoer van de actieve app.

De clientbibliotheek installeren

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

Open een terminal en navigeer naar de /src map.
```
cd ./src
```
Als dit nog niet is geïnstalleerd, installeert u het azure-cosmos pakket met behulp van pip install.
```
pip install azure-cosmos
```
Installeer ook het azure-identity pakket als dat nog niet is geïnstalleerd.
```
pip install azure-identity
```
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.

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

Toepassingsaanvragen voor de meeste Azure-services moeten worden geautoriseerd. Gebruik het DefaultAzureCredential type als voorkeursmethode om een wachtwoordloze verbinding tussen uw toepassingen en Azure Cosmos DB for NoSQL te implementeren. DefaultAzureCredential ondersteunt meerdere verificatiemethoden en bepaalt welke methode tijdens runtime moet worden gebruikt.

Belangrijk

U kunt aanvragen voor Azure-services ook rechtstreeks autoriseren met behulp van wachtwoorden, verbindingsreeks s of andere referenties. Deze aanpak moet echter met voorzichtigheid worden gebruikt. Ontwikkelaars moeten ijverig zijn om deze geheimen nooit zichtbaar te maken op een onbeveiligde locatie. Iedereen die toegang krijgt tot het wachtwoord of de geheime sleutel, kan zich verifiëren bij de databaseservice. DefaultAzureCredential biedt verbeterde beheer- en beveiligingsvoordelen ten opzichte van de accountsleutel om verificatie zonder wachtwoord mogelijk te maken zonder het risico dat sleutels worden opgeslagen.

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=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": "70b63682-b93a-4c77-aad2-65501347265f",
    "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="70b63682-b93a-4c77-aad2-65501347265f",
    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)

Volgende stap

PyPI-pakket