Optional
ALPNProtocolsAn array of strings or a Buffer naming possible ALPN protocols.字符串数组或缓冲区,命名可能的ALPN协议。
(Protocols should be ordered by their priority.)(协议应按优先级排序。)
Optional
appOptionally 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.数据库或视图上的操作不支持自动加密,未绕过的操作将导致错误(请参阅libmongocrypt:自动加密允许列表)。要绕过所有操作的自动加密,请在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:
AutoEncryptionOptions.keyVaultClient
AutoEncryptionOptions.bypassAutomaticEncryption
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,除了minPoolSize
设置为0并且省略了AutoEncryptionOptions
之外,它将使用与父级MongoClient相同的选项进行配置。
Optional
caOptionally override the trusted CA certificates. (可选)覆盖受信任的CA证书。Default is to trust the well-known CAs curated by Mozilla. 默认情况是信任Mozilla策划的知名CA。Mozilla's CAs are completely replaced when CAs are explicitly specified using this option.当使用此选项显式指定CA时,Mozilla的CA将被完全替换。
Optional
certCert chains in PEM format. PEM格式的证书链。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格式的中间证书(如果有的话),不包括根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.当提供多个证书链时,它们不必与键中的私钥顺序相同。如果不提供中间证书,对等方将无法验证证书,并且握手将失败。
Optional
checkVerifies the certificate cert
is issued to hostname
.
Returns Error object, populating it with 返回Error对象,在失败时用reason
, host
, and cert
on failure. reason
、host
和cert
填充该对象。On success, returns undefined.成功时,返回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
. checkServerIdentity
选项结合使用,该选项可传递给连接,因此可对certificate object
进行操作。For other purposes, consider using 出于其他目的,请考虑使用x509.checkHost()
instead.x509.checkHost()
。
This function can be overwritten by providing an alternative function as the通过提供一个替代函数作为传递给options.checkServerIdentity
option that is passed to tls.connect()
. tls.connect()
的options.checkServerIdentity
选项,可以覆盖此函数。The overwriting function can call 覆盖函数当然可以调用tls.checkServerIdentity()
of course, to augment the checks done with additional verification.tls.checkServerIdentity()
,以通过额外的验证来增强所做的检查。
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 given如果存在匹配的hostname
if a matching uniformResourceIdentifier
subject alternative name was present (see CVE-2021-44531). uniformResourceIdentifier
使用者替代名称,早期版本的Node.js错误地接受了给定hostname
的证书(请参阅CVE-2021-44531)。Applications that wish to accept希望接受uniformResourceIdentifier
subject alternative names can use a customoptions.checkServerIdentity
function that implements the desired behavior.uniformResourceIdentifier
主题替代名称的应用程序可以使用实现所需行为的自定义options.checkServerIdentity
函数。
The host name or IP address to verify the certificate against.用于验证证书的主机名或IP地址。
A 表示对等方证书的certificate object
representing the peer's certificate.certificate object
。
v0.8.4
Optional
ciphersCipher suite specification, replacing the default. 密码套件规范,替换默认规范。For more information, see modifying the default cipher suite. 有关详细信息,请参阅修改默认密码套件。Permitted ciphers can be obtained via tls.getCiphers(). 允许的密码可以通过tls.getCiphers()
获得。Cipher names must be uppercased in order for OpenSSL to accept them.密码名称必须大写,OpenSSL才能接受它们。
The time in milliseconds to attempt a connection before timing out.超时前尝试连接的时间(以毫秒为单位)。
Optional
credentialsOptional
crlPEM formatted CRLs (Certificate Revocation Lists).PEM格式的CRL(证书吊销列表)。
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允许包装驱动程序修改驱动程序生成的客户端元数据,以包含有关包装驱动程序的信息
Optional
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. 描述命名曲线或曲线NID或名称的冒号分隔列表的字符串,例如P-521:P-384:P-256,用于ECDH键协商。Set to auto to select the curve automatically. 设置为“自动”可自动选择曲线。Use crypto.getCurves() to obtain a list of available curve names. 使用cryptogetCurves()
获取可用曲线名称的列表。On recent releases, openssl ecparam -list_curves will also display the name and description of each available elliptic curve. 在最近的版本中,openssl ecparam-list_curves还将显示每个可用椭圆曲线的名称和描述。Default: tls.DEFAULT_ECDH_CURVE.默认值:tls.DEFAULT_ECDH_CURVE
。
Optional
familyForce server to assign 强一致性务器分配_id
values instead of driver_id
值而不是驱动程序
heartbeatFrequencyMS controls when the driver checks the state of the MongoDB deployment. hearteatFrequencyMS
控制驱动程序何时检查MongoDB部署的状态。Specify the interval (in milliseconds) between checks, counted from the end of the previous check until the beginning of the next one.指定检查之间的间隔(以毫秒为单位),从上一次检查结束到下一次检查开始计数。
Optional
hintsOptional
keyPrivate keys in PEM format. PEM格式的私钥。PEM allows the option of private keys being encrypted. PEM允许选择加密私钥。Encrypted keys will be decrypted with options.passphrase. 加密的键将使用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: <string>]}. 使用不同算法的多个键可以作为未加密键字符串或缓冲区的数组提供,也可以作为对象的数组提供形式为{pem: <string|buffer>[, passphrase: <string>]}
。The object form can only occur in an array.对象形式只能出现在数组中。
object.passphrase is optional. object.passphrase
是可选的。Encrypted keys will be decrypted with object.passphrase if provided, or options.passphrase if it is not.加密的键将使用object.passphrase
(如果提供)进行解密,或者如果没有,则使用options.passphrase
进行解密。
Optional
localOptional
localThe size (in milliseconds) of the latency window for selecting among multiple suitable MongoDB instances.用于在多个合适的MongoDB实例中进行选择的延迟窗口的大小(以毫秒为单位)。
Optional
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.连接池中的最大连接数。
Optional
minDHSizeSets 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 delayTCP连接无延迟
Optional
passphraseShared passphrase used for a single private key and/or a PFX.用于单个私钥和/或PFX的共享密码短语。
Optional
pfxPFX or PKCS12 encoded private key and certificate chain. PFX或PKCS12编码的私钥和证书链。pfx is an alternative to providing key and cert individually. pfx是单独提供键和证书的替代方案。PFX is usually encrypted, if it is, passphrase will be used to decrypt it. PFX通常是加密的,如果是,密码短语将用于解密。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: <string>]}. 多个PFX可以作为未加密PFX缓冲区的数组提供,也可以作为对象数组提供,格式为{buf: <string|buffer>[, passphrase: <string>]}
。The object form can only occur in an array.对象形式只能出现在数组中。object.passphrase is optional. objectpassphrase是可选的。Encrypted PFX will be decrypted with object.passphrase if provided, or options.passphrase if it is not.加密的PFX将使用object.passphrase
(如果提供)进行解密,或者如果没有,则使用options.passphrase
进行解密。
A primary key factory function for generation of custom 用于生成自定义_id
keys_id
键的主键工厂函数
Optional
proxyOptional
proxyOptional
proxyOptional
proxyEnabling the raw option will return a Node.js Buffer which is allocated using allocUnsafe API.启用raw选项将返回使用allocUnsafe API分配的Node.js缓冲区。
See this section from the Node.js Docs here for more detail about what "unsafe" refers to in this context.请参阅Node.js文档中的这一部分,了解有关“不安全”在本文中所指内容的更多详细信息。
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).请注意,有一个已知的限制,即此选项不能在MongoClient级别使用(请参阅NODE-3946)。
It does correctly work at 它在Db
, Collection
, and per operation the same as other BSON options work.Db
、Collection
和每个操作中都能正常工作,与其他BSON选项的工作方式相同。
Optional
rejectIf true the server will reject any connection which is not authorized with the list of supplied CAs. 如果为true
,则服务器将拒绝未经所提供CA列表授权的任何连接。This option only has an effect if requestCert is true.只有当requestCert为true
时,此选项才有效。
true
Specifies the name of the replica set, if the mongod is a member of a replica set.如果mongod
是副本集的成员,则指定副本集的名称。
Enables retryable reads.启用可重试读取。
Enable retryable writes.启用可重试写入。
Optional
secureAn optional TLS context object from tls.createSecureContext()tls.creatSecureContext()
中的可选TLS上下文对象
Optional
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. 传统机制选择TLS协议版本使用,它不支持独立控制最低和最高版本,也不支持将协议限制为TLSv1.3。Use minVersion and maxVersion instead. The possible values are listed as SSL_METHODS, use the function names as strings. 请改用minVersion和maxVersion。可能的值列为SSL_METHODS,将函数名用作字符串。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. 例如,使用“TLSv1_method”强制TLS版本1.1,或使用“TLS_method”允许TLSv1.3以下的任何TLS协议版本。It is not recommended to use TLS versions less than 1.2, but it may be required for interoperability. Default: none, see minVersion.不建议使用低于1.2的TLS版本,但可能需要使用该版本才能实现互操作性。默认值:none,请参阅minVersion。
Specifies how long (in milliseconds) to block for server selection before throwing an exception.指定在引发异常之前阻止服务器选择的时间(以毫秒为单位)。
Optional
servernameOptional
sessionAn optional Buffer instance containing a TLS session.包含TLS会话的可选缓冲区实例。
The time in milliseconds to attempt a send or receive on a socket before the attempt times out.在尝试超时之前,在套接字上尝试发送或接收的时间(以毫秒为单位)。
Optional
srvThe maximum number of hosts to connect to when using an srv connection string, a setting of 使用srv连接字符串时要连接到的最大主机数,设置为0
means unlimited hosts0
表示主机不受限制
Modifies the srv URI to look like:修改srv URI,使其看起来像:
_{srvServiceName}._tcp.{hostname}.{domainname}
Querying this DNS URI is expected to respond with SRV records查询此DNS URI应使用SRV记录进行响应
If 如果将tls
is provided as an option, it is equivalent to setting the ssl
option.tls
作为一个选项提供,则相当于设置ssl
选项。
NodeJS native TLS options are passed through to the socket and retain their original types.NodeJS本机TLS选项被传递到套接字并保留其原始类型。
nodejs |
||
---|---|---|
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
.tlsInsecure
设置为true
,则会将Node原生选项checkServerIdentity
设置为no-op,并将rejectUnauthorized
设置为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
. tlsInsecure
设置为false
,则会将节点本机选项checkServerIdentity
设置为no-op,并将rejectUnauthorized
设置为tlsAllowInvalidCertificates
的反值。If 如果未设置tlsAllowInvalidCertificates
is not set, then rejectUnauthorized
will be set to true
.tlsAllowInvalidCertificates
,则rejectUnauthorized
将设置为true
。
tlsCAFile
, tlsCertificateKeyFile
and tlsCRLFile
tlsCAFile
、tlsCertificateKeyFile
和tlsCRLFile
的说明The files specified by the paths passed in to the 传入到tlsCAFile
, tlsCertificateKeyFile
and tlsCRLFile
fields are read lazily on the first call to MongoClient.connect
. tlsCAFile
、tlsCertificateKeyFile
和tlsCRLFile
字段的路径指定的文件在第一次调用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
. ca
、cert
、crl
和key
字段,在随后调用MongoClient.connect
时将不会再次读取这些文件。As a result, until the first call to 因此,在第一次调用MongoClient.connect
, the ca
, cert
, crl
and key
fields will be undefined.MongoClient.connect
之前,ca
、cert
、crl
和key
字段都是未定义的。
Bypasses validation of the certificates presented by the mongod/mongos instance绕过mongod
/mongos
实例提供的证书验证
Disables hostname validation of the certificate presented by the mongod/mongos instance.禁用mongod
/mongos
实例提供的证书的主机名验证。
Optional
tlsCAFileOptional
tlsCRLFileOptional
tlsDisables 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.如果使用zlib进行网络压缩,则指定压缩级别的整数。
Generated using TypeDoc
Parsed Mongo Client Options.
User supplied options are documented by用户提供的选项由MongoClientOptions
.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.并非所有选项都可以在客户端构建后出现,因为有些选项是从异步操作中获得的。