Esta página descreve como usar o MongoDB Compass para se conectar a um host MongoDB. Você pode se conectar a um host de cluster standalone, de conjunto de réplica ou fragmentado.
Observação
MongoDB Atlas
If you need to create a MongoDB host, consider using MongoDB Atlas. Atlas is a cloud-hosted database-as-a-service which requires no installation, offers a free option to get started, and provides a copyable URI to easily connect Compass to your deployment.
Se você precisar instalar o Compass, consulte Baixar e instalar o Compass para obter instruções.
Considerações
Ao conectar o Compass a um conjunto de réplicas, 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 um membro primário para um secundário ou vice-versa como resultado de uma eleição, o Compass poderá fechar a conexão à força ou exibir dados obsoletos.
Para conectar a um conjunto de réplicas, utilize o conjunto de réplica SRV record ou Replica Set Name ao preencher suas informações de conexão.
O Compass exibe uma mensagem de aviso quando conectado a instâncias não genuínas do MongoDB , pois essas instâncias podem se comportar de forma diferente das instâncias oficiais do MongoDB . Essas instâncias não originais podem ter recursos ausentes ou incompletos.
A partir da versão 1.39.2, O MongoDB Compass não suporta mais a migração de arquivos de conexão legados anteriores à versão 1.31.0. As conexões legadas referem-se a um formato interno de opções de conexão do Compass que é armazenado em disco e não é mais suportado após a versão 1.39.0.
Se você tiver conexões legadas salvas em seus favoritos, exporte as conexões na versão 1.39.0 para convertê-las no novo formato antes de atualizar para a versão 1.39.2 ou posterior.
Conecte
Se o nome da sua conexão já estiver no Connections Sidebar da janela do Compass, clique no nome da conexão para se conectar.
Caso contrário, você pode conectar suas implantações por:
Fornecendo sua connection string.
Especificando Advanced Connection Options. As opções avançadas de conexão permitem que você especifique as opções de autenticação, TLS/SSL e conexão SSH. Para saber mais, consulte Opções avançadas de conexão.
Observação
A partir da versão 1.44.0, você pode se conectar a várias instâncias do MongoDB de uma só vez por meio do Compass.
Forneça sua string de conexão.
Quando você fornece uma string de conexão, o Compass suporta a maioria das opções de string de conexão suportadas pelo MongoDB.
By default, Compass's default socketTimeoutMS value is 60000, or 60 seconds. If you are frequently experiencing timeouts in Compass, consider setting this option to a higher value in your connection string.
Para obter uma lista completa das opções de connection string compatíveis com o Compass, consulte o Compass Connection README no GitHub.
Cole sua connection string.
If you have the connection string for your deployment available, you can paste the string directly into the dialog box. You can use either the Standard Connection String Format or the DNS Seedlist Connection Format.
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.
Aviso
Se você clicar no formulário de conexão do MongoDB Compass para editar sua cadeia de conexão, o Compass mostra credenciais em texto sem formatação por padrão.
Para editar suas credenciais de connection string sem expor sua senha, utilize a aba Advanced Connection Options > Authentication no formulário de conexão do Compass.
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.
Conecte-se ao seu cluster.
Para navegar até a Página inicial do Compass, clique em Save, Connect ou Save & Connect.
O botão Save salva sua conexão e fecha o modal sem se conectar ao seu cluster ainda.
O botão Connect permite que você se conecte ao seu cluster sem salvar a string de conexão ou as credenciais.
O botão padrão Save & Connect salva suas informações e conecta você ao seu cluster.
Importante
Acesso necessário
Once you are connected to your MongoDB deployment, you may require specific user roles to access various Compass features. For more information on the required roles for Compass features, see Required Access.
Use Opções avançadas de conexão
As opções avançadas de conexão fornecem maneiras adicionais de conectar o Compass ao MongoDB. As opções avançadas de conexão permitem que você especifique a autenticação, TLS/SSL e SSH para se conectar com segurança ao seu sistema.
Para obter detalhes sobre como especificar opções de conexão usando o Compass, consulte Opções Avançadas de Conexão.
Conexões de aplicativos do Atlas
Observação
You can securely connect Compass to your MongoDB Atlas account using Atlas App Connections. To learn how Atlas App Connections works with Compass, see App Types.
Configurações de proxy
Para estabelecer uma conexão com configurações de proxy, use as seguintes variáveis de ambiente:
Variável | Descrição | Exemplo | |
|---|---|---|---|
| Conexões de provisionamento com URLs | O exemplo a seguir define a variável de ambiente | |
| Conexões proxy para URLs Se você também definir | O exemplo a seguir define a variável de ambiente | |
| Conexões proxy para URLs Se você também definir | O exemplo a seguir define a variável de ambiente | |
| Faça o proxy todas as conexões para o URL especificado. | O exemplo a seguir define a variável de ambiente | |
| Lista separada por vírgulas de nomes de host que devem ser excluídos do proxy. | O exemplo a seguir define a variável de ambiente |
Observação
O Compass fornece suporte para os seguintes tipos de proxy:
Proxies Socks5
Proxies HTTP, também conhecidos como proxies HTTPS
Proxies CONNECT
URLs do PAC que são direcionados para um dos proxies listados anteriormente
Conectar ao Compass a partir da Linha de Comando
Você pode iniciar uma sessão do Compass na linha de comando.
Em ambientes empresariais, um início com scripts pode facilitar a distribuição do Compass. Por exemplo, para limitar o acesso a sistemas confidenciais, você pode configurar um início de linha de comando para que o Compass possa executar em um jump host.
Para se conectar ao Compass usando a linha de comando, você pode incluir suas opções de conexão diretamente na string de conexão ou como argumentos de linha de comando.
Para especificar opções de conexão na sua string de conexão, utilize o seguinte formato:
mongodb-compass 'mongodb://username:password@hostname:port/database?ssl=true&replicaSet=myReplicaSet'
Para obter mais opções de string de conexão, consulte Opções de string de conexão.
Para especificar opções de conexão como argumentos de linha de comando, utilize o seguinte formato:
<path/to/compass/executable> <connection string> --username <username> --password <password>
Para obter mais opções de conexão de argumento de linha de comando, consulte Iniciar o Compass a partir da linha de comando.
Dica
Para saber como desconectar seu sistema, consulte Desconectar do MongoDB
Exemplos de connection string
The following examples highlight some advanced connection string options. For information on all connection string options, see Connection String Options.
Opções de TLS
A seguinte string de conexão habilita o TLS utilizando a opção de URI do tls. tlsCertificateKeyFile especifica o caminho para o certificado do cliente e a chave privada. A especificação de tlsCertificateKeyFile em sua string de conexão é opcional, a menos que o servidor exija certificados de cliente ou se você estiver usando a autenticação X.509.
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com/?directConnection=true&tls=true&tlsCAFile=path/to/rootCA.crt&tlsCertificateKeyFile=path/to/server_certificate.pem
Para habilitar o SSL, utilize a opção equivalente ssl=true em vez de tls=true.
Autenticação X.509
The following example demonstrates how to specify X.509 authentication in your connection string using the authMechanism connection string option:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db1.example.com/?authMechanism=MONGODB-X509&tls=true&tlsCertificateKeyFile=/path/to/client_certificate.pem
LDAP
The following example specifies LDAP authentication. It sets authMechanism to plain to specify the use of the LDAP authentication mechanism and sets authSource to $external to indicate that the authentication database is $external.
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db2.example.com/?authMechanism=PLAIN&authSource=$external
Kerberos
The following example specifies Kerberos authentication. It sets authMechanism to GSSAPI to use the Kerberos authentication mechanism and sets authSource to $external to indicate that the authentication database is $external.
mongodb://myDatabaseUser@db3.example.com/?authMechanism=GSSAPI&authSource=$external
Preferências de leitura/gravar
Para habilitar as preferências de leitura/gravação na sua string de conexão, você pode usar a opção readPreference para preferência de leitura e a opção w para preocupação de gravação.
A string de conexão a seguir define as preferências de leitura e gravação. readPreference=secondary especifica que as operações de leitura devem ser direcionadas aos membros secundários do conjunto de réplicas e w=majority assegura que as operações de gravar sejam confirmadas pela maioria dos membros do conjunto de réplicas.
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db4.example.com/database?readPreference=secondary&w=majority
Nós de analítica
Para especificar um tipo de nó analytics na sua string de conexão:
Configure seu
readPreferenceparasecondarypara indicar que as operações de leitura devem ser direcionadas aos nós secundários.Defina
readPreferenceTagsparanodeType:ANALYTICSpara garantir que as operações de leitura sejam direcionadas especificamente para os nós de analítica.
A string de conexão a seguir demonstra como especificar um tipo de nó analytics em sua string de conexão:
mongodb+srv://myDatabaseUser:D1fficultP%40ssw0rd@db5.example.com/myDatabase?readPreference=secondary&readPreferenceTags=nodeType:ANALYTICS
Para obter mais informações sobre como usar nós de análise para isolar cargas de trabalho, consulte Query usando tags predefinidas do conjunto de réplicas.