Partilhar via

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

  • Artigo
  • Aplica-se a:
    ✅ Table

Neste início rápido, você implanta um aplicativo básico do Azure Cosmos DB for Table usando o SDK do Azure para Node.js. 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 Node.js.

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

Pré-requisitos

  • Azure Developer CLI
  • Área de trabalho do Docker
  • Node.js 22 ou superior

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. Se você ainda não estiver autenticado, autentique-se na CLI do Desenvolvedor do Azure usando azd auth logino . 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-nodejs-quickstart

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

  5. Implante a conta do Azure Cosmos DB usando azd upo . 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.

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

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

Instalar a biblioteca de cliente

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

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

    cd ./src/ts

  2. Se ainda não estiver instalado, instale o pacote usando npm installo @azure/data-tables .

    npm install --save @azure/data-tables

  3. Abra e revise o arquivo src/ts/package.json para validar se a @azure/data-tables entrada existe.

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

    cd ./src/js

  2. Se ainda não estiver instalado, instale o pacote usando npm installo @azure/data-tables .

    npm install --save @azure/data-tables

  3. Abra e revise o arquivo src/js/package.json para validar se a @azure/data-tables entrada existe.

Modelo de objeto

Nome Descrição
TableServiceClient Esse tipo é o tipo de cliente principal e é usado para gerenciar metadados ou bancos de dados em toda a conta.
TableClient Este tipo representa o cliente para uma tabela dentro da conta.

Exemplos de código

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.

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

const credential = new DefaultAzureCredential();

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

Obter uma mesa

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

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 uma entidade

A maneira mais fácil de criar uma nova entidade em uma tabela é derivar uma nova interface e TableEntity , em seguida, criar um novo objeto desse tipo.

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

const entity: Product = {
    rowKey: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

A maneira mais fácil de criar um novo item em uma tabela é criar um objeto JSON.

const entity = {
    rowKey: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    partitionKey: 'gear-surf-surfboards',
    name: 'Yamba Surfboard',
    quantity: 12,
    price: 850.00,
    clearance: false
};

Crie uma entidade na tabela usando o upsertEntity método da TableService instância.

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

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

Obter uma entidade

Você pode recuperar uma entidade específica de uma tabela usando o getEntity método, a chave de linha para a entidade e a chave de partição da entidade.

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

const entity: Product = response as Product;

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

Entidades de consultas

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 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
}

Clean up resources (Limpar recursos)

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

azd down

Conteúdos relacionados