Como usar o Visual Studio Code para se conectar e consultar instâncias do Azure Cosmos DB

Pré-requisitos

• Uma conta do Azure Cosmos DB for NoSQL configurada com um banco de dados e um contêiner. Use qualquer um desses guias de início rápido aqui para configurar um recurso:
  • Portal
  • CLI do Azure

Instalar a extensão

Para conectar e gerenciar dados no Azure Cosmos DB no Visual Studio, primeiro instale a extensão de Bancos de Dados do Azure.

1. Abra o Visual Studio Code.
2. Acesse o painel Extensões selecionando Exibição > Extensões ou usando o atalho Ctrl + Shift + X no Windows e Command + Shift + X no macOS.
3. Na barra de pesquisa, digite DocumentDB para Visual Studio Code e selecione a extensão. Em seguida, selecione Instalar.
4. Após a instalação, recarregue o Visual Studio Code se solicitado.

Conectando-se a um Azure Cosmos DB for NoSQL

1. No Visual Studio Code, vá para o painel do Azure (selecione o ícone do Azure na Barra de Atividades).

2. Entre na sua conta do Azure Cosmos DB for NoSQL por meio do Microsoft Entra ID:

   Observação

   Use o controle de acesso baseado em função do Microsoft Entra ID ao acessar seus recursos do Azure Cosmos DB.

3. Depois de entrar, no modo de exibição de árvore do Azure, localize sua Assinatura do Azure e faça uma busca detalhada no Azure Cosmos DB.

4. Selecione uma conta existente ou clique com o botão direito do mouse para criar um novo recurso.

Consultar e exibir seus dados

As etapas a seguir usam o Editor de Consultas para executar uma consulta e exibir os resultados da consulta:

1. No menu da coleção, clique com o botão direito do mouse na coleção para abrir o Editor de Consultas na Versão Prévia.

   

2. Execute a consulta fornecida no editor de consultas para exibir seus dados no Exibição de Tabela:

   

3. Explore seus dados em outras exibições com suporte:

   • Exibição JSON: consulte a estrutura de dados brutos.

     

   • Modo de Exibição de Árvore: explore facilmente os dados aninhados.

     

Exibir métricas de consulta e índice

No editor de consultas, exiba métricas adicionais de consulta e índice para ajudar a otimizar melhor o desempenho da consulta.

1. Selecione a guia Estatísticas ao lado dos Resultados da consulta.

2. Para obter mais informações sobre as definições de métrica, consulte documentação de métricas de consulta.

Inserir, editar e excluir documentos

• Edição de documento em tempo real: Adicionar, exibir, editar e excluir documentos instantaneamente, com alterações refletidas em tempo real.

• Importar de JSON: carregue seus dados rapidamente de arquivos JSON.

Exportar resultados da consulta

• Resultados do download: baixe os resultados da consulta para arquivos CSV ou JSON.

Conteúdo relacionado

• Introdução à API para NoSQL
• Início rápido do Node.js
• Início Rápido do Python
• Início Rápido do Java
• Início Rápido do Go

Pré-requisitos

• Uma conta do Azure Cosmos DB for NoSQL configurada com um banco de dados e um contêiner.
• Shell do MongoDB (mongosh) instalado para interações de linha de comando (opcional, mas recomendado).

Instalar a extensão

Para conectar e gerenciar dados no Azure Cosmos DB, você precisa instalar a extensão de Bancos de Dados do Azure para Visual Studio Code.

1. Abra o Visual Studio Code.
2. Acesse o painel Extensões selecionando Exibição > Extensões ou usando o atalho Ctrl + Shift + X no Windows e Command + Shift + X no macOS.
3. Na barra de pesquisa, digite DocumentDB para Visual Studio Code e selecione a extensão. Em seguida, selecione Instalar.
4. Após a instalação, recarregue o Visual Studio Code se solicitado.

Conectando-se a uma carga de trabalho do MongoDB

Agora, conecte-se à carga de trabalho do MongoDB no Azure Cosmos DB for MongoDB.

1. No painel Workspace, expanda a seção contas do MongoDB.

