对于 AI 代理:可在 https://www.mongodb.com/zh-cn/docs/llms.txt 获取文档索引—通过在任何 URL 路径后添加 .md 可获取所有页面的 Markdown 版本。
Docs 菜单

连接选项

本节解释驱动程序支持的 MongoDB 连接和身份验证选项。您可以将连接选项作为连接 URI 的参数传递,以指定客户端的行为。

选项名称
类型
说明

minPoolSize

整型

指定单个连接池中任何时刻都必须存在的最少连接数。

默认0

maxPoolSize

整型

指定连接池在给定时间内的最大连接数。

默认100

waitQueueTimeoutMS (已弃用)

整型

此选项已弃用。您可以通过设置客户端级别的超时来配置此超时。

操作等待连接变为可用状态的最大等待时间(以毫秒为单位)。值为 0 表示没有限制。

默认120000(120 秒)

serverSelectionTimeoutMS

整型

指定驱动程序在抛出异常前等待服务器选择成功的最长时间(以毫秒为单位)。

默认值30000(30 秒)

localThresholdMS

整型

与副本集中的多个 MongoDB 实例通信时,驱动程序只会向响应时间小于或等于最快响应时间加上本地阈值(以毫秒为单位)的服务器发送请求。

默认15

heartbeatFrequencyMS

整型

指定驱动程序在尝试确定集群中每台服务器当前状态时的等待频率(以毫秒为单位)。

默认值10000(10 秒)

replicaSet

字符串

指定所提供的连接字符串包含多个主机。指定后,驱动程序会尝试查找该集合的所有节点。

默认null

ssl

布尔

指定与 MongoDB 实例的所有通信都应使用 TLS/SSL。 取代tls选项。

默认false

TLS

布尔

指定与 MongoDB 实例的所有通信都应使用 TLS。 取代ssl选项。

默认false

tlsInsecure

布尔

指定驱动程序应允许 TLS 连接使用无效主机名。 与将tlsAllowInvalidHostnames设置为true的效果相同。 要以其他方式配置 TLS 安全约束,请使用自定义 SSLContext。

默认false

tlsAllowInvalidHostnames

布尔

指定驱动程序应允许 TLS 连接的证书中包含无效主机名。 取代sslInvalidHostNameAllowed

默认false

connectTimeoutMS

整型

指定 Kotlin 驱动程序在超时前等待连接打开的最长时间(以毫秒为单位)。 值为0指示驱动程序在等待连接打开时永不超时。

默认值10000(10 秒)

socketTimeoutMS (已弃用)

整型

此选项已弃用。您可以通过设置客户端级别的超时来配置此超时。

Kotlin驱动程序在超时之前等待发送或接收请求的最长时间(以毫秒为单位)。值为 0 指示驱动程序在等待发送或接收请求时永不超时。

默认0

maxIdleTimeMS

整型

指定驱动程序在关闭连接之前允许池化连接处于空闲状态的最长时间(以毫秒为单位)。值为 0 表示驱动程序允许池连接空闲的时间没有上限。

将此值设置为高于应用程序的预期空闲时间,但低于防火墙或代理连接超时,以防止意外断开连接。

默认0

maxLifeTimeMS

整型

指定 Kotlin 驱动程序在关闭连接之前继续使用池连接的最长时间(以毫秒为单位)。 值为0表示驱动程序保持池化连接打开的时间没有上限。

默认0

journal

布尔

指定驱动程序必须等待已连接的 MongoDB 实例为所有写入操作将提交分组到磁盘上的日志文件。

默认false

w

字符串或整数

指定写关注。有关值的更多信息,请参阅w 选项的服务器文档。

默认1

wtimeoutMS (已弃用)

整型

此选项已弃用。您可以通过设置客户端级别的超时来配置此超时。

Time limit, in milliseconds, for the write concern. For more information, see the server documentation for the wtimeoutMS option. A value of 0 instructs the driver to never time out write operations.

默认0

readPreference

字符串

指定读取偏好。有关值的更多信息,请参阅服务器文档中的 readPreference 选项

默认primary

readPreferenceTags

字符串

指定读取偏好标签。有关值的更多信息,请参阅服务器文档中的 readPreferenceTags 选项

默认null

maxStalenessSeconds

整型

指定在驾驶员停止与从从节点(secondary node from replica set)通信之前从从节点(secondary node from replica set)的陈旧程度(以秒为单位)。最小值为90 秒或心跳频率加10 秒,以较大者为准。有关详细信息,请参阅 maxStalenessSeconds 选项的服务器文档。不提供参数或明确指定-1 表示从节点不应进行过时检查。

默认-1

authMechanism

字符串

指定驱动程序在提供档案的情况下应使用的身份验证机制

默认:默认情况下,客户端根据服务器版本选择最安全的可用机制。有关可能的值,请参阅 authMechanism 选项的服务器文档。

authSource

字符串

指定应验证所提供档案的数据库。

默认admin

authMechanismProperties

字符串

将特定身份验证机制的身份验证属性指定为一张属性和值用冒号分隔的列表。如需了解更多信息,请参阅 authMechanismProperties 选项的服务器文档。

默认null

appName

字符串

指定在连接握手过程中提供给 MongoDB 实例的应用程序的名称。可用于服务器日志和分析。

默认null

compressors

字符串

指定驱动程序将尝试用于压缩发送到连接的 MongoDB 实例的请求的一种或多种压缩算法。可能的值包括:zlibsnappyzstd

默认null

zlibCompressionLevel

整型

Specifies the degree of compression that Zlib should use to decrease the size of requests to the connected MongoDB instance. The level can range from -1 to 9, with lower values compressing faster (but resulting in larger requests) and larger values compressing slower (but resulting in smaller requests).

默认null

retryWrites

布尔

指定驱动程序在由于网络错误而失败时必须重试支持的写入操作。

默认true

retryReads

布尔

指定驱动程序在由于网络错误而失败时必须重试支持的读取操作。

默认true

serverMonitoringMode

字符串

指定驱动程序使用的服务器监控协议。当设置为 auto 时,监控模式由驱动程序运行的环境决定。驱动程序在功能即服务 (FaaS) 环境中使用 poll 模式,在其他环境中使用 stream 模式。

默认auto

uuidRepresentation

字符串

指定用于读取和写入操作的 UUID 表示方法。有关更多信息,请参阅驱动程序文档中的 MongoClientSettings.getUuidRepresentation() 方法

默认unspecified

directConnection

布尔

指定驱动程序必须直接连接到主机。

默认false

maxConnecting

整型

指定池可以同时建立的最大连接数。

默认2

srvServiceName

字符串

Specifies the service name of the SRV resource records the driver retrieves to construct your seed list. You must use the DNS Seed List Connection Format in your connection URI to use this option.

默认mongodb

有关选项的完整列表,请参阅 ConnectionString API参考页面。

给本页内容打分