Opções de conexão
Visão geral
Neste guia, você aprenderá sobre as opções de conexão e autenticação do MongoDB. Você pode definir opções de conexão como parâmetros de sua string de conexão para especificar como sua instância do Client
se comporta enquanto conectada ao servidor.
Nome da opção | Valores aceitos | Valor padrão | Descrição |
---|---|---|---|
appName | String | none | Specifies the application name that the Client instance sends
to the server as part of the handshake.Specifying an appName can help you use the server logs to
determine which Client instance is connected to the server. |
authMechanism | String | none | Especifica qual mecanismo de autenticação usar. Se você não especificar esta opção, o driver utilizará o mecanismo de autenticação padrão. Para saber mais sobre autenticação no driver Rust, consulte o guia sobre Mecanismos de autenticação. |
authMechanismProperties | String | none | Especifica mais propriedades para o mecanismo de autenticação definido na opção authMechanism . |
authSource | String | Veja a descrição | Specifies the database used to authenticate. This option defaults to admin for SCRAM-based authentication mechanisms,
$external for the MONGODB-X509 mechanism, and the database name or
$external for the PLAIN mechanism. |
compressors | Uma lista de strings separadas por vírgula | none | Especifica os compressores que a instância Client utiliza na ordem especificada. Para saber mais sobre a compactação de rede, consulte o guia Compressão de rede . |
connectTimeoutMS | Non-negative integer | 10000 (10 segundos) | Especifica o tempo limite de conexão, em milissegundos, passado para cada fluxo TCP subjacente ao tentar se conectar ao servidor. |
directConnection | Boolean | false | Especifica se a instância do Client se conecta diretamente a um único host em vez de descobrir e se conectar a todos os servidores no cluster. |
heartbeatFrequencyMS | inteiro maior ou igual a 500 | 10000 (10 segundos) | Especifica a quantidade de tempo, em milésimos de segundo, que cada thread de monitoramento aguarda entre as verificações do servidor. |
journal | Boolean | false | Solicita confirmação de que a operação foi propagada para o diário em disco. |
localThresholdMS | Non-negative integer | 15 | Specifies the amount of time in milliseconds that the average
round-trip time between the driver and server can last
compared to the shortest round-trip time of all the suitable servers. A value of 0 indicates that there is no latency window, so
only the server with the lowest average round-trip time is
eligible. |
maxIdleTimeMS | Non-negative integer | 0 | Specifies the amount of time in milliseconds that a connection
can remain idle in a connection pool the server closes it. A value of 0 indicates that the client does not close idle
connections. |
maxStalenessSeconds | -1 , ou qualquer número inteiro maior ou igual a 90 | -1 | Specifies the maximum lag, in seconds, behind the primary node
that a secondary node can be to be considered for the given operation. The value of this option must be at least 90 , or the
operation raises an error. A value of -1 means there is no
maximum lag. |
maxPoolSize | Non-negative integer | 10 | Specifies the maximum number of connections that the Client
instance can create in a connection pool for a given server.If you attempt an operation while the value of maxPoolSize
connections are checked out, the operation waits until an
in-progress operation finishes and the connection returns to the pool. |
minPoolSize | Non-negative integer | 0 | Specifies the minimum number of connections that are available in
a server's connection pool at a given time. If fewer than minPoolSize connections are in the pool,
the server adds connections in the background up to the value of minPoolSize . |
readConcernLevel | String | none | Especifica a read concern padrão para operações realizadas na instância do Client . Para saber mais, consulte Read Concern no manual do servidor MongoDB. |
readPreference | String | primary | Especifica como o driver roteia uma operação de leitura para membros de um conjunto de réplica. Para saber mais, consulte Preferência de leitura no manual do servidor MongoDB. |
readPreferenceTags | Uma lista de pares de valores-chave separados por vírgula | none | Especifica quais membros do conjunto de réplicas são considerados para operações. Cada instância desta chave é um conjunto de tags separado. O driver verifica cada conjunto de tags até encontrar um ou mais servidores com cada tag no conjunto. |
replicaSet | String | none | Especifica o nome do conjunto de réplicas ao qual a instância Client se conecta. |
retryReads | Boolean | true | Especifica se o cliente tenta novamente uma operação de leitura se a operação falhar. |
serverSelectionTimeoutMS | Non-negative integer | 30000 (30 segundos) | Especifica a quantidade de tempo, em milésimos de segundo, que a instância Client aguarda ao tentar selecionar um servidor para uma operação antes de atingir o tempo limite. |
tls | Boolean | false | Especifica a configuração TLS para a instância do Client utilizar em suas conexões com o servidor. Por padrão, o TLS está desativado. |
tlsAllowInvalidCertificates | Boolean | false | Specifies whether the Client instance returns an error if the
server presents an invalid certificate.We recommend that you set this option to true only in
testing environments to avoid creating vulnerabilities in your
application. |
tlsCAFile | String | Veja a descrição | Specifies the path to the certificate authority (CA) file that
the Client instance uses for TLS.If you do not specify this option, the driver uses the Mozilla
root certificates from the webpki-roots crate. |
tlsCertificateKeyFile | String | none | Specifies the path to the certificate file that the Client
instance presents to the server to verify its identify.If you do not set this option, the Client instance does not
attempt to verify its identity to the server. |
tlsInsecure | Boolean | false | Specifies whether the Client instance returns an error if the
server presents an invalid certificate.We recommend that you set this option to true only in
testing environments to avoid creating vulnerabilities in your
application. |
w | inteiro ou string não negativo | none | Requests acknowledgment that the operation has propagated to a
specific number or variety of servers. To learn more, see Write Concern in the Server manual. |
wTimeoutMS | Non-negative integer | Sem tempo limite | Especifica um limite de tempo, em milésimos de segundo, para a referência de escrita. Se uma operação não tiver sido propagada para o nível solicitado dentro do limite de tempo, o driver gerará um erro. |
zlibCompressionLevel | Inteiro entre -1 e 9 (inclusive) | -1 | Specifies the level field of the zlib compression if you use that compressor.Setting a value of -1 selects the default compression level (6 ).Setting a value of 0 specifies no compression, and setting
a value of 9 specifies maximum compression.To learn more about network compression, see the Network Compression guide. |
Para ver uma lista completa de opções de conexão, visite a seção Opções de string de conexão da entrada manual do servidor MongoDB sobre Cadeias de conexão.