2. Aqui, você pode exibir todas as suas contas do MongoDB. Conecte-se a uma nova conta do MongoDB usando suas credenciais.

   Observação

   Todos os clusters do MongoDB conectados com sucesso permanecerão listados na seção de contas do MongoDB, mesmo após o fechamento do Visual Studio Code.

Gerenciamento de Dados intuitivo

Gerencie facilmente seus bancos de dados no Visual Studio Code:

• Criar e remover bancos de dados/coleções: crie ou exclua bancos de dados e coleções usando o menu de contexto em sua conta, banco de dados ou coleção no painel de recursos.

• Importar de JSON: importar rapidamente dados de arquivos JSON para sua coleção.

  • Iniciar Importação
    1. Clique com o botão direito do mouse no nome da coleção no modo de exibição de recurso e selecione Importar Documentos para Coleção.
    2. Como alternativa, abra o "Modo de Exibição de Coleção" clicando na entrada Documentos de sua coleção e selecione o botão Importar.
  • Selecionar arquivo JSON
    1. Navegue para localizar o arquivo *.json que contém seus dados.
    2. Confirme para iniciar o processo de importação.

• Exportar dados: salve coletas ou resultados de consulta como JSON para backup ou compartilhamento.

  • Iniciar Exportação:
    • Opção 1
      1. Clique com o botão direito do mouse no nome da coleção no modo de exibição de recurso e selecione Exportar Documentos da Coleção para exportar toda a coleção.
    • Opção 2
      1. Abra o "Modo de Exibição de Coleção" clicando na entrada Documentos de sua coleção e selecione o botão Exportar.
      2. Escolha exportar toda a coleção ou os resultados da consulta atual.
  • Especificar arquivo de destino:
    1. Insira o nome e o local do arquivo *.json de destino.
    2. Confirme a exportação para começar a salvar os dados.

• Edição de documento em tempo real: adicione, exiba, edite e exclua documentos instantaneamente com atualizações em tempo real.

  • Abrir Edição de Documento:
    • Acesse as opções de edição de documento diretamente no "Modo de Exibição de Coleção". Esses controles estão convenientemente localizados acima da exibição de dados para facilitar o acesso.
  • Ações Disponíveis:
    • Adicionar: crie novos documentos dentro da coleção.
    • Exibição: exibir o conteúdo do documento selecionado.
    • Editar: edite o conteúdo dos documentos selecionados.
    • Excluir: remova documentos selecionados com alterações refletidas imediatamente.

Ferramentas de Consulta Avançadas

Execute e refinar suas consultas perfeitamente:

• Resultados Instantâneos: exibir imediatamente os resultados da consulta em seu formato preferencial — tabela, JSON ou modo de exibição de árvore.

  • Alterne exibições facilmente usando o menu suspenso Exibição.

• Execute consultas diretamente: escreva e execute consultas do MongoDB com recursos como realce de sintaxe e preenchimento automático.

  • Para executar a consulta, selecione o botão Localizar consulta ou pressione Ctrl/Cmd+Enter no editor de consultas.

Exibições de dados flexíveis

Explore seus dados usando várias exibições para diferentes perspectivas:

• Exibição JSON: consulte a estrutura de dados JSON bruta.

  

• Modo de Exibição de Árvore: navegue e explore dados aninhados sem esforço.

  

• Exibição da Tabela: examine rapidamente os dados e faça uma busca detalhada em documentos aninhados.

  • Para fazer drill down: localize as entradas com o ícone {}, que indicam objetos inseridos. Clique duas vezes para expandir e exibir o conteúdo.

  • Para voltar: retorne aos níveis anteriores usando as trilhas de navegação abaixo do Modo de exibição de tabela.

  

Integração do Shell do Mongo

A funcionalidade de linha de comando está disponível:

• Inicialização mongosh: execute comandos avançados do MongoDB diretamente do Visual Studio Code.

Gerenciamento de clusters

Mantenha-se em cima de seus recursos:

• Exibir detalhes do cluster: verifique a camada, a versão do servidor e o uso de recursos do cluster.

• Gerenciar Marcas: organize seus clusters com marcas que sincronizam com o portal do Azure.