Snabbstart: Använda Azure Cosmos DB for Table med Azure SDK för Python
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.
Öppna en terminal i en tom katalog.
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
Använd
azd init
för att initiera projektet.azd init --template cosmos-db-table-python-quickstart
Under initieringen konfigurerar du ett unikt miljönamn.
Distribuera Azure Cosmos DB-kontot med .
azd up
Bicep-mallarna distribuerar också ett exempelwebbprogram.azd up
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.
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 PyPi som azure-data-tables
paket.
Öppna en terminal och navigera till
/src
mappen.cd ./src
Om det inte redan är installerat installerar du
azure-data-tables
paketet med .pip install
pip install azure-data-tables
Öppna och granska filen src/requirements.txt för att verifiera att posten
azure-data-tables
finns.
Objektmodell
Name | beskrivning |
---|---|
TableServiceClient |
Den här typen är den primära klienttypen och används för att hantera kontoomfattande metadata eller databaser. |
TableClient |
Den här typen representerar klienten för en tabell i kontot. |
Kodexempel
Exempelkoden i mallen använder en tabell med namnet cosmicworks-products
. Tabellen cosmicworks-products
innehåller information som namn, kategori, kvantitet, pris, en unik identifierare och en försäljningsflagga för varje produkt. Containern använder en unik identifierare som radnyckel och kategori som partitionsnyckel.
Autentisera klienten
Det här exemplet skapar en ny instans av TableServiceClient
typen.
credential = DefaultAzureCredential()
client = TableServiceClient(endpoint="<azure-cosmos-db-table-account-endpoint>", credential=credential)
Hämta en tabell
Det här exemplet skapar en instans av TableClient
typen med hjälp GetTableClient
av funktionen av typen TableServiceClient
.
table = client.get_table_client("<azure-cosmos-db-table-name>")
Skapa en entitet
Det enklaste sättet att skapa en ny entitet i en tabell är att skapa ett nytt objekt som säkerställer att du anger obligatoriska RowKey
egenskaper och PartitionKey
egenskaper.
new_entity = {
"RowKey": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
"PartitionKey": "gear-surf-surfboards",
"Name": "Yamba Surfboard",
"Quantity": 12,
"Sale": False,
}
Skapa en entitet i tabellen med .upsert_entity
created_entity = table.upsert_entity(new_entity)
Hämta en entitet
Du kan hämta en specifik entitet från en tabell med hjälp av get_entity
.
existing_entity = table.get_entity(
row_key="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
partition_key="gear-surf-surfboards",
)
Fråga entiteter
När du har infogat en entitet kan du också köra en fråga för att hämta alla entiteter som matchar ett visst filter med hjälp query_entities
av ett OData-strängfilter.
category = "gear-surf-surfboards"
filter = f"PartitionKey eq '{category}'"
entities = table.query_entities(query_filter=filter)
Parsa de sidnumrerade resultaten av frågan med hjälp av en for
loop.
for entity in entities:
# Do something
Rensa resurser
När du inte längre behöver exempelprogrammet eller resurserna tar du bort motsvarande distribution och alla resurser.
azd down