Esta página lista todas as opções de conexão para se conectar ao seu banco de dados usando connection strings SRV e connection strings padrões.
As opções de conexão são pares no seguinte formulário: name=value.
A opção
namediferencia maiúsculas de minúsculas ao utilizar um condutor.A opção
namediferencia maiúsculas de minúsculas ao utilizar omongosh.O(A)
valuesempre diferencia maiúsculas de minúsculas.
Separar as opções com o caractere ampersand (&) name1=value1&name2=value2. No exemplo a seguir, uma conexão inclui as opções replicaSet e connectTimeoutMS:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db1.example.net:27017,db2.example.net:2500/?replicaSet=test&connectTimeoutMS=300000
Observação
Separador de ponto e vírgula para argumentos de connection string
Para oferecer compatibilidade com versões anteriores, atualmente, os drivers aceitam ponto e vírgula (;) como separadores de opções.
Opção de conjunto de réplica
A seguinte cadeia de caracteres de conexão conecta a um conjunto de réplica denominado myRepl com membros executando nos hosts especificados. Ele autentica como usuário myDatabaseUser com a senha D1fficultP%40ssw0rd:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com:27017,db1.example.com:27017,db2.example.com:27017/?replicaSet=myRepl
Opção de conexão | Descrição |
|---|---|
Especifica o nome doconjunto de réplicas do , se o Ao conectar a um conjunto de réplicas, forneça uma lista de seeds dos membros do conjunto de réplicas para o componente | |
Especifica se o cliente se conecta diretamente ao
IMPORTANTE: quando um conjunto de réplicas é executado no Docker, ele pode expor apenas um endpoint do MongoDB . Nesse caso, o conjunto de réplicas não é detectável e a especificação de Em um ambiente de teste ou desenvolvimento, você pode se conectar ao conjunto de réplicas especificando |
Opções de conexão
Opções de TLS
A seguinte string de conexão com um conjunto de réplicas inclui a opção tls=true. Ela autentica como usuário myDatabaseUser com a senha D1fficultP%40ssw0rd.
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&tls=true
Além disso, você também pode utilizar a opção ssl=true equivalente:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&ssl=true
Opção de conexão | Descrição |
|---|---|
Habilita ou desabilita TLS/SSL para a conexão:
A opção Se o shell do | |
Um booleano para ativar ou desativar TLS/SSL para a conexão:
A opção Se o shell do | |
Especifica o local de um arquivo O cliente apresenta este arquivo para a instância O Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. Esta opção de connection string não está disponível para o shell | |
Especifica a Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. Esta opção de connection string não está disponível para o shell | |
Especifica o local de um arquivo de Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. Esta opção de connection string não está disponível para o shell | |
Ignora a validação dos certificados apresentados pela instância Defina como Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. Esta opção de connection string não está disponível para o shell AVISO: a desativação da validação do certificado cria uma vulnerabilidade. | |
Desativa a validação do nome de host do certificado apresentado pela instância Configure para Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. Esta opção de connection string não está disponível para o shell AVISO: a desativação da validação do certificado cria uma vulnerabilidade. | |
Desabilita várias validações de certificado. Configurar para Esta opção de connection string não está disponível para o shell AVISO: a desativação da validação do certificado cria uma vulnerabilidade. |
Opções de tempo limite
Opção de conexão | Descrição |
|---|---|
O tempo em milissegundos para tentar uma conexão antes de atingir o tempo limite. O padrão é 10,000 milissegundos, mas drivers específicos podem ter outro padrão. Para obter detalhes, consulte a documentação do driver. | |
O tempo em milissegundos para tentar enviar ou receber em um soquete antes que a tentativa expire. O padrão é nunca atingir o tempo limite, embora drivers diferentes possam variar. Consulte a documentação do driver. |
Opções de compressão
Opção de conexão | Descrição | ||||||||
|---|---|---|---|---|---|---|---|---|---|
String delimitada por vírgula de compressores para habilitar a compressão de rede para comunicação entre este cliente e uma instância Você pode especificar os seguintes compressores: Se você especificar vários compressores, a ordem na qual você lista os compressores importam, bem como o iniciador de comunicação. Por exemplo, se o cliente especificar os seguintes compressores de rede As mensagens são compactadas quando ambas as partes habilitam a compactação de rede. Caso contrário, as mensagens entre as partes serão descompactadas. Se as partes não compartilharem pelo menos um compressor comum, as mensagens entre as partes serão descompactadas.
| |||||||||
Um número inteiro que especifica o nível de compressão se utilizar zlib Você pode especificar um valor inteiro na faixa entre
Compatível com o |
Opções do pool de conexões
A maioria dos drivers implementa algum tipo de tratamento de pool de conexões. Alguns drivers não oferecem suporte a pool de conexões. Consulte a documentação do driver para obter mais informações sobre a implantação do pool de conexões. Essas opções permitem que os aplicativos configurem o pool de conexão ao se conectar à implantação do MongoDB.
Opção de conexão | Descrição |
|---|---|
O número máximo de conexões no pool de conexões. O valor padrão é | |
O número mínimo de conexões no pool de conexões. O valor padrão é A opção não é suportada por todos os | |
Número máximo de conexões que um pool pode estabelecer simultaneamente. O valor padrão é
Aumentar o valor de | |
O número máximo de milissegundos que uma conexão pode permanecer inativa no pool antes de ser removida e fechada. Esta opção não é suportada por todos os drivers. | |
Um número ao qual o driver multiplica o Esta opção não é suportada por todos os drivers. | |
O tempo máximo em milissegundos que uma thread pode esperar até que uma conexão fique disponível. Para valores padrão, consulte a documentação do driver. Esta opção não é suportada por todos os drivers. |
Opções de write concern
A write concern descreve o nível de confirmação solicitado ao MongoDB. A opção write concern é suportada por:
MongoDB Drivers
Você pode especificar o write concern na connection string e como um parâmetro para métodos como insert ou update. Se o write concern for especificado em ambos os locais, o método parâmetro substituirá a connection string de configuração.
As connection strings de implantação do MongoDB Atlas usam "majority" por padrão. Se você não especificar o write concern para uma implantação do MongoDB Atlas, o MongoDB Atlas imporá"majority".
A string de conexão a seguir para um conjunto de réplicas especifica a preocupação de gravação de "majority" e um tempo limite de 5 segundos usando o parâmetro de preocupação de gravação wtimeoutMS:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&w=majority&wtimeoutMS=5000
Opção de conexão | Descrição |
|---|---|
Corresponde à opção de Você pode especificar um Para obter detalhes, consulte Opção | |
Corresponde à preocupação de gravação Quando | |
Corresponde à Se você definir |
Para obter mais informações, consulte Preocupação de gravação.
readConcern Options
Para o mecanismo de armazenamento WiredTiger, o MongoDB introduz a opção readConcern para conjuntos de réplicas e fragmentos de conjuntos de réplicas.
Ler Preocupação permite que os clientes escolham um nível de isolamento para suas leituras a partir de conjuntos de réplica.
A seguinte string de conexão para um conjunto de réplica especifica readConcernLevel=majority:
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&readConcernLevel=majority
Opção de conexão | Descrição |
|---|---|
O nível de isolamento. Pode aceitar um dos seguintes valores: Esta opção de cadeia de conexão não está disponível para |
Para obter mais informações, consulte Preocupação de leitura.
Opções de read preference
Read preferences descrevem o comportamento das operações de leitura em relação aos conjuntos de réplicas. Esses parâmetros permitem que você especifique preferências de leitura por conexão na connection string.
Por exemplo:
A seguinte string de conexão para um conjunto de réplica especifica o modo de preferência de leitura do
secondarye um valor demaxStalenessSecondsde 120 segundos:mongodb://myDatabaseUser:D1fficultP%40ssw0rd@db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&readPreference=secondary&maxStalenessSeconds=120 A seguinte string de conexão para um cluster fragmentado especifica o modo de preferência de leitura do
secondarye um valor demaxStalenessSecondsde 120 segundos:mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongos1.example.com,mongos2.example.com/?readPreference=secondary&maxStalenessSeconds=120 A string de conexão a seguir para um cluster fragmentado especifica o modo de preferência de leitura
secondary, bem como trêsreadPreferenceTags:mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongos1.example.com,mongos2.example.com/?readPreference=secondary&readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=dc:ny&readPreferenceTags=
A ordem é importante ao usar vários readPreferenceTags. Os readPreferenceTags são testados em ordem até que uma correspondência seja encontrada. Uma vez encontrada, essa especificação é usada para encontrar todos os membros correspondentes elegíveis e quaisquer readPreferenceTags restantes são ignorados. Para obter detalhes, consulte Ordem de correspondência de tags.
Opção de conexão | Descrição |
|---|---|
Especifica as preferências de leitura para esta conexão. Os valores possíveis são: Transações distribuídas que contêm operações de leitura devem usar a read preference Esta opção de string de conexão não está disponível para a shell | |
Especifica, em segundos, o quão obsoleto um secundário pode ser antes de o cliente parar de usá-lo para operações de leitura. Para detalhes, consulte Preferência de leitura Por padrão, não há desatualização máxima e os clientes não consideram o atraso do secundário ao escolher para onde direcionar uma operação de leitura. O | |
Especifica o documento de tags como uma lista separada por vírgula de pares de valores-chave separados por dois pontos. Por exemplo,
Para especificar uma lista de documentos de tags, use vários A ordem é importante ao usar vários Esta opção de string de conexão não está disponível para a shell |
Para mais informações, consulte Preferências de leitura.
Opções de autenticação
A string de conexão a seguir para um conjunto de réplicas especifica o authSource para o banco de dados admin. Ou seja, as credenciais do usuário são autenticadas no banco de dados admin.
mongodb://myDatabaseUser:D1fficultP%40ssw0rd@mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/?replicaSet=myRepl&authSource=admin
Se o nome de usuário ou senha incluir os seguintes caracteres, esses caracteres deverão ser convertidos usando codificação percentual:
$ : / ? # [ ] @
Opção de conexão | Descrição |
|---|---|
Especifique o nome do banco de dados associado às credenciais do usuário. Se Os mecanismos de autenticação O MongoDB ignora os valores se nenhum nome de usuário for fornecido, seja na string de conexão ou por meio | |
Especifique o mecanismo de autenticação que o MongoDB usa para autenticar a conexão. Se você não especificar um
Somente instâncias do MongoDB Enterprise Para usar o Para usar Se o ID da chave de acesso da AWS, a chave de acesso secreta ou o token de sessão estiverem definidos em sua plataforma usando suas respectivas variáveis de ambiente da AWS IAM, usará esses valores de variável de ambiente para autenticar automaticamente. Você não precisa especificá-los na string de conexão. Existem outros métodos para fornecer credenciais da AWS, dependendo do seu ambiente de implementação e dos requisitos de Consulte Conectar-se a um Atlas cluster para obter exemplo de uso do Consulte Autenticação em implementações autogerenciadas para obter mais informações sobre o sistema de autenticação no MongoDB. Considere também Usar certificados X.509 para autenticar clientes em sistemas autogerenciados para obter mais informações sobre a autenticação x509. | |
Especifique propriedades para o especificado como uma lista separada por vírgula de pares de valores-chave separados por Os possíveis pares de chave-valor são:
| |
Defina o nome do serviço Kerberos ao conectar-se a instâncias Kerberized MongoDB. Esse valor deve corresponder ao nome do serviço definido nas instâncias do MongoDB às quais você está se conectando.
|
Seleção de servidor e opções de descoberta
O MongoDB fornece as seguintes opções para configurar como drivers do MongoDB e instâncias do mongos selecionam um servidor para o qual direcionar operações de leitura ou gravação.
Opção de conexão | Descrição |
|---|---|
O tamanho (em milissegundos) da janela de latência para selecionar entre várias instâncias MongoDB adequadas. Padrão: 15 milissegundos. Todos os drivers usam | |
Especifica por quanto tempo (em milissegundos) bloquear para seleção de servidor antes de lançar uma exceção. Padrão: 30.000 milissegundos. | |
Somente drivers de thread único. Quando o Drivers de threads múltiplas e | |
Padrão:
| |
Somente clientes de thread único. Controla com que frequência o cliente verifica o estado da conexão CPU com a implantação do MongoDB . Se você especificar um valor mais baixo, o cliente detectará os problemas de rede mais rapidamente, mas usará mais CPU. Padrão: 5 segundos. Esta opção não é compatível com todos os drivers. Consulte a documentação sobre os drivers. |
Configurações diversas
Opção de conexão | Descrição |
|---|---|
Especifique um nome de aplicativo personalizado. O nome do aplicativo aparece em:
A
| |
Habilite leituras repetíveis Os valores possíveis são:
| |
Habilite gravações repetíveis. Os valores possíveis são:
Os drivers do MongoDB tentam novamente a confirmação da transação e abortam as operações, independentemente do valor de | |
Os valores possíveis são:
Para saber qual é o padrão, consulte a documentação dos drivers do seu driver. Nem todos os motoristas suportam a | |
Especifica se o cliente está se conectando a um balanceador de carga. Esta opção é Você só poderá definir esta opção como
| |