Opções de conexão
Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão do driver do Node.js.
Esta seção explica as opções de conexão e autenticação MongoDB suportadas pelo driver. Você pode passar as opções de conexão como parâmetros do URI de conexão para especificar o comportamento do cliente.
Nome | Valores aceitos | Valor padrão | Descrição |
|---|---|---|---|
appName | string | null | Especifica o nome do aplicativo que o driver passa para o servidor nos metadados do cliente como parte da confirmação de conexão. O driver envia o valor de appName para o MongoDB ao estabelecer a conexão. Esse valor é registrado no arquivo de registro, nos logs de query lentos e nas collections de perfil. |
authMechanism | string | null | Especifica o método do mecanismo de autenticação a ser usado para conexão com o servidor. Se você não especificar um valor, o driver utilizará o mecanismo padrão, SCRAM-SHA-1 ou SCRAM-SHA-256 dependendo da versão do servidor. Consulte mecanismo de autenticação para ver os mecanismos de autenticação disponíveis. |
authMechanismProperties | chave separada por vírgula:pares de valores, por exemplo, "opt1:val1,opt2:val2" | null | Especifica opções adicionais fornecidas para autenticação, como habilitar canonicalização de nome de host para GSSAPI. |
authSource | string | null | Especifica o banco de dados com o qual as conexões se autenticam. |
compressors | lista separada por vírgula de strings, por exemplo, "snappy,zlib,zstd" | null | Especifica os tipos de compactação permitidos para mensagens de protocolo de fio enviadas ou recebidas do servidor. Consulte Compressão de rede para mais informações. |
connectTimeoutMS | non-negative integer | 30000 | Especifica a quantidade de tempo, em milissegundos, para aguardar para estabelecer uma única conexão de soquete TCP com o servidor antes de gerar um erro. Especificar 0 desativa o tempo-limite de conexão. |
directConnection | booleano | false | Especifica se todas as operações devem ser forçadas a serem despachadas para o host especificado no URI de conexão. |
enableUtf8Validation | booleano | true | A especificação do A especificação de Você também pode definir a validação UTF-8 em seu código Node.js. Para saber mais sobre os caracteres UTF-8, consulte UTF-8 na Wikipedia. |
heartbeatFrequencyMS | inteiro maior ou igual a 500 | null | Especifica o intervalo, em milissegundos, entre verificações regulares de monitoramento do servidor. |
journal | booleano | null | Especifica o campo padrão de write concern "j" para o cliente. Consulte write concern para obter mais informações. |
loadBalanced | booleano | null | Especifica se o driver está se conectando a um balancer de carga. |
localThresholdMS | non-negative integer | 15 | Especifica o tamanho da janela de latência, em milissegundos, no tempo de viagem de ida e volta para selecionar entre os servidores adequados. Especificar 0 significa não esperar, ou seja, o servidor mais rápido disponível. |
maxIdleTimeMS | non-negative integer | 0 | Especifica a quantidade de tempo, em milissegundos, que uma conexão pode ficar ociosa antes de ser fechada. Especificar 0 significa que não há mínimo. |
maxPoolSize | non-negative integer | 100 | Especifica o número máximo de clientes ou conexões que o driver pode criar em seu repositório de conexões. Esta contagem inclui conexões em uso. |
maxConnecting | non-negative integer | 2 | Especifica o número máximo de conexões que um conjunto de conexões do driver pode estar estabelecendo simultaneamente. |
maxStalenessSeconds | -1, ou um número inteiro maior ou igual a 90 | null | Especifica o atraso máximo de replicação, em tempo de relógio de parede, que um secundário pode enfrentar e ainda ser qualificado para seleção de servidor. Especificar -1 significa que não há máximo. |
minPoolSize | non-negative integer | 0 | Especifica o número de conexões que o driver cria e mantém no repositório de conexões mesmo quando nenhuma operação está ocorrendo.Esta contagem inclui conexões em uso. |
proxyHost | string | null | Especifica o endereço IPv4/IPv6 ou nome de domínio de um servidor proxy SOCKS5 usado para se conectar aos serviços do MongoDB. |
proxyPort | non-negative integer | null | Especifica a porta do servidor proxy SOCKS5 especificado no proxyHost. |
proxyUsername | string | null | Especifica o nome de usuário para autenticação de nome de usuário/senha no servidor proxy SOCKS5 especificado em proxyHost. |
proxyPassword | string | null | Especifica a senha da autenticação de nome de usuário/senha para o servidor proxy SOCKS5 especificado em proxyHost. |
readConcernLevel | string | null | Especifica a preocupação de leitura padrão para o cliente. Consulte a página Preocupação de leitura para obter mais informações. |
readPreference | string | "primary" | Especifica a preferência de leitura padrão para o cliente (excluindo tags). Consulte preferência de leitura para obter mais informações. |
readPreferenceTags | chave separada por vírgula:pares de valores, por exemplo, "dc:ny,rack:1" e "dc:ny podem ser especificados várias vezes, cada instância desta chave é um conjunto de tags separado | null | Especifica as tags de preferência de leitura padrão para o cliente. Esta opção é válida somente se o modo de preferência de leitura não for primário. O condutor utiliza a ordem das etiquetas no URI como ordem para a preferência de leitura. |
replicaSet | string | null | Especifica o nome do conjunto de réplicas ao qual se conectar. |
retryReads | booleano | true | Permite leituras que podem ser repetidas. |
retryWrites | booleano | true | Habilita gravações que podem ser tentadas novamente. |
serverSelectionTimeoutMS | non-negative integer | 30000 | Especifica o tempo limite, em milissegundos, para bloquear a seleção do servidor antes de gerar um erro. |
serverSelectionTryOnce | booleano | true | Especifica a verificação da topologia apenas uma vez após uma falha de seleção de servidor, em vez de repetidamente até que a seleção do servidor atinja o tempo limite. |
socketTimeoutMS | non-negative integer | 0 | Especifica a quantidade de tempo, em milissegundos, gasto tentando enviar ou receber em um soquete antes do tempo-limite. Especificar 0 significa que não há tempo-limite. |
srvMaxHosts | non-negative integer | 0 | Especifica o número máximo de resultados SRV a serem selecionados aleatoriamente ao preencher inicialmente a lista de sementes ou, durante a sondagem SRV, adicionar novos hosts à topologia. |
srvServiceName | um nome de serviço SRV válido de acordo com RFC 6335 | "mongodb" | Especifica o nome do serviço a ser usado para a pesquisa de SRV na descoberta inicial da lista de sementes de DNS. |
ssl | booleano | false | O ssl é um alias para a opção tls. |
tls | booleano | false | Especifica se o TLS é necessário para conexões com o servidor. Usar um srvServiceName de "mongodb+srv" ou especificar outras opções prefixadas tls padronizará tls para true. |
tlsAllowInvalidCertificates | booleano | false | Especifica se o driver gera um erro quando o certificado TLS do servidor é inválido. Defina esta opção como true somente para fins de teste. |
tlsAllowInvalidHostnames | booleano | false | Especifica se o driver gera um erro quando há uma incompatibilidade entre o nome de host do servidor e o nome de host especificado pelo certificado TLS. Defina esta opção como true apenas para fins de teste. |
tlsCAFile | string | null | Especifica o caminho para um arquivo com uma única autoridade de certificação ou um pacote de autoridades de certificação em que se deve confiar ao fazer uma conexão TLS. |
tlsCertificateKeyFile | string | null | Especifica o caminho para o arquivo de certificado do cliente ou o arquivo de chave privada do cliente. Se você precisar de ambos, deverá concatenar os arquivos. |
tlsCertificateKeyFilePassword | string | null | Especifica a senha para descriptografar a chave privada do cliente a ser usada para conexões TLS. |
tlsInsecure | booleano | false | Especifica para relaxar as restrições de TLS o máximo possível, como permitir certificados inválidos ou incompatibilidades de nome de host. Defina esta opção como true somente para fins de teste. |
w | inteiro ou string não negativo | null | Especifica o campo padrão de write concern "w" para o cliente. |
waitQueueTimeoutMS | non-negative integer | 0 | Especifica o tempo, em milissegundos, gasto tentando verificar uma conexão do repositório de conexão de um servidor antes do tempo limite. |
wTimeoutMS | non-negative integer | null | Especifica o campo padrão de write concern "wtimeout" para o cliente. |
zlibCompressionLevel | inteiro entre -1 e 9 (inclusive) | -1 | Especifica o nível de compressão ao usar zlib para comprimir mensagens de protocolo de fio. -1 significa o nível padrão, 0 significa nenhuma compressão, 1 significa a velocidade mais rápida e 9 significa a melhor compressão. Consulte Compressão de rede para obter mais informações. |