Conectar-se ao MongoDB Deployment
Nesta página
Esta página descreve como usar a extensão MongoDB for VS Code para se conectar a um host MongoDB. Você pode se conectar a um host de cluster independente, de réplica ou fragmentado.
Observação
MongoDB Atlas
Se você precisar criar um host MongoDB, considere utilizar o MongoDB Atlas. O Atlas é uma base de dados como serviço hospedado em nuvem que não requer instalação, oferece uma camada grátis para começar e fornece um URI copiável para conectar facilmente a extensão do VS Code à sua implantação.
Para criar um agrupamento na camada livre do Atlas, execute o comando MongoDB: Open Overview Page na Paleta de Comando de Código do Visual Studio e clique em Create free cluster.
Para criar um cluster Atlas usando um modelo do Terraform incluído no VS Code Extension, consulte Criar um cluster Atlas a partir de um modelo usando o Terraform.
Se você precisar instalar o VS Code Extension, consulte Instalar o MongoDB for VS Code Extension para obter instruções.
Considerações
Ao conectar a extensão do Código VS a um conjunto de réplicas, utilize o conjunto de réplicas SRV record ou Replica Set Name ao preencher suas informações de conexão. Não é recomendável conectar-se diretamente a um membro individual do conjunto de réplicas.
Se o membro ao qual você está conectado mudar de membro primário para secundário , ou vice-versa, como resultado de uma eleição, o VS Code Extension pode encerrar a conexão à força ou exibir dados obsoletos.
Não é possível conectar o VS Code Extension diretamente a um nó de análise.
A extensão do VS Code acrescenta a opção de string de conexão
appNamecom um valor demongodb-vscode <version>para todas as conexões de implantação.
Criar uma conexão
A extensão do VS Code oferece duas opções para se conectar à sua implantação:
Método de conexão | Descrição |
|---|---|
Connect with Connection String | Esse método é mais rápido e fácil do que usar as configurações avançadas de conexão. Utilize esta opção se a sua implantação estiver hospedada no Atlas ou você já tiver uma connection string para uma implantação disponível. |
Advanced Connection Settings | Esse método permite construir uma connection string com um formulário. Use esta opção se precisar personalizar a connection string e desejar ver as opções de conexão disponíveis. |
Observação
Para especificar onde as conexões da extensão do VS Code são salvas, use a configuração Default Connection Saving Location.
Quando você fornece uma string de conexão, a extensão do VS Code oferece a maioria das opções de string de conexão com suporte no MongoDB.
Obtenha sua connection string.
Você pode usar o formato de string de conexão padrão ou o formato de conexão DNS Seedlist.
Para obter a cadeia de conexão para um cluster Atlas:
Navegue até a visualização do Atlas Clusters .
Clique em Connect para o cluster desejado.
Clique em Connect with MongoDB Compass.
Copie a connection string fornecida.
Para saber como formatar a string de conexão para uma implantação que não está hospedada no Atlas, consulte Formato de URI da string de conexão.
Abra a paleta de comandos do Visual Studio Code.
Abra a Paleta de comando de código do Visual Studio para colar sua connection string e conectá-la ao cluster. Você pode abrir a Paleta de Comando das seguintes maneiras:
Selecione o ícone MongoDB na barra de menu do lado esquerdo no VSCode.
![Menu da barra lateral VSCode da imagem.]()
clique para ampliarExpanda o painel Connections na navegação à esquerda se ele estiver fechado.
![Imagem mostrando o painel de conexões]()
clique para ampliarClique no menu More Actions (...) e selecione Add MongoDB Connection with Connection String....
![Selecione adicionar conexão com a string de conexão]()
clique para ampliar
Execute a ação descrita na tabela a seguir para seu sistema operacional e método:
Sistema operacionalMétodoAçõesAny
Menu de código do Visual Studio
View > Command Palette
macOS
Atalho de teclado
Pressione
Command+Shift+PWindows e Linux
Atalho de teclado
Pressione
Control+Shift+PNa Paleta de comandos, selecione MongoDB: Open Overview Page.
Dica
Insira
mongodbna Paleta de Comando para exibir todos os comandos de extensão de VS Code que você pode usar.Na página Visão Geral, clique em Connect abaixo de Connect with Connection String.
Execute a ação descrita na tabela a seguir para seu sistema operacional e método:
Sistema operacionalMétodoAçõesAny
Menu de código do Visual Studio
View > Command Palette
macOS
Atalho de teclado
Pressione
Command+Shift+PWindows e Linux
Atalho de teclado
Pressione
Control+Shift+PNa Paleta de comandos, selecione MongoDB: Connect with Connection String....
Dica
Insira
mongodbna Paleta de Comando para exibir todos os comandos de extensão de VS Code que você pode usar.
Cole a connection string na Paleta de comandos
Importante
Se a sua implantação exigir autenticação, certifique-se de atualizar a connection string com credenciais de um utilizador de banco de dados para seu sistema. A conexão pode ser bem-sucedida sem essas credenciais, mas você não poderá interagir com dados em seu sistema.
Abra a página Visão geral da extensão do VS Code
Você pode usar a visualização do MongoDB ou a Paleta de Comandos para abrir a página de visão geral:
Expanda o painel Connections na navegação à esquerda se estiver fechado.
![Imagem mostrando o painel de conexões]()
clique para ampliarClique no menu More Actions (...) e depois clique em Add MongoDB Connection para abrir a página Visão geral da extensão do VS Code.
![Imagem mostrando os pontos do painel de conexões]()
clique para ampliar
Execute a ação descrita na tabela a seguir para seu sistema operacional e método:
Sistema operacionalMétodoAçõesAny
Menu de código do Visual Studio
View > Command Palette
macOS
Atalho de teclado
Pressione
Command+Shift+PWindows e Linux
Atalho de teclado
Pressione
Control+Shift+PNa Paleta de comandos, selecione MongoDB: Open Overview Page.
Dica
Insira
mongodbna Paleta de Comando para exibir todos os comandos de extensão de VS Code que você pode usar.
Insira suas informações de conexão.
Importante
A extensão VS Code não é compatível com as seguintes opções de conexão:
Criptografia em execução CSFLE
Autenticação Kerberos
A guia General contém as seguintes opções:
Opção | Descrição | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Connection Type | Tipo de conexão. Selecione seu tipo de conexão nas abas para obter instruções específicas para definir esse tipo de conexão: Para um Autônomo, especifique o seguinte:
Clique para especificar nomes de host adicionais e portas associadas. Para um conjunto de réplicas, especifique o seguinte:
Clique para especificar nomes de host adicionais e portas associadas. Para um registro SRV, especifique o Hostname. Você não precisa especificar uma porta. As strings de conexão SSV têm um prefixo de Por exemplo: Se a seguinte for sua string de conexão SRV para sua implantação do MongoDB: Em seguida, no VS Code Extension, você especificaria seu Hostname como: | ||||||||||||||||||||||
Authentication | Autenticação a ser usada se a implantação exigir autenticação. Os cluster do Atlas usam autenticação Username / Password. Selecione seu método de autenticação para obter instruções específicas: Selecione Username / Password se a implantação usar MongoDB-CR, SCRAM-SHA-1 ou SCRAM-SHA-256 como mecanismo de autenticação. Forneça o Username, Password e Banco de dados de autenticação para autenticar o usuário. Seleciona OIDC se a implantação utilizar OpenID Connect como seu mecanismo de autenticação. Forneça as seguintes informações:
Este é um fluxo de autenticação menos seguro que pode ser usado como fallback quando a autenticação baseada em navegador não está disponível. Selecione X.509 se a implantação utilizar X.509 como seu mecanismo de autenticação. Se selecionado, você deve fornecer o Username para autenticar o usuário. Se você estiver usando Certificados gerenciados pelo Atlas seu nome de usuário deve ser precedido por "CN=" conforme o RFC 2253. Por exemplo, o nome de usuário "X509Usuário" deve ser fornecido como "CN=X509Usuário". Selecione LDAP se a implantação utilizar LDAP como mecanismo de autenticação. Se selecionado, você deverá fornecer Username e Password para autenticar o usuário. Selecione AWS IAM se a implantação utilizar AWS IAM como seu mecanismo de autenticação.
|
Se estiver se conectando à sua implantação usando TLS/SSL ou um túnel SSH, consulte as abas a seguir para obter instruções específicas:
Esta opção direciona o VS Code Extension para se conectar à sua implantação MongoDB via TLS/SSL. Você pode selecionar uma das seguintes opções de SSL:
Opção | Descrição | ||||||||
|---|---|---|---|---|---|---|---|---|---|
System CA/Atlas Deployment | Conecte-se ao MongoDB Atlas. | ||||||||
Server Validation | A extensão do VS Code valida a identidade da implantação. Se selecionado, você deve fornecer:
| ||||||||
Server and Client Validation | A implantação executa a validação de certificado de seus clientes, e a Extensão do VS Code valida a identidade da implantação. Se selecionado, você deve fornecer:
| ||||||||
Unvalidated (Insecure) | Use TLS/SSL sem qualquer validação de identidade. |
Dica
Para uso em produção, sua implantação do MongoDB deve usar certificados válidos gerados e assinados por uma única autoridade de certificação. Você ou sua organização podem gerar e manter uma autoridade de certificação independente ou usar certificados gerados por um fornecedor de TLS/SSL de terceiros.
Esta opção orienta o VS Code Extension a se conectar à sua implantação do MongoDB por meio de um túnel SSH. O túnel é iniciado automaticamente quando você se conecta ao MongoDB e para quando você se desconecta.
No menu suspenso SSH Tunnel, escolha uma senha ou arquivo de identidade para autenticar. Depois de selecionar o método de identificação, defina as seguintes opções:
SSH Hostname | Digite o nome do host do bastion (jumpbox). Este é o identificador exclusivo (nome de domínio totalmente qualificado ou FQDN) da máquina a ser acessada. |
SSH Tunnel Port | Forneça a porta usada para a conexão SSH. Este padrão é 22, a porta padrão para SSH. |
SSH Username | O nome de usuário do perfil para fazer login no sistema remoto. Este será o usuário para o qual você deseja estabelecer a conexão SSH. |
SSH Identity File | Selecione o arquivo do qual a identidade (chave privada) para autenticação de chave pública SSH é lida. Unix ou OS X: Se utilizar OpenSSH, os ficheiros de identidade são encontrados no diretório
No Windows, a localização dos arquivos de identidade depende da sua escolha de cliente SSH, como PuTTY. |
SSH Passphrase | Se sua chave privada for criptografada, forneça a senha usada para descriptografar sua chave privada (armazenada no arquivo de identidade especificado). Uma senha fornece uma camada adicional de segurança para conexões SSH. |
SSH Password | A senha usada para proteger a conexão SSH. Isso será necessário se você não estiver usando um arquivo de identidade. |
Para usar um túnel SSH por meio de um bastion host, a configuração SSH no bastion host deve permitir o encaminhamento de portas TCP; ou seja, a diretiva AllowTcpForwarding no arquivo /etc/ssh/sshd_config está definida como yes. Se AllowTcpForwarding não estiver definido como yes, defina como yes e retome o daemon SSH (sudo service sshd restart).
Em vez de criar o túnel SSH usando o VS Code Extension, você também pode criar o túnel manualmente na linha de comando:
ssh -L <local_port>:<mongodb_hostname>:<mongodb_port> \ <user>@<bastion_hostname> -fN
Exemplo
Se você tiver uma implantação em execução em hostname-a.com na porta 27017, e o host de bastião for hostname-b.com com nome de usuário ec2-user, você poderá construir o túnel por meio
ssh -L 27000:hostname-a.com:27017 ec2-user@hostname-b.com -fN
Usando este túnel SSH, agora você pode conectar o VS Code Extension (ou o shell mongo ) para localhost:27000 para se conectar à implantação em execução em hostname-a.com.
Observação
Você não pode se conectar a um conjunto de réplicas por meio de um túnel SSH. A VS Code Extension não pode estabelecer uma conexão com vários servidores no mesmo túnel SSH.
Opcional: especifique opções adicionais na aba Advanced
Você pode selecionar Read Preference, que especifica como a Extensão VS Code direciona as operações de leitura:
Modo de preferência de leitura | Descrição |
|---|---|
Primary | Modo padrão. Todas as operações são lidas a partir do conjunto de réplicas atual principal. |
Primary Preferred | Na maioria das situações, as operações são lidas a partir do principal, mas se não estiver disponível, as operações serão lidas dos secundários. |
Secondary | Todas as operações são lidas a partir dos secundários do conjunto de réplicas. |
Secondary Preferred | Na maioria das situações, as operações são lidas a partir de membros secundários, mas se nenhum membro secundário estiver disponível, as operações são lidas a partir do principal. |
Nearest | Operações lidas de um membro do conjunto de réplicas com a menor latência de rede, independentemente do tipo do membro. |
Se omitido, o padrão é Primary. Para saber mais sobre as preferências de leitura, consulte Preferência de leitura.
Você pode especificar o comportamento de conexão adicional do MongoDB com as seguintes opções:
Campo | Descrição |
|---|---|
ReplicaSetName | (Opcional) Nome do conjunto de réplicas. |
Banco de dados de autenticação padrão | (Opcional) Banco de dados de autenticação usado quando authSource não é especificado. Para obter mais informações, consulte Opções de autenticação. |
Opções de URI | Opções adicionais para personalizar sua conexão. Você especifica essas opções como pares de valores-chave e o Visual Studio Code adiciona automaticamente os pares de valores-chave à string de conexão. Para obter mais informações, consulte Opções da string de conexão. |
Conectar ao Atlas Stream Processing
Novidade na versão 1.50.
Você pode usar a extensão do VS Code para se conectar ao Atlas Stream Processing fornecendo uma string de conexão de Stream Processing Interface (SPI).
Para obter detalhes sobre como configurar o Atlas Stream Processing, consulte Gerenciar instâncias de Stream Processing.
Cole uma connection string SPI
Para obter uma string de conexão SPI, faça login em sua conta do Atlas. Clique em Stream Processing na navegação à esquerda e selecione uma Instância do Atlas Stream Processing. Clique em Connect e escolha MongoDB for VSCode na página Choose a Connection Method da caixa de diálogo de conexão.
Dica
Para obter detalhes completos sobre como usar e configurar o Atlas Stream Processing, consulte Visão geral do Atlas Stream Processing.
O bloco de código a seguir é um exemplo de connection string SPI:
mongodb://user1:password1@atlas-stream-xxxxxxxxxxxxxxxxxxxxxxxx-yyyyy.virginia-usa.a.query.mongodb.net/?authSource=admin&readPreference=primary&ssl=true&directConnection=true
Depois que você estiver conectado, a conexão do stream será exibida no painel Connections :
Abra um novo playground do VS Code Extension
Após conectar com sucesso ao seu Atlas Stream, clique em Create New Playground no painel Playgrounds. Um modelo de playground de stream processing é exibido com código pré-preenchido que permite listar conexões de stream e processar dados de stream:
Ativar uma conexão
Você pode conectar a extensão do VS Code a apenas uma implantação de cada vez. Para alterar a conexão ativa para uma implantação diferente ou para se conectar a uma implantação da qual você foi desconectado:
Inicie o MongoDB Shell
Você pode conectar o MongoDB Shell ou o shell mongo herdado à sua implantação ativa.
Considerações
O shell que a extensão do VS Code usa para se conectar à sua implantação é determinado pela configuração Shell nas configurações da extensão. Você pode escolher o MongoDB Shell ou o shell legado
mongo.O caminho para a concha selecionada deve existir no
PATHdo seu sistema. Se não existir no seuPATH, os erros de operação.
Procedimento
Para conectar o shell à sua implantação ativa:
Na lista VS Code Extension Connections, clique com o botão direito do mouse em sua implantação ativa.
Selecione Launch MongoDB Shell.
A extensão do VS Code abre a janela Terminal no VS Code e inicia o shell conectado à sua implantação selecionada.
Editar uma conexão
Faça as alterações e salve
Clique em Advanced Connection Options para exibir o formulário de conexão avançado.
Dica
Você também pode clicar no botão Edit Connection String no canto superior direito do formulário para editar o URI da connection string diretamente.
Quando terminar de editar as opções de conexão, clique em Save & Connect.
Copiar uma conexão
Você pode copiar uma connection string de uma conexão existente do Visual Studio Code.
Renomear uma conexão
Para renomear uma conexão com uma implantação na extensão do VS Code:
Desconectar de uma implementação
A extensão do VS Code fornece dois métodos para se desconectar de uma implantação. Você pode:
Desconecte-se da Paleta de comandos.
Desconecte-se da visualização MongoDB no Activity Bar.
A desconexão de uma instância MongoDB fecha a extensão do VS Code para a conexão com a instância ativa. Você deve se reconectar para interagir com os dados em sua implantação novamente.
Remover uma conexão
A extensão do VS Code fornece dois métodos para remover uma conexão a uma implantação do Visual Studio Code. Você pode:
Remova uma conexão da visualização MongoDB no Activity Bar.
Remova uma conexão com a Paleta de comandos.
Importante
A remoção de uma conexão do Visual Studio Code a remove tanto do espaço de trabalho atual quanto do Visual Studio Code globalmente.