Início rápido: usar o Azure Cosmos DB for Table com o SDK do Azure para Python

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

• Azure Developer CLI
• Área de Trabalho do Docker
• 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 cliente 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-table-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.

Instalar a biblioteca de clientes

A biblioteca de clientes está disponível através do PyPi, como o pacote Azure-data-tables.

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

   cd ./src
   

2. Se o pacote Azure-data-tables ainda não estiver instalado, instale-o usando pip install.

   pip install azure-data-tables
   

3. Abra e examine o arquivo src/requirements.txt para validar se a entrada Azure-data-tables existe.

Importar bibliotecas

Importe os tipos DefaultAzureCredential e TableServiceClient para o código do seu aplicativo.

from azure.data.tables import TableServiceClient
from azure.identity import DefaultAzureCredential

Modelo de objeto

Exemplos de código

• Autenticar o cliente
• Obter uma tabela
• Criar uma entidade
• Obter uma entidade
• Consultar entidades

O código de exemplo no modelo usa uma tabela chamada cosmicworks-products. A tabela cosmicworks-products contém detalhes como nome, categoria, quantidade, preço, um identificador exclusivo e um sinalizador de venda para cada produto. O contêiner usa um identificador exclusivo como chave de linha e categoria como chave de partição.

Autenticar o cliente

Esta amostra cria uma nova instância do tipo TableServiceClient.

credential = DefaultAzureCredential()

client = TableServiceClient(endpoint="<azure-cosmos-db-table-account-endpoint>", credential=credential)

Obtenha uma tabela

Esta amostra cria uma instância do tipo TableClient usando a função GetTableClient do tipo TableServiceClient.

table = client.get_table_client("<azure-cosmos-db-table-name>")

Criar uma entidade

A maneira mais fácil de criar uma nova entidade em uma tabela é criar um objeto, garantindo que você especifique as propriedades obrigatórias RowKey e PartitionKey.

new_entity = {
    "RowKey": "aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    "PartitionKey": "gear-surf-surfboards",
    "Name": "Yamba Surfboard",
    "Quantity": 12,
    "Sale": False,
}

Criar uma entidade na tabela usando upsert_entity.

created_entity = table.upsert_entity(new_entity)

Obter uma entidade

Você pode recuperar uma entidade específica de uma tabela usando get_entity.

existing_entity = table.get_entity(
    row_key="aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb",
    partition_key="gear-surf-surfboards",
)

Consultar entidades

Após inserir uma entidade, você também pode executar uma consulta para obter todas as entidades que correspondem a um filtro específico usando query_entities com um filtro OData.

category = "gear-surf-surfboards"
# Ensure the value is OData-compliant by escaping single quotes
safe_category = category.replace("'", "''")
filter = f"PartitionKey eq '{safe_category}'"
entities = table.query_entities(query_filter=filter)

Analise os resultados paginados da consulta usando um loop for.

for entity in entities:
    # Do something

Limpar os recursos

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

azd down

Conteúdo relacionado

• Início Rápido do .NET
• Início rápido do Node.js
• Início Rápido do Java
• Início Rápido do Go