Rychlý start: Použití služby Azure Cosmos DB pro tabulky se sadou Azure SDK pro Python
V tomto rychlém startu nasadíte základní aplikaci Azure Cosmos DB for Table pomocí sady Azure SDK pro Python. Azure Cosmos DB for Table je úložiště dat bez schématu, které umožňuje aplikacím ukládat strukturovaná data tabulek v cloudu. Naučíte se vytvářet tabulky, řádky a provádět základní úlohy v rámci prostředku služby Azure Cosmos DB pomocí sady Azure SDK pro Python.
Referenční dokumentace k | rozhraní API – Balíček zdrojového kódu | knihovny (PyPI) | Azure Developer CLI
Požadavky
- Azure Developer CLI
- Docker Desktop
- Python 3.12
Pokud nemáte účet Azure, vytvořte si bezplatný účet před tím, než začnete.
Inicializace projektu
Pomocí Azure Developer CLI (azd
) vytvořte účet Azure Cosmos DB for Table a nasaďte kontejnerizovanou ukázkovou aplikaci. Ukázková aplikace používá klientskou knihovnu ke správě, vytváření, čtení a dotazování ukázkových dat.
Otevřete terminál v prázdném adresáři.
Pokud ještě nejste ověřeni, ověřte se v Azure Developer CLI pomocí
azd auth login
. Postupujte podle kroků určených nástrojem k ověření v rozhraní příkazového řádku pomocí vašich upřednostňovaných přihlašovacích údajů Azure.azd auth login
Slouží
azd init
k inicializaci projektu.azd init --template cosmos-db-table-python-quickstart
Během inicializace nakonfigurujte jedinečný název prostředí.
Nasaďte účet služby Azure Cosmos DB pomocí
azd up
. Šablony Bicep také nasazují ukázkovou webovou aplikaci.azd up
Během procesu zřizování vyberte své předplatné, požadované umístění a cílovou skupinu prostředků. Počkejte na dokončení procesu zřizování. Proces může trvat přibližně pět minut.
Po dokončení zřizování prostředků Azure se do výstupu zahrne adresa URL spuštěné webové aplikace.
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.
Pomocí adresy URL v konzole přejděte do webové aplikace v prohlížeči. Sledujte výstup spuštěné aplikace.
Instalace klientské knihovny
Klientská knihovna je k dispozici prostřednictvím PyPi jako azure-data-tables
balíček.
Otevřete terminál a přejděte do
/src
složky.cd ./src
Pokud ještě není nainstalovaný, nainstalujte
azure-data-tables
balíček pomocípip install
.pip install azure-data-tables
Otevřete a zkontrolujte soubor src/requirements.txt a ověřte, že
azure-data-tables
položka existuje.
Objektový model
Název | Popis |
---|---|
TableServiceClient |
Tento typ je primárním typem klienta a slouží ke správě metadat nebo databází pro celý účet. |
TableClient |
Tento typ představuje klienta pro tabulku v rámci účtu. |
Příklady kódu
Vzorový kód v šabloně používá tabulku s názvem cosmicworks-products
. Tabulka cosmicworks-products
obsahuje podrobnosti, jako je název, kategorie, množství, cena, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá jedinečný identifikátor jako klíč řádku a kategorii jako klíč oddílu.
Ověření klienta
Tato ukázka vytvoří novou instanci TableServiceClient
typu.
credential = DefaultAzureCredential()
client = TableServiceClient(endpoint="<azure-cosmos-db-table-account-endpoint>", credential=credential)
Získání tabulky
Tato ukázka vytvoří instanci TableClient
typu pomocí GetTableClient
funkce TableServiceClient
typu.
table = client.get_table_client("<azure-cosmos-db-table-name>")
Vytvoření entity
Nejjednodušší způsob, jak vytvořit novou entitu v tabulce, je vytvořit nový objekt, který zajistí, že zadáte povinné RowKey
a PartitionKey
vlastnosti.
new_entity = {
"RowKey": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
"PartitionKey": "gear-surf-surfboards",
"Name": "Yamba Surfboard",
"Quantity": 12,
"Sale": False,
}
Vytvoření entity v tabulce pomocí upsert_entity
.
created_entity = table.upsert_entity(new_entity)
Získání entity
Konkrétní entitu můžete z tabulky načíst pomocí get_entity
.
existing_entity = table.get_entity(
row_key="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
partition_key="gear-surf-surfboards",
)
Dotazování entit
Po vložení entity můžete také spustit dotaz, abyste získali všechny entity, které odpovídají určitému filtru, pomocí query_entities
řetězce filtru OData.
category = "gear-surf-surfboards"
filter = f"PartitionKey eq '{category}'"
entities = table.query_entities(query_filter=filter)
Parsujte stránkované výsledky dotazu pomocí smyčky for
.
for entity in entities:
# Do something
Vyčištění prostředků
Pokud už ukázkovou aplikaci nebo prostředky nepotřebujete, odeberte odpovídající nasazení a všechny prostředky.
azd down