Guida introduttiva: Usare Azure Cosmos DB per tabelle con Azure SDK per Python

  • Articolo
  • Si applica a:
    ✅ Table

In questa guida introduttiva si distribuisce un'applicazione Azure Cosmos DB per tabelle di base usando Azure SDK per Python. Azure Cosmos DB per tabella è un archivio dati senza schema che consente alle applicazioni di archiviare dati strutturati della tabella nel cloud. Si apprenderà come creare tabelle, righe ed eseguire attività di base all'interno della risorsa di Azure Cosmos DB usando Azure SDK per Python.

Documentazione di riferimento dell'API | Codice sorgente della libreria | Pacchetto (PyPI) | Azure Developer CLI

Prerequisiti

  • Azure Developer CLI
  • Docker Desktop
  • Python 3.12

Se non si ha un account Azure, creare un account gratuito prima di iniziare.

Inizializzare il progetto

Usare l'interfaccia della riga di comando per sviluppatori di Azure (azd) per creare un account Azure Cosmos DB per tabelle e distribuire un'applicazione di esempio in contenitori. L'applicazione di esempio usa la libreria client per gestire, creare, leggere ed eseguire query sui dati di esempio.

  1. Aprire un terminale in una directory vuota.

  2. Se non si è già autenticati, eseguire l'autenticazione all'interfaccia della riga di comando per sviluppatori di Azure usando azd auth login. Seguire i passaggi specificati dallo strumento per eseguire l'autenticazione all'interfaccia della riga di comando usando le credenziali di Azure preferite.

    azd auth login

  3. Usare azd init per inizializzare il progetto.

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

  4. Durante l'inizializzazione, configurare un nome di ambiente univoco.

  5. Distribuire l'account Azure Cosmos DB usando azd up. I modelli Bicep distribuiscono anche un'applicazione Web di esempio.

    azd up

  6. Durante il processo di provisioning selezionare la sottoscrizione, la località desiderata e il gruppo di risorse di destinazione. Attendere il completamento del processo di provisioning. Per il processo sono necessari circa 5 minuti.

  7. Al termine del provisioning delle risorse di Azure, nell'output viene incluso un URL dell'applicazione Web in esecuzione.

    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. Usare l'URL nella console per passare all'applicazione Web nel browser. Osservare l'output dell'app in esecuzione.

Screenshot dell'applicazione Web in esecuzione.

Installare la libreria client

La libreria client è disponibile tramite PyPi, come azure-data-tables pacchetto.

  1. Aprire un terminale e passare alla cartella /src.

    cd ./src

  2. Se non è già installato, installare il pacchetto azure-data-tables usando pip install.

    pip install azure-data-tables

  3. Aprire ed esaminare il file src/requirements.txt per verificare che la azure-data-tables voce esista.

Modello a oggetti

Nome Descrizione
TableServiceClient Questo tipo è il tipo di client primario e viene usato per gestire i metadati o i database a livello di account.
TableClient Questo tipo rappresenta il client per una tabella all'interno dell'account.

Esempi di codice

Il codice di esempio nel modello usa una tabella denominata cosmicworks-products. La cosmicworks-products tabella contiene dettagli quali nome, categoria, quantità, prezzo, identificatore univoco e flag di vendita per ogni prodotto. Il contenitore usa un identificatore univoco come chiave di riga e categoria come chiave di partizione.

Autenticare il client

In questo esempio viene creata una nuova istanza del TableServiceClient tipo .

credential = DefaultAzureCredential()

client = TableServiceClient(endpoint="<azure-cosmos-db-table-account-endpoint>", credential=credential)

Ottenere una tabella

In questo esempio viene creata un'istanza del TableClient tipo usando la GetTableClient funzione del TableServiceClient tipo .

table = client.get_table_client("<azure-cosmos-db-table-name>")

Creare un'entità

Il modo più semplice per creare una nuova entità in una tabella consiste nel creare un nuovo oggetto assicurandosi di specificare le proprietà e PartitionKey obbligatorieRowKey.

new_entity = {
    "RowKey": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "PartitionKey": "gear-surf-surfboards",
    "Name": "Yamba Surfboard",
    "Quantity": 12,
    "Sale": False,
}

Creare un'entità nella tabella usando upsert_entity.

created_entity = table.upsert_entity(new_entity)

Ottenere un'entità

È possibile recuperare un'entità specifica da una tabella usando get_entity.

existing_entity = table.get_entity(
    row_key="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

Eseguire query sulle entità

Dopo aver inserito un'entità, è anche possibile eseguire una query per ottenere tutte le entità che corrispondono a un filtro specifico usando query_entities con un filtro OData stringa.

category = "gear-surf-surfboards"
filter = f"PartitionKey eq '{category}'"
entities = table.query_entities(query_filter=filter)

Analizzare i risultati impaginati della query usando un for ciclo.

for entity in entities:
    # Do something

Pulire le risorse

Quando l'applicazione o le risorse di esempio non sono più necessarie, rimuovere la distribuzione corrispondente e tutte le risorse.

azd down

Contenuto correlato