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.

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

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

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.

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

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.

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

Enables retryable reads.

Enable retryable writes.

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

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.