/ /

连接选项

Overview

在本指南中，您可以了解 MongoDB 连接和身份验证选项。您可以将连接选项设置为连接字符串的参数，以指定Client实例在连接到服务器时的行为方式。

选项名称	接受的值	默认值	说明
appName	字符串	无	指定 `Client` 实例作为握手的一部分发送到服务器的应用程序名称。指定 `appName` 可帮助您使用服务器日志来确定哪个 `Client` 实例连接到服务器。
authMechanism	字符串	无	指定要使用的身份验证机制。如果不指定此选项，驱动程序将使用默认的身份验证机制。要了解有关 Rust 驱动程序中身份验证的更多信息，请参阅身份验证机制指南。
authMechanismProperties	字符串	无	为`authMechanism`选项中设置的身份验证机制指定更多属性。
authSource	字符串	查看说明	指定用于身份验证的数据库。对于基于 SCRAM 的身份验证机制，此选项默认为 `admin`；对于 `MONGODB-X509` 机制，此选项默认为 `$external`；对于 `PLAIN` 机制，此选项默认为数据库名称或 `$external`。
compressors	以逗号分隔的字符串列表	无	指定`Client`实例按指定顺序使用的压缩程序。要了解有关网络压缩的更多信息，请参阅网络压缩指南。
connectTimeoutMS	Non-negative integer	`10000` （10 秒）	指定尝试连接到服务器时传递给每个底层 TCP 流的连接超时时间（以毫秒为单位）。
directConnection	布尔	`false`	指定`Client`实例是否直接连接到单个主机，而不是发现并连接到集群中的所有服务器。
heartbeatFrequencyMS	大于或等于 500 的整数。	`10000` （10 秒）	指定每个监控线程在执行服务器检查之间等待的时间（以毫秒为单位）。
journal	布尔	`false`	请求确认操作已传播到磁盘上日志。
localThresholdMS	Non-negative integer	15	指定驱动程序与服务器之间的平均往返时间相对于所有合适服务器中最短往返时间所允许持续的毫秒数。 `0` 的值表示没有延迟窗口，因此只有平均往返时间最短的服务器符合条件。
maxIdleTimeMS	Non-negative integer	`0` (no limit)	指定连接在连接池中可以保持空闲状态的时间量（以毫秒为单位），直到服务器关闭该连接。值为 `0` 表示客户端不关闭空闲连接。将此值设置为高于应用程序的预期空闲时间，但低于防火墙或代理连接超时，以防止意外断开连接。
maxStalenessSeconds	`-1`，或任何大于或等于的整数 `90`	`-1`	指定从节点在主节点后面可以延迟的最大时间（以秒为单位），以便将其视为可用于给定操作。此选项的值必须至少为 `90`，否则操作会报错。`-1` 表示没有最大延迟。
maxPoolSize	Non-negative integer	`10`	指定 `Client` 实例可以在给定服务器的连接池中创建的最大连接数。如果在值为 `maxPoolSize` 的连接已经检出时尝试操作，则操作会等待进行中的操作完成并且连接返回到连接池。
minPoolSize	Non-negative integer	`0`	指定服务器连接池在给定时间内可用的最少连接数。如果连接池中的连接数少于 `minPoolSize`，则服务器在背景中添加连接，直到连接数达到 `minPoolSize`。
readConcernLevel	字符串	无	指定在`Client`实例上执行的操作的默认读关注（read concern）。要学习；了解更多信息，请参阅服务器手册中的读关注。
readPreference	字符串	`primary`	Specifies how the driver routes a read operation to members of a replica set. To learn more, see Read Preference in the Server manual.
readPreferenceTags	以逗号分隔的键值对列表	无	指定考虑对哪些副本集成员进行操作。此键的每个实例都是一个单独的标签集。驱动程序会检查每个标签集，直到找到具有标签集中每个标签的一台或多台服务器。
replicaSet	字符串	无	指定`Client`实例连接到的副本集的名称。
retryReads	布尔	`true`	指定在操作失败时客户端是否重试读取操作。
serverSelectionTimeoutMS	Non-negative integer	`30000` （30 秒）	指定`Client`实例在尝试为操作选择服务器时在超时之前等待的时间（以毫秒为单位）。
TLS	布尔	`false`	指定`Client`实例在与服务器连接时使用的 TLS 配置。 By default, TLS is off.
tlsAllowInvalidCertificates	布尔	`false`	指定如果服务器提供的证书无效，`Client` 实例是否返回错误。我们建议您仅在测试环境中将此选项设置为 `true`，以避免在应用程序中创建漏洞。
tlsCAFile	字符串	查看说明	指定 `Client` 实例用于 TLS 的证书授权机构 (CA) 文件的路径。如果您未指定此选项，则驱动程序会使用 `webpki-roots` crate 中的 Mozilla 根证书。
tlsCertificateKeyFile	字符串	无	指定 `Client` 实例向服务器呈现的证书文件的路径，以验证其身份。如果您未设置此选项，则 `Client` 实例不会尝试向服务器验证其身份。
tlsInsecure	布尔	`false`	指定如果服务器提供的证书无效，`Client` 实例是否返回错误。我们建议您仅在测试环境中将此选项设置为 `true`，以避免在应用程序中创建漏洞。
w	非负整数或字符串	无	Requests acknowledgment that the operation has propagated to a specific number or variety of servers. To learn more, see Write Concern in the Server manual.
wtimeoutMS	Non-negative integer	无超时	指定写关注（write concern）的时间限制（以毫秒为单位）。如果操作未在时限内传播到请求的级别，驱动程序将引发错误。
zlibCompressionLevel	-1 到 9（含）之间的整数	`-1`	指定使用 `zlib` 压缩器时的压缩的级别字段。将值设置为 `-1` 可选择默认压缩级别 (`6`)。将值设置为 `0` 可指定不压缩，将值设置为 `9` 可指定最大压缩。要了解有关网络压缩的更多信息，请参阅网络压缩指南。

注意

智能工作负载管理 (IWM) 中的负载削减

如果带有 SystemOverloadedError 或 RetryableError 标签的错误导致您的应用程序出现故障或出现在您的应用程序日志中，则说明您的集群上可能已启用负载削减 (Load Shedding)，并且您的驱动程序可能未升级到支持该功能的版本。我们建议将您的 MongoDB Rust 驱动程序升级到 3.6 或更高版本。如果您在升级后仍然看到这些错误，可以通过服务器端更改（例如查看您的负载削减配置）或通过应用程序端更改（例如实现自定义错误处理或客户端请求限制）来解决这些错误。根据您的情况，应用程序端更改可能是更可取或必要的。

负载削减 (Load Shedding) 是 IWM 的一项功能，有助于在持续过载期间通过拒绝多余的操作来管理服务器负载。此功能适用于 MongoDB 9.0 及更高版本。

For more information about IWM or handling overload errors, see the Intelligent Workload Management page or Overload Errors page in the Atlas documentation.

要查看连接选项的完整列表，请访问 stringMongoDB Server手册中有关连接字符串的条目的连接选项部分。