Opções de conexã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.

Padrão: 0

maxPoolSize

inteiro

Define o limite máximo de conexões que um pool de conexões pode ter em um determinado momento.

Padrão: 100

waitQueueTimeoutMS (obsoleto)

inteiro

Esta opção está obsoleta. Você pode configurar esse tempo limite definindo o tempo limite no nível do cliente.

Tempo máximo de espera, em milissegundos, que uma operação pode esperar que uma conexão fique disponível. Um valor de 0 significa que não há limite.

Padrão: 120000 (120 segundos)

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.

Padrão: 30000 (30 segundos)

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.

Padrão: 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.

Padrão: 10000 (10 segundos)

replicaSet

string

Especifica que a connection string fornecida inclui vários hosts. Quando especificado, o driver tenta encontrar todos os membros desse conjunto.

Padrão: null

ssl

booleano

Especifica que toda comunicação com instâncias MongoDB deve usar TLS/SSL. Substituído pela opção tls .

Padrão: false

tls

booleano

Especifica que toda comunicação com instâncias MongoDB deve usar TLS. Suplanta a opção SSL .

Padrão: false

tlsInsecure

booleano

Especifica que o driver deve permitir nomes de host inválidos para conexões TLS. Tem o mesmo efeito que definir tlsAllowInvalidHostnames para true. Para configurar restrições de segurança TLS de outras formas, use um SSLContext personalizado.

Padrão: false

tlsAllowInvalidHostnames

booleano

Especifica que o driver deve permitir nomes de host inválidos no certificado para conexões TLS. Suplanta sslInvalidHostNameAllowed.

Padrão: false

connectTimeoutMS

inteiro

Especifica o tempo máximo, em milésimos de segundo, que o driver Kotlin 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.

Padrão: 10000 (10 segundos)

socketTimeoutMS (obsoleto)

inteiro

Esta opção está obsoleta. Você pode configurar esse tempo limite definindo o tempo limite no nível do cliente.

Quantidade máxima de tempo, em milissegundos, o driver Kotlin 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.

Padrão: 0

maxIdleTimeMS

inteiro

Especifica a quantidade máxima de tempo em milésimos de segundo que o driver permite que uma conexão em pool 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.

Defina esse valor como maior que o período ocioso esperado do seu aplicativo, mas menor que o tempo limite de conexão do firewall ou do proxy para evitar desconexões inesperadas.

Padrão: 0

maxLifeTimeMS

inteiro

Especifica a quantidade máxima de tempo, em milissegundos, o driver Kotlin 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.

Padrão: 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.

Padrão: false

w

string ou inteiro

Specifies the write concern. For more information on values, see the server documentation for the w option.

Padrão: 1

WTimeoutMS (obsoleto)

inteiro

Esta opção está obsoleta. Você pode configurar esse tempo limite definindo o tempo limite no nível do cliente.

Time limit, in milliseconds, for the write concern. For more information, see the server documentation for the wtimeoutMS option. A value of 0 instructs the driver to never time out write operations.

Padrão: 0

readPreference

string

Specifies the read preference. For more information on values, see the server documentation for the readPreference option.

Padrão: primary

readPreferenceTags

string

Specifies the read preference tags. For more information on values, see the server documentation for the readPreferenceTags option.

Padrão: null

maxStalenessSeconds

inteiro

Specifies, in seconds, how stale a secondary can be before the driver stops communicating with that secondary. The minimum value is either 90 seconds or the heartbeat frequency plus 10 seconds, whichever is greater. For more information, see the server documentation for the maxStalenessSeconds option. Not providing a parameter or explicitly specifying -1 indicates that there should be no staleness check for secondaries.

Padrão: -1

authMechanism

string

Especifica o mecanismo de autenticação que o driver deve usar 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 reconhecimento de data center em que as credenciais fornecidas devem ser validadas.

Padrão: 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.

Padrão: 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.

Padrão: 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.

Padrão: null

zlibCompressionLevel

inteiro

Especifica o grau de compressão que zlib deve utilizar 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).

Padrão: null

retryWrites

booleano

Especifica que o driver deve repetir as operações de gravação com suporte se elas falharem devido a um erro de rede.

Padrão: true

retryReads

booleano

Especifica que o driver deve repetir as operações de leitura com suporte se elas falharem devido a um erro de rede.

Padrão: true

maxAdaptiveRetries

inteiro

Define o número máximo de vezes que o driver tenta novamente um comando que falha com um erro de sobrecarga repetível (ou seja, um erro que carrega os rótulos SystemOverloadedError e RetryableError).

Esta opção se aplica a comandos de escrita somente quando retryWrites está configurado para true e comandos de leitura somente quando retryReads está configurado para true. Definir o valor como 0 desativa as tentativas de repetição para erros de sobrecarga repetíveis.

Default: null. When this option is not set, the driver typically applies the value 2.

enableOverloadRetargeting

booleano

Define se o driver pode despriorizar os servidores durante a seleção do servidor para tentativas subsequentes se eles tiverem retornado erros de sobrecarga anteriormente.

Essa opção se aplica a leituras quando retryReads está definido como true e a gravações quando retryWrites está definido como true. Esta opção não se aplica a clusters fragmentados.

Padrão: false

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.

Padrão: 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().

Padrão: unspecified

directConnection

booleano

Especifica que o driver deve se conectar diretamente ao host.

Padrão: false

maxConnecting

inteiro

Especifica o número máximo de conexões que um pool pode estabelecer simultaneamente.

Padrão: 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.

Padrão: mongodb

srvAllowedHostsSuffix

string

Specifies the domain suffix that the driver uses to validate the host names returned by the SRV record lookup. When you set this option, the driver validates host names against the specified suffix instead of the domain inferred from the SRV host name. If the value doesn't begin with a period (.), the driver adds one. You can use this option only with the mongodb+srv connection string format.

Default: null. The driver validates host names against the domain inferred from the SRV host name.