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

APLICA-SE AO: NoSQL MongoDB

Visual Studio Code é um editor de código versátil para Linux, macOS e Windows, com suporte para várias extensões. Este início rápido mostra como se conectar ao Azure Cosmos DB for NoSQL e ao cluster do Azure Cosmos DB for MongoDB (vCore) usando o Visual Studio Code. Ele aborda a execução de operações de banco de dados principais, incluindo consulta, inserção, atualização e exclusão de dados.

Pré-requisitos

Para começar, você deve ter os seguintes itens:

• Uma conta do Azure Cosmos DB configurada com um banco de dados e uma coleção para a API NoSQL. Use qualquer um desses guias de início rápido abaixo para configurar um recurso:

  • Portal
  • CLI do Azure

• 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 extensão bancos de dados do Azure e selecione a extensão. Em seguida, clique em 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 em sua conta do Azure por meio da ID do Entra: Observação: é recomendável sempre usar o RBAC da ID do Microsoft Entra ao acessar seus recursos do Azure Cosmos DB (em vez de chaves de conta) para o método de autenticação mais seguro.
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 usarão 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.

Próximas etapas

Neste tutorial, você aprendeu a consultar dados no VS Code, exportar resultados de consulta, exibir métricas de consulta e índice para ajustar o desempenho da consulta e exibir dados nas várias exibições com suporte. Agora você pode usar a Extensão VS Code dos Bancos de Dados do Azure para examinar dados reais em seu banco de dados.

• 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

Para começar, você deve ter os seguintes itens:

• Uma conta do Azure Cosmos DB configurada com um banco de dados no Azure Cosmos DB for MongoDB. Use um destes guias de início rápido para configurar um banco de dados:
  • Portal
  • CLI do Azure
• 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 extensão bancos de dados do Azure e selecione a extensão. Em seguida, clique em Instalar.
  4. Após a instalação, recarregue o Visual Studio Code se solicitado.
• Shell do MongoDB (mongosh) instalado para interações de linha de comando (opcional, mas recomendado).

---

Conectando-se a uma carga de trabalho do MongoDB

Conectando-se ao cluster do Azure Cosmos DB for MongoDB (vCore)

1. Na extensão Bancos de dados do Azure, expanda a seção recursos do Azure.
2. Localize a Assinatura que você tem sua carga de trabalho do MongoDB. Na assinatura desejada, você observará ramificação do Azure Cosmos DB for MongoDB (vCore). Expanda o branch para exibir seus clusters e bancos de dados.
3. Escolha seu cluster do Azure Cosmos DB for MongoDB (vCore) na lista expandida.
4. Quando solicitado, insira a senha de administrador do cluster.
5. Depois de autenticado, você obterá acesso ao cluster.

Observação

Sua senha é usada apenas para autenticação e não é armazenada.

Observação

Em muitos ambientes corporativos, os endereços IP do computador do desenvolvedor ficam ocultos devido a uma VPN ou outras configurações de rede corporativa. Nesses casos, é recomendável começar permitindo o acesso a todos os endereços IP adicionando a regra de firewall 0.0.0.0 a 255.255.255.255.255 para teste de conexão inicialmente antes de refinar a lista de permissões.

Conectando-se a qualquer cluster do MongoDB

1. No painel Workspace, expanda a seção contas do MongoDB.
2. Aqui, você pode exibir todas as suas contas do MongoDB. Para se conectar a uma nova conta do MongoDB usando uma cadeia de conexão, clique em Nova Conexão e insira a cadeia de conexão quando solicitado.
   • Opcionalmente, você pode ser solicitado a fornecer seu nome de usuário e senha para autenticação.

Observação

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

Gerenciamento de Dados intuitivo

Gerencie facilmente seus bancos de dados no Visual Studio Code:

• Criar e remover bancos de dados/coleções: clique com o botão direito do mouse em sua conta, banco de dados ou coleção no painel de recursos para criar ou excluir bancos de dados e coleções.

• 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 clique no 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 clique no 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, clique no botão Localizar Consulta ou pressione Ctrl/Cmd+Enter no editor de consultas.

Observação

Atualmente, há suporte apenas para consultas de filtro, com recursos de consulta expandidos em breve.

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.
  • Voltar: use as trilhas de navegação abaixo do Modo de Exibição de Tabela para retornar aos níveis anteriores.

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.

Observação

O shell do MongoDB (mongosh) não está incluído com a extensão. Ele deve ser instalado separadamente e configurado manualmente.

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.

Próximas etapas

Migrar sua carga de trabalho do MongoDB for o Azure Cosmos DB