连接选项
本节解释驱动程序支持的 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 设置为 默认: false 。 |
tlsAllowInvalidHostnames | 布尔 | 指定驱动程序必须允许 TLS 连接的证书中包含无效主机名。取代 sslInvalidHostNameAllowed。 默认: false 。 |
connectTimeoutMS | 整型 | 指定 Java 驱动程序在超时前等待连接打开的最长时间(毫秒)。值为 默认值: 10000 (10 秒) |
socketTimeoutMS | 整型 | 指定 Java 驱动程序在超时之前等待发送或接收请求的最长时间(以毫秒为单位)。值为 默认: 0 。 |
maxIdleTimeMS | 整型 | 指定 Java 驱动程序在关闭连接前支持池连接空闲的最长时间(毫秒)。值为 默认: 0 。 |
maxLifeTimeMS | 整型 | 指定 Java 驱动程序在关闭连接前继续使用池连接的最长时间(毫秒)。值为 默认: 0 。 |
杂志 | 布尔 | 指定驱动程序必须等待已连接的 MongoDB 实例为所有写入操作将提交分组到磁盘上的日志文件。 默认: false 。 |
w | 字符串或整数 | 指定写关注。 有关值的更多信息,请参阅 w 选项的服务器文档。 默认: 1 。 |
wtimeoutMS | 整型 | 指定写关注的时间限制(以毫秒为单位)。 有关更多信息,请参阅wtimeoutMS 选项的服务器文档。 值为 默认: 0 。 |
readPreference | 字符串 | 指定读取偏好。 有关值的更多信息,请参阅readPreference 选项的服务器文档。 默认: primary 。 |
readPreferenceTags | 字符串 | 指定读取偏好标签。 有关值的更多信息,请参阅readPreferenceTags 选项的服务器文档。 默认: null 。 |
maxStalenessSeconds | 整型 | 指定在驱动程序停止与从节点通信之前从节点的陈旧程度(以秒为单位)。 最小值为90秒或心跳频率加10秒,以较大者为准。 有关更多信息,请参阅maxStalenessSeconds 选项的服务器文档。 不提供参数或显式指定 默认: -1 。 |
authMechanism | 字符串 | 指定驱动程序在提供凭证时使用的身份验证机制。 默认:默认情况下,客户端根据服务器版本选择最安全的可用机制。有关可能的值,请参阅 authMechanism 选项的服务器文档。 |
authSource | 字符串 | 指定验证所提供凭证的数据库。 默认: admin 。 |
authMechanismProperties | 字符串 | 将指定身份验证机制的身份验证属性指定为以冒号分隔的属性和值的列表。 有关更多信息,请参阅authMechanismProperties 选项的服务器文档。 默认: null 。 |
appName | 字符串 | 指定在连接握手过程中提供给 MongoDB 实例的应用程序的名称。可用于服务器日志和分析。 默认: null 。 |
compressors | 字符串 | 指定驱动程序将尝试用于压缩发送到连接的 MongoDB 实例的请求的一种或多种压缩算法。可能的值包括: 默认: null 。 |
zlibCompressionLevel | 整型 | 指定 的压缩程度zlib 用于减少对已连接MongoDB 实例的请求大小。该级别的范围可以从 默认: null 。 |
retryWrites | 布尔 | 指定驱动程序在由于网络错误而无法完成支持的写入操作时必须重试这些操作。 默认: true 。 |
retryReads | 布尔 | 指定驱动程序在由于网络错误而无法完成支持的读取操作时必须重试这些操作。 默认: true 。 |
serverMonitoringMode | 字符串 | 指定驱动程序使用的服务器监控协议。当设置为 默认: auto 。 |
uuidRepresentation | 字符串 | 指定用于读取和写入操作的 UUID 表示形式。 有关更多信息,请参阅 MongoClientSettings.getUuidRepresentation() 方法的驱动程序文档。 默认: unspecified 。 |
directConnection | 布尔 | 指定驱动程序必须直接连接到主机。 默认: false 。 |
maxConnecting | 整型 | 指定池可以同时建立的最大连接数。 默认: 2 。 |
srvServiceName | 字符串 | 指定 SRV 资源记录 的服务名称 驱动程序检索以构建您的 种子列表 。要使用此选项,您必须在 连接 URI 中使用 DNS 种子列表连接格式 。 默认: mongodb 。 |
有关选项的完整列表,请参阅 ConnectionString API 文档。