An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)

Optionally enable in-use auto encryption

Remarks

Automatic encryption is an enterprise only feature that only applies to operations on a collection. Automatic encryption is not supported for operations on a database or view, and operations that are not bypassed will result in error (see libmongocrypt: Auto Encryption Allow-List). To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.

Automatic encryption requires the authenticated user to have the listCollections privilege action.

If a MongoClient with a limited connection pool size (i.e a non-zero maxPoolSize) is configured with AutoEncryptionOptions, a separate internal MongoClient is created if any of the following are true:

• AutoEncryptionOptions.keyVaultClient is not passed.
• AutoEncryptionOptions.bypassAutomaticEncryption is false.

If an internal MongoClient is created, it is configured with the same options as the parent MongoClient except minPoolSize is set to 0 and AutoEncryptionOptions is omitted.

Optionally override the trusted CA certificates. Default is to trust the well-known CAs curated by Mozilla. Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.

Cert chains in PEM format. One cert chain should be provided per private key. Each cert chain should consist of the PEM formatted certificate for a provided private key, followed by the PEM formatted intermediate certificates (if any), in order, and not including the root CA (the root CA must be pre-known to the peer, see ca). When providing multiple cert chains, they do not have to be in the same order as their private keys in key. If the intermediate certificates are not provided, the peer will not be able to validate the certificate, and the handshake will fail.

Cipher suite specification, replacing the default. For more information, see modifying the default cipher suite. Permitted ciphers can be obtained via tls.getCiphers(). Cipher names must be uppercased in order for OpenSSL to accept them.

The time in milliseconds to attempt a connection before timing out.

PEM formatted CRLs (Certificate Revocation Lists).

Allow a driver to force a Single topology type with a connection string containing one host

Allows a wrapping driver to amend the client metadata generated by the driver to include information about the wrapping driver

A string describing a named curve or a colon separated list of curve NIDs or names, for example P-521:P-384:P-256, to use for ECDH key agreement. Set to auto to select the curve automatically. Use crypto.getCurves() to obtain a list of available curve names. On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. Default: tls.DEFAULT_ECDH_CURVE.

Force server to assign _id values instead of driver

heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.

Deprecated

TCP Connection keep alive enabled. Will not be able to turn off in the future.

Deprecated

The number of milliseconds to wait before initiating keepAlive on the TCP socket. Will not be configurable in the future.

Private keys in PEM format. PEM allows the option of private keys being encrypted. Encrypted keys will be decrypted with options.passphrase. Multiple keys using different algorithms can be provided either as an array of unencrypted key strings or buffers, or an array of objects in the form {pem: <string|buffer>[, passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

The size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.

The maximum number of connections that may be in the process of being established concurrently by the connection pool.

The maximum number of milliseconds that a connection can remain idle in the pool before being removed and closed.

The maximum number of connections in the connection pool.

Sets the minimum heartbeat frequency. In the event that the driver has to frequently re-check a server's availability, it will wait at least this long since the previous check to avoid wasted effort.

The minimum number of connections in the connection pool.

Enable command monitoring for this client

TCP Connection no delay

Shared passphrase used for a single private key and/or a PFX.

PFX or PKCS12 encoded private key and certificate chain. pfx is an alternative to providing key and cert individually. PFX is usually encrypted, if it is, passphrase will be used to decrypt it. Multiple PFX can be provided either as an array of unencrypted PFX buffers, or an array of objects in the form {buf: <string|buffer>[, passphrase: ]}. The object form can only occur in an array. object.passphrase is optional. Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.

A primary key factory function for generation of custom _id keys

Enabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API. See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context. If you need to maintain your own editable clone of the bytes returned for an extended life time of the process, it is recommended you allocate your own buffer and clone the contents:

Example

const raw = await collection.findOne({}, { raw: true });
const myBuffer = Buffer.alloc(raw.byteLength);
myBuffer.set(raw, 0);
// Only save and use `myBuffer` beyond this point
Copy

Remarks

Please note there is a known limitation where this option cannot be used at the MongoClient level (see NODE-3946). It does correctly work at Db, Collection, and per operation the same as other BSON options work.

If true the server will reject any connection which is not authorized with the list of supplied CAs. This option only has an effect if requestCert is true.

Default

true
Copy

Specifies the name of the replica set, if the mongod is a member of a replica set.

Enables retryable reads.

Enable retryable writes.

An optional TLS context object from tls.createSecureContext()

Legacy mechanism to select the TLS protocol version to use, it does not support independent control of the minimum and maximum version, and does not support limiting the protocol to TLSv1.3. Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. For example, use 'TLSv1_1_method' to force TLS version 1.1, or 'TLS_method' to allow any TLS protocol version up to TLSv1.3. It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.

Specifies how long (in milliseconds) to block for server selection before throwing an exception.

An optional Buffer instance containing a TLS session.

The time in milliseconds to attempt a send or receive on a socket before the attempt times out.

The maximum number of hosts to connect to when using an srv connection string, a setting of 0 means unlimited hosts

Modifies the srv URI to look like:

_{srvServiceName}._tcp.{hostname}.{domainname}

Querying this DNS URI is expected to respond with SRV records

Bypasses validation of the certificates presented by the mongod/mongos instance

Disables hostname validation of the certificate presented by the mongod/mongos instance.

Disables various certificate validations.

The maximum time in milliseconds that a thread can wait for a connection to become available.

An integer that specifies the compression level if using zlib for network compression.