Opções de conexão

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 da opção	Tipo	Descrição
minPoolSize	inteiro	Especifica o número mínimo de conexões que devem existir a qualquer momento em um único pool de conexões. Default: `0`
maxPoolSize	inteiro	Define o limite máximo de conexões que um pool de conexões pode ter em um determinado momento. Default: `100`
waitQueueTimeoutMS	inteiro	Especifica a quantidade máxima de tempo, em milissegundos que uma conversa pode esperar que uma conexão se torne disponível. Default: `120000` (120 seconds)
serverSelectionTimeoutMS	inteiro	Especifica a quantidade máxima de tempo, em milissegundos, o driver esperará o sucesso da seleção do servidor antes de lançar uma exceção. Default: `30000` (30 seconds)
localThresholdMS	inteiro	Ao se comunicar com várias instâncias do MongoDB em um conjunto de réplicas, o driver só enviará solicitações para um servidor cujo tempo de resposta seja menor ou igual ao servidor com o tempo de resposta mais rápido mais o limite local, em milissegundos. Default: `15`
heartbeatFrequencyMS	inteiro	Especifica a frequência, em milissegundos que o driver esperará entre as tentativas de determinar o estado atual de cada servidor no cluster. Default: `10000` (10 seconds)
replicaSet	string	Especifica que astring de conexão do fornecida inclui múltiplos hosts. Quando especificado, o driver tenta encontrar todos os membros desse conjunto. Default: `null`
ssl	booleano	Especifica que toda comunicação com instâncias MongoDB deve usar TLS/SSL. Substituído pela opção tls . Default: `false`
tls	booleano	Especifica que toda comunicação com instâncias MongoDB deve usar TLS. Suplanta a opção ssl. Default: `false`
tlsInsecure	booleano	Especifica que o driver deve permitir nomes de host inválidos para conexões TLS. Tem o mesmo efeito que configurar tlsAllowInvalidHostnames para `true`. Para configurar restrições de segurança TLS de outras formas, use um SSLContext personalizado. Default: `false`
tlsAllowInvalidHostnames	booleano	Especifica que o driver deve permitir nomes de host inválidos no certificado para conexões TLS. Suplanta sslInvalidHostNameAllowed. Default: `false`
connectTimeoutMS	inteiro	Especifica o tempo máximo, em milésimos de segundo, que o driver Java aguarda a abertura de uma conexão antes de atingir o tempo-limite. Um valor de `0` instrui o driver a nunca atingir o tempo-limite enquanto espera a abertura de uma conexão. Default: `10000` (10 seconds)
socketTimeoutMS	inteiro	Especifica a quantidade máxima de tempo, em milissegundos, que o driver Java aguardará para enviar ou receber uma solicitação antes de atingir o tempo limite. Um valor de `0` instrui o driver a nunca expirar enquanto aguarda para enviar ou receber uma solicitação. Default: `0`
maxIdleTimeMS	inteiro	Especifica a quantidade máxima de tempo, em milissegundos, que o driver permite que uma conexão agrupada fique ociosa antes de fechar a conexão. Um valor de `0` indica que não há limite superior de quanto tempo o driver permite que uma conexão agrupada fique inativa. Default: `0`
maxLifeTimeMS	inteiro	Especifica a quantidade máxima de tempo, em milissegundos, o driver Java continuará usando uma pool de conexão antes de fechar a conexão. Um valor de `0` indica que não há limite superior de quanto tempo o driver pode manter uma pool de conexão aberta. Default: `0`
journal	booleano	Especifica que o driver deve aguardar que a instância do MongoDB conectada faça o commit em grupo no arquivo de diário no disco para todas as gravações. Default: `false`
w	string ou inteiro	Especifica a write concern. Para obter mais informações sobre valores, consulte a documentação do servidor para a opção w. Default: `1`
WTimeoutMS	inteiro	Especifica um limite de tempo, em milésimos de segundo, para o write concern. Para obter mais informações, consulte a documentação do servidor para a opção wtimeoutMS. Um valor de `0` instrui o driver a nunca esgotar as operações de gravação. Default: `0`
readPreference	string	Especifica a read preference. Para obter mais informações sobre valores, consulte a documentação do servidor para a opção readPreference. Default: `primary`
readPreferenceTags	string	Especifica as marcações de read preference. Para obter mais informações sobre valores, consulte a documentação do servidor para a opção readPreferenceTags. Default: `null`
maxStalenessSeconds	inteiro	Especifica, em segundos, o quão obsoleto um secundário pode ficar antes que o driver pare de se comunicar com esse secundário. O valor mínimo é 90 segundos ou a frequência de pulsação mais 10 segundos, o que for maior. Para obter mais informações, consulte a documentação do servidor para a opção maxStalenessSeconds. Não fornecer um parâmetro ou especificar explicitamente `-1` indica que não deve haver verificação de obsolescência para secundários. Default: `-1`
authMechanism	string	Especifica o mecanismo de autenticação que o driver usa se uma credencial foi fornecida. Default: By default, the client picks the most secure mechanism available based on the server version. For possible values, see the server documentation for the authMechanism option.
authSource	string	Especifica o banco de dados no qual as credenciais fornecidas são validadas. Default: `admin`
authMechanismProperties	string	Especifica as propriedades de autenticação para o mecanismo de autenticação especificado como uma lista de propriedades e valores separados por dois pontos. Para obter mais informações, consulte a documentação do servidor para a opção authMechanismProperties. Default: `null`
appName	string	Especifica o nome do aplicativo fornecido às instâncias MongoDB durante o handshake de conexão. Pode ser usado para registros e perfis do servidor. Default: `null`
compressors	string	Especifica um ou mais algoritmos de compressão que o driver tentará usar para compactar as solicitações enviadas à instância conectada do MongoDB. Os valores possíveis incluem: `zlib`, `snappy` e `zstd`. Default: `null`
zlibCompressionLevel	inteiro	Especifica o grau de compressão que o Zlib utiliza para diminuir o tamanho das solicitações para a instância MongoDB conectada. O nível pode variar de `-1` a `9`, com valores mais baixos sendo compactados mais rapidamente (mas resultando em solicitações maiores) e valores maiores compactando mais lentamente (mas resultando em solicitações menores). Default: `null`
retryWrites	booleano	Especifica que o driver deve repetir as operações de gravação com suporte se elas não puderem ser concluídas devido a um erro de rede. Default: `true`
retryReads	booleano	Especifica que o driver deve repetir as operações de leitura com suporte se não for possível concluir devido a um erro de rede. Default: `true`
serverMonitoringMode	string	Especifica qual protocolo de monitoramento de servidor o driver usa. Quando definido como `auto`, o modo de monitoramento é determinado pelo ambiente no qual o driver está sendo executado. O driver usa o modo `poll` em ambientes de função como serviço (FaaS) e o modo `stream` em outros ambientes. Default: `auto`
uuidRepresentação	string	Especifica a representação do UUID a ser usada nas operações de leitura e gravação. Para obter mais informações, consulte a documentação do driver para o método MongoClientSettings.getUuidRepresentation(). Default: `unspecified`
directConnection	booleano	Especifica que o driver deve se conectar diretamente ao host. Default: `false`
maxConnecting	inteiro	Especifica o número máximo de conexões que um pool pode estabelecer simultaneamente. Default: `2`
srvServiceName	string	Especifica o nome do serviço dos registros de recursos SRV que o driver recupera para construir sua lista de sementes. Você deve usar o formato de conexão da lista de sementes do DNS em seu URI de conexão para usar essa opção. Default: `mongodb`

Para obter uma lista completa de opções, consulte a documentação da API ConnectionString.

Voltar

Conecte-se ao MongoDB

Configurações do MongoClient