Docs 菜单
Docs 主页
/ / /
Kotlin 协程
/ /

连接选项

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

选项名称
类型
说明
minPoolSize
整型

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

Default: 0
maxPoolSize
整型

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

Default: 100
waitQueueTimeoutMS
整型

指定线程可以等待连接变为可用的最长时间(以毫秒为单位)。

Default: 120000 (120 seconds)
serverSelectionTimeoutMS
整型

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

Default: 30000 (30 seconds)
localThresholdMS
整型

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

Default: 15
heartbeatFrequencyMS
整型

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

Default: 10000 (10 seconds)
replicaSet
字符串

指定提供的 连接string包含多个主机。 指定后,驾驶员会尝试查找该设立的所有节点。

Default: null
ssl
布尔

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

Default: false
TLS
布尔

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

Default: false
tlsInsecure
布尔

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

Default: false
tlsAllowInvalidHostnames
布尔

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

Default: false
connectTimeoutMS
整型

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

Default: 10000 (10 seconds)
socketTimeoutMS
整型

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

Default: 0
maxIdleTimeMS
整型

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

Default: 0
maxLifeTimeMS
整型

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

Default: 0
journal
布尔

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

Default: false
w
字符串或整数

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

Default: 1
wtimeoutMS
整型

指定写关注的时间限制(以毫秒为单位)。 有关更多信息,请参阅wtimeoutMS 选项的服务器文档。 值为0指示驱动程序写入操作永不超时。

Default: 0
readPreference
字符串

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

Default: primary
readPreferenceTags
字符串

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

Default: null
maxStalenessSeconds
整型

指定在驱动程序停止与从节点通信之前从节点的陈旧程度(以秒为单位)。 最小值为90秒或心跳频率加10秒,以较大者为准。 有关更多信息,请参阅maxStalenessSeconds 选项的服务器文档。 不提供参数或显式指定-1表示不应对从节点进行过时检查。

Default: -1
authMechanism
字符串

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

Default: By default, the client picks the most secure mechanism available based on the server version. For possible values, see the server documentation for the authMechanism option.
authSource
字符串

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

Default: admin
authMechanismProperties
字符串

将指定身份验证机制的身份验证属性指定为以冒号分隔的属性和值的列表。 有关更多信息,请参阅authMechanismProperties 选项的服务器文档。

Default: null
appName
字符串

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

Default: null
compressors
字符串

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

Default: null
zlibCompressionLevel
整型

指定 Zlib 为减小对已连接MongoDB实例的请求大小而应使用的压缩程度。该级别的范围可以从-19 ,值越低压缩速度越快(但会产生较大的请求),值越大压缩速度越慢(但会产生较小的请求)。

Default: null
retryWrites
布尔

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

Default: true
retryReads
布尔

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

Default: true
serverMonitoringMode
字符串

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

Default: auto
uuidRepresentation
字符串

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

Default: unspecified
directConnection
布尔

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

Default: false
maxConnecting
整型

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

Default: 2
srvServiceName
字符串

指定 SRV 资源记录 的服务名称 驱动程序检索以构建您的 种子列表 。要使用此选项,您必须在 连接 URI 中使用 DNS 种子列表连接格式 。

Default: mongodb

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

后退

连接至 MongoDB