Compartilhar via

Início Rápido: Como usar o Azure Cosmos DB for NoSQL com o SDK do Azure para Python

  • Artigo
  • Aplica-se a:
    ✅ NoSQL

Neste início rápido, você implantará um aplicativo básico do Azure Cosmos DB for Table usando o SDK do Azure para Python. O Azure Cosmos DB for Table é um armazenamento de dados sem esquema que permite que aplicativos armazenem dados de tabela estruturados na nuvem. Você aprenderá a criar tabelas, linhas e executar tarefas básicas no recurso do Azure Cosmos DB usando o SDK do Azure para Python.

Documentação de referência da API | Código-fonte da biblioteca | Pacote (PyPI) | Azure Developer CLI

Pré-requisitos

  • CLI do Desenvolvedor do Azure
  • Docker Desktop
  • Python 3.12

Se você ainda não tiver uma conta do Azure, crie uma conta gratuita antes de começar.

Inicializar o projeto

Use a Azure Developer CLI (azd) para criar uma conta do Azure Cosmos DB for Table e implantar um aplicativo de exemplo em contêineres. O aplicativo de exemplo usa a biblioteca de clientes para gerenciar, criar, ler e consultar dados de exemplo.

  1. Abra um terminal em um diretório vazio.

  2. Se você ainda não estiver autenticado, autentique-se na Azure Developer CLI usando azd auth login. Siga as etapas especificadas pela ferramenta para se autenticar na CLI usando suas credenciais preferenciais do Azure.

    azd auth login

  3. Execute azd init para inicializar o projeto.

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

  4. Durante a inicialização, configure um nome de ambiente exclusivo.

  5. Implante a conta do Azure Cosmos DB usando azd up. Os modelos do Bicep também implantam um aplicativo Web de exemplo.

    azd up

  6. Durante o processo de provisionamento, selecione a sua assinatura, o local desejado e o grupo de recursos de destino. Aguarde o processo de provisionamento ser concluído. O processo pode levar aproximadamente cinco minutos.

  7. Depois que o provisionamento dos recursos do Azure for concluído, uma URL para o aplicativo Web em execução será incluída na saída.

    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. Use a URL no console para navegar até seu aplicativo Web no navegador. Observe a saída do aplicativo em execução.

Captura de tela do aplicativo Web em execução.

Instalar a biblioteca de clientes

A biblioteca de clientes está disponível por meio do Índice de Pacotes do Python, como a biblioteca azure-cosmos.

  1. Abra um terminal e vá até a pasta /src.

    cd ./src

  2. Se o pacote azure-cosmos ainda não estiver instalado, instale-o usando pip install.

    pip install azure-cosmos

  3. Instale também o pacote azure-identity, caso ainda não esteja instalado.

    pip install azure-identity

  4. Abra e examine o arquivo src/requirements.txt para validar se ambas as entradas azure-cosmos e azure-identity existem.

Modelo de objeto

Nome Descrição
CosmosClient Essa é a classe de cliente principal e é usada para gerenciar metadados ou bancos de dados em toda a conta.
DatabaseProxy Ela representa um banco de dados dentro da conta.
ContainerProxy A classe é usada principalmente para realizar operações de leitura, atualização e exclusão no contêiner ou nos itens armazenados no contêiner.
PartitionKey Ela representa uma chave de partição lógica. É necessária também para muitas operações e consultas comuns.

Exemplos de código

O código de exemplo do modelo usa um banco de dados chamado cosmicworks e um contêiner chamado products. O contêiner products traz detalhes como o nome, a categoria, a quantidade, um identificador exclusivo e um sinalizador de venda para cada produto. O contêiner usa a propriedade /category como uma chave de partição lógica.

Autenticar o cliente

Esta amostra cria uma instância do tipo CosmosClient e faz a autenticação usando uma instância de DefaultAzureCredential.

credential = DefaultAzureCredential()

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

Obter um banco de dados

Use client.get_database_client para recuperar o banco de dados existente chamado cosmicworks.

database = client.get_database_client("cosmicworks")

Obter um contêiner

Recupere o contêiner existente products usando database.get_container_client.

container = database.get_container_client("products")

Criar um item

Crie um objeto com todos os membros que você deseja serializar em JSON. Neste exemplo, o tipo tem um identificador exclusivo, além de campos para categoria, nome, quantidade, preço e venda. Crie um item no contêiner usando container.upsert_item. Esse método executa upsert no item, substituindo o item efetivamente caso ele já exista.

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)

Ler um item

Realize uma operação de leitura de ponto usando o identificador exclusivo (id) e os campos de chave de partição. Use container.read_item para recuperar com eficiência o item específico.

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

Itens de consulta

Realize uma consulta em vários itens de um contêiner usando container.GetItemQueryIterator. Localize todos os itens de uma categoria especificada usando esta consulta parametrizada:

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

Execute um loop pelos resultados da consulta.

items = [item for item in results]

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

Limpar os recursos

Quando você não precisar mais dos recursos ou do aplicativo de exemplo, remova a implantação correspondente e todos os recursos.

azd down

Conteúdo relacionado