Snabbstart: Azure Cosmos DB för NoSQL-bibliotek för Python

Artikel
01/10/2024

GÄLLER FÖR: NoSQL

Kom igång med Azure Cosmos DB for NoSQL-klientbiblioteket för Python för att fråga efter data i dina containrar och utföra vanliga åtgärder på enskilda objekt. Följ de här stegen för att distribuera en minimal lösning till din miljö med hjälp av Azure Developer CLI.

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

Förutsättningar

Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
GitHub-konto

Ett Azure-konto med en aktiv prenumeration. Skapa ett konto utan kostnad.
Azure Developer CLI
Docker Desktop

Konfigurera

Distribuera projektets utvecklingscontainer till din miljö. Använd sedan Azure Developer CLI (azd) för att skapa ett Azure Cosmos DB för NoSQL-konto och distribuera ett containerbaserat exempelprogram. Exempelprogrammet använder klientbiblioteket för att hantera, skapa, läsa och fråga efter exempeldata.

Viktigt!

GitHub-konton innehåller en berättigande till lagring och kärntimmar utan kostnad. Mer information finns i inkluderade lagrings- och kärntimmar för GitHub-konton.

Öppna en terminal i projektets rotkatalog.
Autentisera 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
```
Använd azd init för att initiera projektet.
```
azd init
```
Under initieringen konfigurerar du ett unikt miljönamn.

Dricks

Miljönamnet används också som målresursgruppnamn. För den här snabbstarten bör du överväga att använda msdocs-cosmos-db-.
Distribuera Azure Cosmos DB-kontot med .azd up Bicep-mallarna distribuerar också ett exempelwebbprogram.
```
azd up
```
Under etableringsprocessen väljer du din prenumeration och önskad plats. Vänta tills etableringsprocessen har slutförts. Processen kan ta ungefär fem minuter.

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.

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

Installera klientbiblioteket

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

Öppna en terminal och navigera till /src mappen.
```
cd ./src
```
Om det inte redan är installerat installerar du azure-cosmos paketet med .pip install
```
pip install azure-cosmos
```
Installera även paketet om det azure-identity inte redan är installerat.
```
pip install azure-identity
```
Ö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.

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

Programbegäranden till de flesta Azure-tjänster måste auktoriseras. Använd typen DefaultAzureCredential som det bästa sättet att implementera en lösenordslös anslutning mellan dina program och Azure Cosmos DB för NoSQL. DefaultAzureCredential stöder flera autentiseringsmetoder och avgör vilken metod som ska användas vid körning.

Viktigt!

Du kan också auktorisera begäranden till Azure-tjänster med hjälp av lösenord, anslutningssträng eller andra autentiseringsuppgifter direkt. Den här metoden bör dock användas med försiktighet. Utvecklare måste vara noggranna för att aldrig exponera dessa hemligheter på en osäker plats. Alla som får åtkomst till lösenordet eller den hemliga nyckeln kan autentisera till databastjänsten. DefaultAzureCredential ger bättre hanterings- och säkerhetsfördelar jämfört med kontonyckeln för att tillåta lösenordslös autentisering utan risk för lagring av nycklar.

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

Gå vidare

PyPI-paket