文档菜单
文档首页
/ / /
Kotlin 协程
/ /

连接选项

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

选项名称
类型
描述
minPoolSize
整数

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

默认值: 0
maxPoolSize
整数

指定连接池在任何给定时间内可能拥有的最大连接数。

默认值: 100
waitQueueTimeoutMS
整数

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

默认值: 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
写关注
字符串或整数

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

默认值1
写超时毫秒
整数

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

默认值: 0
读取偏好
字符串

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

默认值primary
读取偏好标签
字符串

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

默认值: null
最大不稳定性秒数
整数

指定在驱动程序停止与该从属服务器通信之前,从属服务器可以有多不稳定的秒数。最小值是90秒或心跳频率加10秒,取较大者。有关更多信息,请参阅服务器文档中的 最大不稳定性秒数选项。不提供参数或显式指定 -1 指示不应检查从属服务器的陈旧性。

默认值-1
身份验证机制
字符串

指定如果提供了凭据,驱动程序应使用的身份验证机制。

默认值: 默认情况下,客户端根据服务器版本选择最安全的机制。有关可能的值,请参阅服务器文档中的 身份验证机制选项
身份验证源
字符串

指定应验证提供的凭据的数据库。

默认值admin
身份验证机制属性
字符串

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

默认值: null
应用程序名称
字符串

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

默认值: null
压缩程序
字符串

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

默认值: null
zlib压缩级别
整数

指定Zlib压缩级别,以减小连接到MongoDB实例的请求大小。压缩级别可以从-19,数值越小压缩越快(但请求大小越大),数值越大压缩越慢(但请求大小越小)。

默认值: null
retryWrites
布尔值

指定如果写入操作因网络错误失败,则驱动程序必须重试受支持的写入操作。

默认值: true
retryReads
布尔值

指定如果读取操作因网络错误失败,则驱动程序必须重试受支持的读取操作。

默认值: true
serverMonitoringMode
字符串

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

默认值: auto
uuidRepresentation
字符串

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

默认值: unspecified
directConnection
布尔值

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

默认值: false
maxConnecting
整数

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

默认值: 2
srvServiceName
字符串

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

默认值: mongodb

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

返回

连接到 MongoDB