Guia de início rápido: biblioteca do Azure Cosmos DB para NoSQL para Python
APLICA-SE A: NoSQL
Comece a usar a biblioteca de cliente do Azure Cosmos DB para NoSQL para Python para consultar dados em seus contêineres e executar operações comuns em itens individuais. Siga estas etapas para implantar uma solução mínima em seu ambiente usando a CLI do Azure Developer.
Documentação | de referência da API Código fonte | da biblioteca Pacote (PyPI) | Azure Developer CLI
Pré-requisitos
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
- Conta do GitHub
- Uma conta do Azure com uma subscrição ativa. Crie uma conta gratuitamente.
- CLI do desenvolvedor do Azure
- Área de trabalho do Docker
Configuração
Implante o contêiner de desenvolvimento deste projeto em seu ambiente. Em seguida, use a CLI do Desenvolvedor do Azure (azd
) para criar uma conta do Azure Cosmos DB para NoSQL 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.
Importante
As contas do GitHub incluem um direito de armazenamento e horas essenciais sem nenhum custo. Para obter mais informações, consulte armazenamento incluído e horas principais para contas do GitHub.
Abra um terminal no diretório raiz do projeto.
Autentique-se na CLI do Desenvolvedor do Azure usando
azd auth login
o . Siga as etapas especificadas pela ferramenta para autenticar na CLI usando suas credenciais preferidas do Azure.azd auth login
Use
azd init
para inicializar o projeto.azd init
Durante a inicialização, configure um nome de ambiente exclusivo.
Gorjeta
O nome do ambiente também será usado como o nome do grupo de recursos de destino. Para este guia de início rápido, considere usar
msdocs-cosmos-db-
o .Implante a conta do Azure Cosmos DB usando
azd up
o . Os modelos Bicep também implantam um aplicativo Web de exemplo.azd up
Durante o processo de provisionamento, selecione sua assinatura e o local desejado. Aguarde a conclusão do processo de provisionamento. O processo pode levar aproximadamente cinco minutos.
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.
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 Python Package Index, como a azure-cosmos
biblioteca.
Abra um terminal e navegue até a
/src
pasta.cd ./src
Se ainda não estiver instalado, instale o pacote usando
pip install
oazure-cosmos
.pip install azure-cosmos
Além disso, instale o
azure-identity
pacote se ainda não estiver instalado.pip install azure-identity
Abra e revise o arquivo src/requirements.txt para validar se as
azure-cosmos
entradas eazure-identity
existem.
Modelo de objeto
Nome | Descrição |
---|---|
CosmosClient |
Essa classe é a classe de cliente principal e é usada para gerenciar metadados ou bancos de dados em toda a conta. |
DatabaseProxy |
Essa classe representa um banco de dados dentro da conta. |
CotnainerProxy |
Essa classe é usada principalmente para executar operações de leitura, atualização e exclusão no contêiner ou nos itens armazenados dentro do contêiner. |
PartitionKey |
Esta classe representa uma chave de partição lógica. Essa classe é necessária para muitas operações e consultas comuns. |
Exemplos de código
- Autenticar o cliente
- Obter uma base de dados
- Obter um contentor
- Criar um item
- Obter um item
- Itens de consulta
O código de exemplo no modelo usa um banco de dados chamado cosmicworks
e um contêiner chamado products
. O products
recipiente contém detalhes como nome, categoria, quantidade, um identificador exclusivo e um sinalizador de venda para cada produto. O contêiner usa a /category
propriedade como uma chave de partição lógica.
Autenticar o cliente
As solicitações de aplicativo para a maioria dos serviços do Azure devem ser autorizadas. Use o tipo como a maneira preferida de implementar uma conexão sem senha entre seus aplicativos e o DefaultAzureCredential
Azure Cosmos DB para NoSQL. DefaultAzureCredential
suporta vários métodos de autenticação e determina qual método deve ser usado em tempo de execução.
Importante
Você também pode autorizar solicitações aos serviços do Azure usando senhas, cadeias de conexão ou outras credenciais diretamente. No entanto, esta abordagem deve ser utilizada com precaução. Os desenvolvedores devem ser diligentes para nunca expor esses segredos em um local inseguro. Qualquer pessoa que obtenha acesso à senha ou chave secreta pode se autenticar no serviço de banco de dados. DefaultAzureCredential
oferece benefícios aprimorados de gerenciamento e segurança sobre a chave da conta para permitir autenticação sem senha sem o risco de armazenar chaves.
Este exemplo cria uma nova instância do CosmosClient
tipo e autentica usando uma DefaultAzureCredential
instância.
credential = DefaultAzureCredential()
client = CosmosClient(url=endpoint, credential=credential)
Obter uma base de dados
Use client.get_database_client
para recuperar o banco de dados existente chamado cosmicworks
.
database = client.get_database_client("cosmicworks")
Obter um contentor
Recupere o contêiner existente products
usando database.get_container_client
o .
container = database.get_container_client("products")
Criar um item
Crie um novo objeto com todos os membros que você deseja serializar em JSON. Neste exemplo, o tipo tem um identificador exclusivo e campos para categoria, nome, quantidade, preço e venda. Crie um item no contêiner usando container.upsert_item
o . Este método "upserts" o item efetivamente substituindo o item se ele já existe.
new_item = {
"id": "70b63682-b93a-4c77-aad2-65501347265f",
"category": "gear-surf-surfboards",
"name": "Yamba Surfboard",
"quantity": 12,
"sale": False,
}
created_item = container.upsert_item(new_item)
Ler um item
Execute uma operação de leitura pontual usando os campos identificador exclusivo (id
) e chave de partição. Use container.read_item
para recuperar eficientemente o item específico.
existing_item = container.read_item(
item="70b63682-b93a-4c77-aad2-65501347265f",
partition_key="gear-surf-surfboards",
)
Itens de consulta
Execute uma consulta sobre vários itens em um contêiner usando container.GetItemQueryIterator
o . Encontre todos os itens dentro 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,
)
Percorra os resultados da consulta.
items = [item for item in results]
output = json.dumps(items, indent=True)
Conteúdos relacionados
- Guia de início rápido do .NET
- Guia de início rápido JavaScript/Node.js
- Início Rápido do Java
- Ir Guia de início rápido