Sdílet prostřednictvím

Rychlý start: Použití služby Azure Cosmos DB for NoSQL se sadou Azure SDK pro Python

  • Článek
  • Platí pro:
    ✅ NoSQL

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.

  1. Otevřete terminál v prázdném adresáři.

  2. 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

  3. Slouží azd init k inicializaci projektu.

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

  4. Během inicializace nakonfigurujte jedinečný název prostředí.

  5. Nasaďte účet služby Azure Cosmos DB pomocí azd up. Šablony Bicep také nasazují ukázkovou webovou aplikaci.

    azd up

  6. 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.

  7. 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.

  8. Pomocí adresy URL v konzole přejděte do webové aplikace v prohlížeči. Sledujte výstup spuštěné aplikace.

Snímek obrazovky se spuštěnou webovou aplikací

Instalace klientské knihovny

Klientská knihovna je k dispozici prostřednictvím indexu balíčků Pythonu azure-cosmos jako knihovna.

  1. Otevřete terminál a přejděte do /src složky.

    cd ./src

  2. Pokud ještě není nainstalovaný, nainstalujte azure-cosmos balíček pomocí pip install.

    pip install azure-cosmos

  3. Pokud ještě není nainstalovaný, nainstalujte azure-identity balíček.

    pip install azure-identity

  4. Otevřete a zkontrolujte soubor src/requirements.txt a ověřte, že azure-cosmos azure-identity obě položky existují.

Objektový model

Název Popis
CosmosClient Tato třída je primární klientskou třídou a slouží ke správě metadat nebo databází pro celý účet.
DatabaseProxy Tato třída představuje databázi v rámci účtu.
ContainerProxy Tato třída se primárně používá k provádění operací čtení, aktualizace a odstraňování v kontejneru nebo v položkách uložených v kontejneru.
PartitionKey Tato třída představuje klíč logického oddílu. Tato třída se vyžaduje pro mnoho běžných operací a dotazů.

Příklady kódu

Vzorový kód v šabloně používá databázi pojmenovanou cosmicworks a kontejner s názvem products. Kontejner products obsahuje podrobnosti, jako je název, kategorie, množství, jedinečný identifikátor a příznak prodeje pro každý produkt. Kontejner používá /category vlastnost jako klíč logického oddílu.

Ověření klienta

Tato ukázka vytvoří novou instanci CosmosClient typu a ověří se pomocí DefaultAzureCredential instance.

credential = DefaultAzureCredential()

client = CosmosClient(url="<azure-cosmos-db-nosql-account-endpoint>", credential=credential)

Získání databáze

Slouží client.get_database_client k načtení existující databáze s názvem cosmicworks.

database = client.get_database_client("cosmicworks")

Získání kontejneru

Načtení existujícího products kontejneru pomocí database.get_container_client.

container = database.get_container_client("products")

Vytvoření položky

Sestavte nový objekt se všemi členy, které chcete serializovat do formátu JSON. V tomto příkladu má typ jedinečný identifikátor a pole pro kategorii, název, množství, cenu a prodej. Vytvoření položky v kontejneru pomocí container.upsert_item. Tato metoda "upserts" položku účinně nahradí položku, pokud již existuje.

new_item = {
    "id": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "category": "gear-surf-surfboards",
    "name": "Yamba Surfboard",
    "quantity": 12,
    "sale": False,
}

created_item = container.upsert_item(new_item)

Čtení položky

Proveďte operaci čtení bodu pomocí polí jedinečného identifikátoru (id) i klíče oddílu. Slouží container.read_item k efektivnímu načtení konkrétní položky.

existing_item = container.read_item(
    item="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

Dotazování položek

Proveďte dotaz na více položek v kontejneru pomocí container.GetItemQueryIterator. Pomocí tohoto parametrizovaného dotazu vyhledejte všechny položky v zadané kategorii:

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,
)

Projděte výsledky dotazu.

items = [item for item in results]

output = json.dumps(items, indent=True)

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

Související obsah