Exemplos do SDK do Azure Cosmos DB for NoSQL para JS

  • Artigo

APLICA-SE A: NoSQL

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 SDK JavaScript para repositório GitHub do Azure Cosmos DB . Este artigo fornece:

  • Ligações para as tarefas em cada um dos ficheiros do projeto de exemplo do Node.js.
  • Ligações para o conteúdo relacionado de referência da API.

Pré-requisitos

Se não tiver uma subscrição 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 necessidade de compromisso. Como alternativa, você pode criar uma conta de camada gratuita do Azure Cosmos DB, com os primeiros 1000 RU/s e 25 GB de armazenamento gratuitamente. Você também pode usar o emulador do Azure Cosmos DB com um URI de https://localhost:8081. Para obter a chave a ser usada com o emulador, consulte Autenticando solicitações.

Também precisa do SDK JavaScript.

Nota

Cada amostra é independente, configura-se automaticamente e limpa-se em seguida. Como tal, os exemplos emitem várias chamadas para Containers.create. Cada vez que isto é feito, a sua subscrição será cobrada por uma hora de utilização de acordo com o escalão de desempenho do contentor que está a ser criado.

Exemplos de base de dados

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

Tarefa Referência da API
Criar um banco de dados se ele não existir Databases.createIfNotExists
Listar bases de dados para uma conta Databases.readAll
Ler uma base de dados por ID Database.read
Eliminar uma base de dados Database.delete

Exemplos de contentor

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

Tarefa Referência da API
Criar um contêiner se ele não existir Containers.createIfNotExists
Listar contentores de uma conta Containers.readAll
Ler uma definição de contêiner Container.read
Eliminar um contentor Container.delete

Exemplos de itens

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

Tarefa Referência da API
Criar itens Items.create
Ler todos os itens num contentor Items.readAll
Ler um item por ID Item.read
Ler item apenas se o mesmo tiver sido alterado Item.read - RequestOptions.accessCondition
Consultar documentos Items.query
Substituir um item Item.replace
Substituir item com verificação ETag condicional Item.replace - RequestOptions.accessCondition
Eliminar um item Item.delete

Exemplos de indexação

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

Tarefa Referência da 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 num caminho de cadeia IndexKind.Range, IndexingPolicy, Items.query
Crie um contêiner com indexPolicy padrão e, em seguida, atualize o contêiner online Containers.create

Exemplos de programação do lado do servidor

O arquivo index.ts mostra como executar as seguintes tarefas. 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 da 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, veja Programação do lado do servidor do Azure Cosmos DB: procedimentos armazenados, acionadores de base de dados e UDFs.

Exemplos de autenticação do Azure Identity(AAD)

O arquivo AADAuth.ts mostra como executar as seguintes tarefas.

Tarefa Referência da API
Create credential object from @azure/identity API
Passar credenciais para o objeto cliente com a chave aadCredentials API
Execute o cliente cosmos com credenciais aad API

Amostras diversas

Os exemplos selecionados a seguir ilustram cenários comuns.

Tarefa Referência da API
Taxa de transferência do Alter Query API
Obtendo a taxa de transferência da consulta API
usando SasTokens para conceder acesso com escopo aos recursos do Cosmos DB API

Próximos passos

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