Início Rápido: Biblioteca do Azure Cosmos DB for Table para Node.js

APLICA-SE AO: Table

Este início rápido mostra como começar a usar o Azure Cosmos DB for Table a partir de um aplicativo Node.js. O Azure Cosmos DB for Table é um armazenamento de dados sem esquema para que os aplicativos armazenem dados de tabela estruturados na nuvem. Você aprende como criar tabelas, linhas e executar tarefas básicas dentro do seu recurso do Azure Cosmos DB usando o SDK do Azure para Node.js.

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

Pré-requisitos

• Uma conta do Azure com uma assinatura ativa. Crie uma conta gratuitamente.
• CLI do Desenvolvedor do Azure
• Docker Desktop
• Node.js 22 ou mais recente

Inicializar o projeto

Use o Azure Developer CLI (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 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 no 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-nodejs-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 sua assinatura, localização desejada e 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 npm, como o pacote @azure/data-tables.

Modelo de objeto

Exemplos de código

• Autenticar o cliente
• Obter uma tabela
• Criar um item
• Obter um item
• Itens de consulta

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

Autenticar o cliente

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

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

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

Obter uma tabela

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

let table: TableClient = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

let table = new TableClient("<azure-cosmos-db-table-account-endpoint>", "<azure-cosmos-db-table-name>", credential);

Criar um item

export interface Product extends TableEntity {
    name: string;
    quantity: number;
    price: number;
    clearance: boolean;
}

const entity: Product = {
    rowKey: '70b63682-b93a-4c77-aad2-65501347265f',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

const entity = {
    rowKey: '70b63682-b93a-4c77-aad2-65501347265f',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Crie um item na coleção usando o método upsertEntity da instância TableService.

await table.upsertEntity<Product>(entity, "Replace"); 

await table.upsertEntity(entity, "Replace");

Obter um item

Você pode recuperar um item específico de uma tabela usando o método getEntity, a chave da linha do item e a chave de partição do item.

const response: GetTableEntityResponse<TableEntityResult<Product>> = await table.getEntity<Product>(partitionKey, rowKey);

const entity: Product = response as Product;

const entity = await table.getEntity(partitionKey, rowKey);

Itens de consulta

Após inserir um item, você também pode executar uma consulta para obter todos os itens que correspondem a um filtro específico usando listEntities com um filtro OData.

const partitionKey: string = 'gear-surf-surfboards';

const filter: string = `PartitionKey eq '${partitionKey}'`

const queryOptions: TableEntityQueryOptions = { filter: filter }

const entities: PagedAsyncIterableIterator<TableEntityResult<Product>, TableEntityResultPage<Product>> = table.listEntities<Product>({ queryOptions: queryOptions });

const partitionKey = 'gear-surf-surfboards';

const entities = table.listEntities({
    queryOptions: {
        filter: `PartitionKey eq '${partitionKey}'`
    }
});

Analise os resultados paginados da consulta usando um loop assíncrono for await no conjunto paginado de entities.

for await(const entity of entities) {
    // Do something
}

for await(const entity of entities) {
    // Do something
}

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

• Início Rápido do .NET
• Início Rápido do Python
• Início Rápido do Java