Exemplos do SDK do Azure Cosmos DB for NoSQL para JS

  • Artigo

APLICA-SE A: NoSQL

As soluções de exemplo que executam operações CRUD e outras operações comuns em recursos do Azure Cosmos DB estão incluídas no repositório GitHub SDK do JavaScript para Azure Cosmos DB. Esse artigo fornece:

  • Links para as tarefas em cada um dos arquivos de exemplo do projeto Node.js.
  • Links para o conteúdo de referência da API relacionada.

Pré-requisitos

Caso você não tenha uma assinatura do Azure, crie uma conta gratuita do Azure antes de começar.

Você pode experimentar o Azure Cosmos DB gratuitamente, sem uma assinatura do Azure e sem compromisso. Como alternativa, você pode criar uma conta de camada gratuita do Azure Cosmos DB, com as primeiras 1.000 RU/s e 25 GB de armazenamento gratuitos. Você também pode usar o emulador do Azure Cosmos DB com o URI https://localhost:8081. Quanto à chave a ser usada com o emulador, confira Autenticação de solicitações.

Você também precisa do SDK do JavaScript.

Observação

Cada exemplo é independente, eles se configuram e fazem a limpeza sozinhos. Dessa forma, os exemplo emitem várias chamadas para Containers.create. Cada vez que isso é feito, sua assinatura será cobrada por 1 hora de uso por nível de desempenho do contêiner que está sendo criado.

Exemplos de banco de dados

O arquivo DatabaseManagement mostra como executar as operações de CRUD no banco de dados. Para saber mais sobre os bancos de dados do Azure Cosmos DB antes de executar os exemplos a seguir, confira o artigo conceitual Como trabalhar com bancos de dados, contêineres e itens.

Tarefa Referência de API
Criar um banco de dados se ainda não houver um Databases.createIfNotExists
Listar bancos de dados para uma conta Databases.readAll
Ler um banco de dados por ID Database.read
Excluir um banco de dados Database.delete

Exemplos de contêiner

O arquivo ContainerManagement mostra como executar as operações de CRUD no contêiner. Para saber mais sobre as coleções do Azure Cosmos DB antes de executar os exemplos a seguir, confira o artigo conceitual Como trabalhar com bancos de dados, contêineres e itens.

Tarefa Referência de API
Criar um contêiner se ainda não houver um Containers.createIfNotExists
Listar contêineres em uma conta Containers.readAll
Ler uma definição de contêiner Container.read
Excluir um contêiner Container.delete

Exemplos de item

O arquivo ItemManagement mostra como executar as operações de CRUD no item. Para saber mais sobre os documentos do Azure Cosmos DB antes de executar os exemplos a seguir, confira o artigo conceitual Como trabalhar com bancos de dados, contêineres e itens.

Tarefa Referência de API
Criar itens Items.create
Ler todos os itens em um contêiner Items.readAll
Ler um item por ID Item.read
Ler item somente se o item foi alterado Item.read - RequestOptions.accessCondition
Consulta de documentos Items.query
Substituir um item Item.replace
Substituir item com verificação de ETag condicional Item.replace - RequestOptions.accessCondition
Excluir um item Item.delete

Exemplos de indexação

O arquivo IndexManagement mostra como gerenciar a indexação. Para saber mais sobre a indexação no Azure Cosmos DB antes de executar os exemplos a seguir, consulte os artigos conceituais políticas de indexação, tipos de indexação e caminhos de indexação.

Tarefa Referência de API
Indexar manualmente um item específico RequestOptions.indexingDirective: 'include'
Excluir manualmente um item específico do índice RequestOptions.indexingDirective: 'exclude'
Excluir um caminho do índice IndexingPolicy.ExcludedPath
Criar um índice de intervalo em um caminho de cadeia de caracteres IndexKind.Range, IndexingPolicy, Items.query
Criar um contêiner com indexPolicy padrão e atualizar o contêiner online Containers.create

Exemplos de programação do lado do servidor

O arquivo index.ts mostra como executar as tarefas a seguir. Para saber mais sobre a programação do lado do servidor no Azure Cosmos DB antes de executar os exemplos a seguir, consulte o artigo conceitual Procedimentos armazenados, gatilhos e funções definidas pelo usuário.

Tarefa Referência de API
Criar um procedimento armazenado StoredProcedures.create
Executar um procedimento armazenado StoredProcedure.execute
Atualização em massa com procedimento armazenado StoredProcedure.execute

Para obter mais informações sobre a programação do lado do servidor, confira Programação do lado do servidor do Azure Cosmos DB: procedimentos armazenados, gatilhos de banco de dados e UDFs.

Exemplo de Autenticação do Microsoft Entra

O arquivo EntraAuth.ts mostra como executar as tarefas a seguir.

Tarefa Referência de API
Create credential object from @azure/identity API
Passar credenciais de token para o construtor do cliente API
Executar o cliente do Cosmos com credenciais do AAD API

Exemplos diversos

Os exemplos coletados a seguir ilustram cenários comuns.

Tarefa Referência de API
Alterar taxa de transferência de consulta API
Obter a taxa de transferência da consulta API
Usar SasTokens para conceder acesso com escopo aos recursos do Cosmos DB API

Próximas etapas

Tentando fazer um planejamento de capacidade para uma migração para o Microsoft Azure Cosmos DB? Você pode usar informações sobre o cluster de banco de dados existente para fazer isso.