An array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
Optionally enable client side auto encryption
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.
Verifies the certificate cert is issued to hostname.
Returns Error object, populating it with reason, host, and cert on
failure. On success, returns undefined.
This function can be overwritten by providing alternative function as part of
the options.checkServerIdentity option passed to tls.connect(). The
overwriting function can call tls.checkServerIdentity() of course, to augment
the checks done with additional verification.
This function is only called if the certificate passed all other checks, such as
being issued by trusted CA (options.ca).
The host name or IP address to verify the certificate against.
A certificate object representing the peer's certificate.
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.
TCP Connection keep alive enabled
The number of milliseconds to wait before initiating keepAlive on the TCP socket
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 size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
Custom logger object
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:
A primary key factory function for generation of custom _id keys
A Promise library class the application wishes to use such as Bluebird, must be ES6 compatible
Return document results as raw BSON buffers
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.
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.
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
If set TLS enabled, equivalent to setting the ssl option.
| nodejs option | MongoDB equivalent | type |
|---|---|---|
ca |
sslCA, tlsCAFile |
string | Buffer | Buffer[] |
crl |
sslCRL |
string | Buffer | Buffer[] |
cert |
sslCert, tlsCertificateFile, tlsCertificateKeyFile |
string | Buffer | Buffer[] |
key |
sslKey, tlsCertificateKeyFile |
string | Buffer | KeyObject[] |
passphrase |
sslPass, tlsCertificateKeyFilePassword |
string |
rejectUnauthorized |
sslValidate |
boolean |
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.
Turn these options into a reusable connection URI
Generated using TypeDoc
Mongo Client Options