Udostępnij przez

Szybki start: używanie usługi Azure Cosmos DB for NoSQL z zestawem Azure SDK dla języka Python

  • Dotyczy: ✅ NoSQL

W tym przewodniku szybkiego startu wdrożysz podstawową aplikację dla Azure Cosmos DB dla NoSQL przy użyciu Azure SDK dla Pythona. Usługa Azure Cosmos DB for NoSQL to bez schematu magazyn danych, który umożliwia aplikacjom przechowywanie danych bez struktury w chmurze. Wykonywanie zapytań dotyczących danych w kontenerach i wykonywanie typowych operacji na poszczególnych elementach przy użyciu zestawu Azure SDK dla języka Python.

** Dokumentacja referencyjna interfejsu API | Kod źródłowy biblioteki | Pakiet (PyPI) | Azure Developer CLI

Wymagania wstępne

  • Azure Developer CLI
  • Docker Desktop
  • Python 3.12

Jeśli nie masz jeszcze konta platformy Azure, przed rozpoczęciem utwórz bezpłatne konto.

Inicjowanie projektu

Użyj interfejsu wiersza polecenia dla deweloperów platformy Azure (azd), aby utworzyć konto usługi Azure Cosmos DB for NoSQL i wdrożyć konteneryzowaną przykładową aplikację. Przykładowa aplikacja używa biblioteki klienta do zarządzania, tworzenia, odczytywania i wykonywania zapytań dotyczących przykładowych danych.

  1. Otwórz terminal w pustym katalogu.

  2. Jeśli jeszcze nie jesteś uwierzytelniony, uwierzytelnij się za pomocą Azure Developer CLI przy użyciu polecenia azd auth login. Wykonaj kroki określone przez narzędzie, aby uwierzytelnić się w interfejsie wiersza polecenia przy użyciu preferowanych poświadczeń platformy Azure.

    azd auth login

  3. Użyj azd init do zainicjowania projektu.

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

  4. Podczas inicjowania skonfiguruj unikatową nazwę środowiska.

  5. Wdróż konto usługi Azure Cosmos DB przy użyciu polecenia azd up. Szablony Bicep wdrażają również przykładową aplikację internetową.

    azd up

  6. Podczas procesu aprowizacji wybierz subskrypcję, żądaną lokalizację i docelową grupę zasobów. Poczekaj na zakończenie procesu konfiguracji. Proces może potrwać około pięciu minut.

  7. Po zakończeniu aprowizacji zasobów platformy Azure adres URL uruchomionej aplikacji internetowej zostanie uwzględniony w danych wyjściowych.

    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. Użyj adresu URL w konsoli, aby przejść do aplikacji internetowej w przeglądarce. Obserwuj dane wyjściowe uruchomionej aplikacji.

Zrzut ekranu przedstawiający uruchomioną aplikację internetową.

Instalowanie biblioteki klienta

Biblioteka klienta jest dostępna za pośrednictwem indeksu pakietów języka Python jako biblioteki azure-cosmos .

  1. Otwórz terminal i przejdź do /src folderu.

    cd ./src

  2. Jeśli pakiet nie został jeszcze zainstalowany, zainstaluj azure-cosmos przy użyciu polecenia pip install.

    pip install azure-cosmos

  3. Ponadto zainstaluj azure-identity pakiet, jeśli nie został jeszcze zainstalowany.

    pip install azure-identity

  4. Otwórz i przejrzyj plik src/requirements.txt , aby sprawdzić, czy azure-cosmosazure-identity oba wpisy istnieją.

Importowanie bibliotek

Zaimportuj typy DefaultAzureCredential i CosmosClient do kodu aplikacji.

from azure.identity import DefaultAzureCredential
from azure.cosmos import CosmosClient

Model obiektów

Name Description
CosmosClient Ta klasa jest podstawową klasą klienta i służy do zarządzania metadanymi lub bazami danych dla całego konta.
DatabaseProxy Ta klasa reprezentuje bazę danych w ramach konta.
ContainerProxy Ta klasa jest używana głównie do wykonywania operacji odczytu, aktualizacji i usuwania w kontenerze lub elementach przechowywanych w kontenerze.
PartitionKey Ta klasa reprezentuje klucz partycji logicznej. Ta klasa jest wymagana w przypadku wielu typowych operacji i zapytań.

Przykłady kodu

Przykładowy kod w szablonie używa bazy danych o nazwie cosmicworks oraz kontenera o nazwie products. Kontener products zawiera szczegóły, takie jak nazwa, kategoria, ilość, unikatowy identyfikator i flaga sprzedaży dla każdego produktu. Kontener używa właściwości /category jako logicznego klucza partycji.

Uwierzytelnianie klienta

Ten przykład tworzy nowe wystąpienie typu CosmosClient i uwierzytelnia za pomocą wystąpienia DefaultAzureCredential.

credential = DefaultAzureCredential()

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

Pobieranie bazy danych

Użyj client.get_database_client polecenia , aby pobrać istniejącą bazę danych o nazwie cosmicworks.

database = client.get_database_client("cosmicworks")

Zdobądź kontener

Pobierz istniejący products kontener przy użyciu polecenia database.get_container_client.

container = database.get_container_client("products")

Tworzenie elementu

Skompiluj nowy obiekt ze wszystkimi elementami członkowskimi, które chcesz serializować w formacie JSON. W tym przykładzie typ ma unikatowy identyfikator i pola dla kategorii, nazwy, ilości, ceny i sprzedaży. Utwórz element w kontenerze przy użyciu polecenia container.upsert_item. Ta metoda dodaje lub aktualizuje przedmiot, skutecznie zastępując go, jeśli już istnieje.

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)

Przeczytaj element

Wykonaj operację odczytu punktowego, korzystając jednocześnie z pól unikatowego identyfikatora (id) oraz klucza partycji. Użyj container.read_item do wydajnego pobrania konkretnego elementu.

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

Elementy zapytania

Wykonaj zapytanie dotyczące wielu elementów w kontenerze przy użyciu polecenia container.GetItemQueryIterator. Znajdź wszystkie elementy w określonej kategorii przy użyciu tego sparametryzowanego zapytania:

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

Iteruj przez wyniki zapytania.

items = [item for item in results]

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

Eksplorowanie danych

Użyj rozszerzenia programu Visual Studio Code dla usługi Azure Cosmos DB, aby eksplorować dane NoSQL. Możesz wykonywać podstawowe operacje na bazie danych, w tym między innymi:

  • Wykonywanie zapytań przy użyciu albumu lub edytora zapytań
  • Modyfikowanie, aktualizowanie, tworzenie i usuwanie elementów
  • Importowanie danych zbiorczych z innych źródeł
  • Zarządzanie bazami danych i kontenerami

Aby uzyskać więcej informacji, zobacz How-to use Visual Studio Code extension to explore Azure Cosmos DB for NoSQL data (Jak używać rozszerzenia programu Visual Studio Code do eksplorowania danych usługi Azure Cosmos DB for NoSQL).

Uprzątnij zasoby

Jeśli nie potrzebujesz już przykładowej aplikacji lub zasobów, usuń odpowiednie wdrożenie i wszystkie zasoby.

azd down

Treści powiązane

  • Last updated on