Guia de início rápido: usar o Azure Cosmos DB para tabela com o SDK do Azure para Python

Neste início rápido, você implanta 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 os aplicativos armazenem dados de tabela estruturada na nuvem. Você aprende a criar tabelas, linhas e executar tarefas básicas em seu recurso do Azure Cosmos DB usando o SDK do Azure para Python.

Documentação de referência da APICódigo fonte da bibliotecaPacote (PyPI)CLI do desenvolvedor do Azure

Prerequisites

• Azure Developer CLI
• Área de trabalho do Docker
• Python 3.12

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

Inicializar o projeto

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

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

2. Caso ainda não esteja autenticado, autentique-se no Azure Developer CLI usando azd auth login. Siga as etapas especificadas pela ferramenta para autenticar na CLI usando suas credenciais preferidas do Azure.

   azd auth login
   

3. Use 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 Bicep também implantam um aplicativo Web de exemplo.

   azd up
   

6. Durante o processo de provisionamento, selecione sua assinatura, o local desejado e o grupo de recursos de destino. Aguarde a conclusão do processo de provisionamento. 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 o URL no console para navegar até seu aplicativo Web no navegador. Observe a saída do aplicativo em execução.

Instalar a biblioteca de cliente

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

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

   cd ./src
   

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

   pip install azure-data-tables
   

3. Abra e revise o arquivo src/requirements.txt para validar que a azure-data-tables entrada existe.

Importar bibliotecas

Importe os tipos DefaultAzureCredential e TableServiceClient para o código da sua aplicação.

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

Modelo de objeto

Exemplos de código

• Autenticar o cliente
• Obter uma mesa
• Criar uma entidade
• Obter uma entidade
• Entidades de consulta

O código de exemplo no modelo usa uma tabela chamada cosmicworks-products. A cosmicworks-products tabela 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 a chave de linha e categoria como uma chave de partição.

Autenticar o cliente

Este exemplo cria uma nova instância do TableServiceClient tipo.

credential = DefaultAzureCredential()

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

Obter uma mesa

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

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 novo objeto, garantindo que você especifique as propriedades obrigatórias RowKey e PartitionKey obrigatórias.

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

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

Entidades de consulta

Depois de 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 de cadeia de caracteres.

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

for entity in entities:
    # Do something

Limpeza de recursos

Quando já não precisar da aplicação ou dos recursos de amostra, remova a implementação correspondente e todos os recursos.

azd down

Conteúdo relacionado

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