可选ALPNAn array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)
可选app可选autoOptionally enable in-use auto encryption
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:
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.
可选caOptionally 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.
可选certCert 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.
可选checkVerifies 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 is intended to be used in combination with thecheckServerIdentity option that can be passed to connect and as
such operates on a certificate object. For other purposes, consider using x509.checkHost() instead.
This function can be overwritten by providing an alternative function as the options.checkServerIdentity option that is 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).
Earlier versions of Node.js incorrectly accepted certificates for a givenhostname if a matching uniformResourceIdentifier subject alternative name
was present (see CVE-2021-44531). Applications that wish to acceptuniformResourceIdentifier subject alternative names can use
a custom options.checkServerIdentity function that implements the desired behavior.
The host name or IP address to verify the certificate against.
A certificate object representing the peer's certificate.
可选ciphersCipher 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.
可选credentials可选crlPEM 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
可选ecdhA 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.
可选familyForce 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.
可选hintsTCP Connection keep alive enabled
The number of milliseconds to wait before initiating keepAlive on the TCP socket
可选keyPrivate 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:
可选local可选localThe size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
可选lookupThe 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.
可选minSets 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
可选passphraseShared passphrase used for a single private key and/or a PFX.
可选pfxPFX 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
可选proxy可选proxy可选proxy可选proxyEnabling 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:
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
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.
可选rejectIf 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.
可选secureAn optional TLS context object from tls.createSecureContext()
可选secureLegacy 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.
可选servernameSpecifies how long (in milliseconds) to block for server selection before throwing an exception.
可选sessionAn 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.
可选srvThe 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.
Mongo Client Options