Connection Options

integer

Specifies the minimum number of connections that must exist at any moment in a single connection pool.

integer

Specifies the maximum number of connections that a connection pool can have at a given time.

integer

Specifies the maximum amount of time, in milliseconds that a thread can wait for a connection to become available.

integer

Specifies the maximum amount of time, in milliseconds, the driver will wait for server selection to succeed before throwing an exception.

integer

When communicating with multiple instances of MongoDB in a replica set, the driver will only send requests to a server whose response time is less than or equal to the server with the fastest response time plus the local threshold, in milliseconds.

integer

Specifies the frequency, in milliseconds that the driver will wait between attempts to determine the current state of each server in the cluster.

string

Specifies that the connection string provided includes multiple hosts. When specified, the driver attempts to find all members of that set.

boolean

Specifies that all communication with MongoDB instances must use TLS/SSL. Superseded by the tls option.

boolean

Specifies that all communication with MongoDB instances must use TLS. Supersedes the ssl option.

boolean

Specifies that the driver must allow invalid hostnames for TLS connections. Has the same effect as setting tlsAllowInvalidHostnames to true. To configure TLS security constraints in other ways, use a custom SSLContext.

boolean

Specifies that the driver must allow invalid hostnames in the certificate for TLS connections. Supersedes sslInvalidHostNameAllowed.

integer

Specifies the maximum amount of time, in milliseconds, the Java driver waits for a connection to open before timing out. A value of 0 instructs the driver to never time out while waiting for a connection to open.

integer

Specifies the maximum amount of time, in milliseconds, the Java driver will wait to send or receive a request before timing out. A value of 0 instructs the driver to never time out while waiting to send or receive a request.

integer

Specifies the maximum amount of time, in milliseconds, that the driver allows a pooled connection to idle before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver allows a pooled connection to be idle.

integer

Specifies the maximum amount of time, in milliseconds, the Java driver will continue to use a pooled connection before closing the connection. A value of 0 indicates that there is no upper bound on how long the driver can keep a pooled connection open.

boolean

Specifies that the driver must wait for the connected MongoDB instance to group commit to the journal file on disk for all writes.

string or integer

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

integer

Specifies a 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.

string

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

string

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

integer

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 must be no staleness check for secondaries.

string

Specifies the authentication mechanism that the driver uses if a credential was supplied.

string

Specifies the database in which the supplied credentials are validated.

string

Specifies authentication properties for the specified authentication mechanism as a list of colon-separated properties and values. For more information, see the server documentation for the authMechanismProperties option.

string

Specifies the name of the application provided to MongoDB instances during the connection handshake. Can be used for server logs and profiling.

string

Specifies one or more compression algorithms that the driver will attempt to use to compress requests sent to the connected MongoDB instance. Possible values include: zlib, snappy, and zstd.

integer

Specifies the degree of compression that Zlib uses to decrease the size of requests to the connected MongoDB instance. The level can range from -1 to 9, with lower values compressing faster (but resulting in larger requests) and larger values compressing slower (but resulting in smaller requests).

boolean

Specifies that the driver must retry supported write operations if they are unable to complete due to a network error.

boolean

Specifies that the driver must retry supported read operations if they are unable to complete due to a network error.

string

Specifies which server monitoring protocol the driver uses. When set to auto, the monitoring mode is determined by the environment in which the driver is running. The driver uses poll mode in function-as-a-service (FaaS) environments and stream mode in other environments.

string

Specifies the UUID representation to use for read and write operations. For more information, see the driver documentation for the MongoClientSettings.getUuidRepresentation() method.

boolean

Specifies that the driver must connect to the host directly.

integer

Specifies the maximum number of connections a pool can establish concurrently.

string

Specifies the service name of the SRV resource records the driver retrieves to construct your seed list. You must use the DNS Seed List Connection Format in your connection URI to use this option.