OptionalallowTreat intermediate (non-self-signed) certificates in the trust CA certificate list as trusted.将信任CA证书列表中的中间（非自签名）证书视为受信任的。
OptionalALPNProtocolsAn array of strings or a Buffer naming possible ALPN protocols. (Protocols should be ordered by their priority.)命名可能的ALPN协议的字符串数组或缓冲区。（协议应按优先级排序。）
OptionalappOptionally 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). 数据库或视图上的操作不支持自动加密，未绕过的操作将导致错误（请参阅libmongocrypt：自动加密允许列表）。To bypass automatic encryption for all operations, set bypassAutoEncryption=true in AutoEncryptionOpts.要绕过所有操作的自动加密，请在AutoEncryptionOpts中设置bypassAutoEncryption=true。
Automatic encryption requires the authenticated user to have the listCollections privilege action.自动加密要求经过身份验证的用户具有listCollections权限操作。
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配置了具有有限连接池大小（即非零maxPoolSize）的MongoClient，并且满足以下任何条件，则会创建一个单独的内部MongoClient：
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.如果创建了一个内部MongoClient，它将配置与父MongoClient相同的选项，除了minPoolSize设置为0并且省略了AutoEncryptionOptions。
OptionalautoOptionalautoOptionalcaOptionally 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.可选地覆盖受信任的CA证书。默认情况是信任Mozilla策划的知名CA。当使用此选项明确指定CA时，Mozilla的CA将被完全替换。
OptionalcertCert 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). PEM格式的证书链。每个私钥应提供一个证书链。每个证书链应按顺序由提供的私钥的PEM格式证书组成，然后是PEM格式的中间证书（如果有的话），不包括根CA（根CA必须预先为对等方所知，请参阅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.当提供多个证书链时，它们不必与键中的私钥顺序相同。如果不提供中间证书，对等方将无法验证证书，握手将失败。
OptionalcheckVerifies 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 the此函数旨在与checkServerIdentity option that can be passed to connect and as such operates on a certificate object. For other purposes, consider using x509.checkHost() instead.checkServerIdentity选项结合使用，该选项可以传递以进行连接，因此对证书对象进行操作。出于其他目的，请考虑使用x509.checkHost()。
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 (仅当证书通过所有其他检查时，才会调用此函数，例如由受信任的CA（options.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.
OptionalciphersCipher 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.
OptionalcredentialsOptionalcrlPEM 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 /*
OptionalecdhA 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.
OptionalfamilyForce 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.
OptionalhintsOptionalkeepNode.JS socket option to set the time the first keepalive probe is sent on an idle socket. Defaults to 120000ms
OptionalkeyPrivate 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:
OptionallocalOptionallocalThe size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.
OptionallookupThe maximum number of connections that may be in the process of being established concurrently by the connection pool.
The maximum amount of time a connection should remain idle in the connection pool before being marked idle, in milliseconds. If specified, this must be a number greater than or equal to 0, where 0 means there is no limit. Defaults to 0. After this time passes, the idle collection can be automatically cleaned up in the background.
The maximum number of connections in the connection pool.
OptionalminDHSizeSets 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
OptionalpassphraseShared passphrase used for a single private key and/or a PFX.
OptionalpfxPFX 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
OptionalproxyOptionalproxyOptionalproxyOptionalproxyEnabling 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.
OptionalrejectIf 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.
OptionalsecureAn optional TLS context object from tls.createSecureContext()
OptionalsecureLegacy 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.
OptionalservernameSpecifies how long (in milliseconds) to block for server selection before throwing an exception.
OptionalsessionAn 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.
OptionalsrvThe 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
OptionaltimeoutMSIf tls is provided as an option, it is equivalent to setting the ssl option.
NodeJS native TLS options are passed through to the socket and retain their original types.
| nodejs native option | driver spec equivalent option name | driver option type |
|---|---|---|
ca |
tlsCAFile |
string |
crl |
tlsCRLFile |
string |
cert |
tlsCertificateKeyFile |
string |
key |
tlsCertificateKeyFile |
string |
passphrase |
tlsCertificateKeyFilePassword |
string |
rejectUnauthorized |
tlsAllowInvalidCertificates |
boolean |
checkServerIdentity |
tlsAllowInvalidHostnames |
boolean |
| see note below | tlsInsecure |
boolean |
If tlsInsecure is set to true, then it will set the node native options checkServerIdentity to a no-op and rejectUnauthorized to false.
If tlsInsecure is set to false, then it will set the node native options checkServerIdentity to a no-op and rejectUnauthorized to the inverse value of tlsAllowInvalidCertificates. If
tlsAllowInvalidCertificates is not set, then rejectUnauthorized will be set to true.
tlsCAFile, tlsCertificateKeyFile and tlsCRLFileThe files specified by the paths passed in to the tlsCAFile, tlsCertificateKeyFile and tlsCRLFile fields are read lazily on the first call to MongoClient.connect. Once these files have been read and the ca, cert, crl and key fields are populated, they will not be read again on subsequent calls to
MongoClient.connect. As a result, until the first call to MongoClient.connect, the ca,
cert, crl and key fields will be undefined.
Bypasses validation of the certificates presented by the mongod/mongos instance
Disables hostname validation of the certificate presented by the mongod/mongos instance.
OptionaltlsCAFileOptionaltlsOptionaltlsCRLFileDisables 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.
Parsed Mongo Client Options.解析的Mongo客户端选项。User supplied options are documented byMongoClientOptions.MongoClientOptions记录了用户提供的选项。NOTE:
The client's options parsing is subject to change to support new features. This type is provided to aid with inspection of options after parsing, it should not be relied upon programmatically.客户端的选项解析可能会发生变化，以支持新功能。提供此类型是为了在解析后帮助检查选项，不应以编程方式依赖它。Options are sourced from:选项来源于：connection string连接字符串options object passed to the MongoClient constructor传递给MongoClient构造函数的options对象file system (ex. tls settings)文件系统（例如tls设置）environment variables环境变量DNS SRV records and TXT recordsDNS SRV记录和TXT记录Not all options may be present after client construction as some are obtained from asynchronous operations.并非所有选项都会在客户端构建后出现，因为有些选项是从异步操作中获得的。