连接字符串选项

如果mongod 是副本集的成员，则指定 副本集 的名称。设置replicaSet连接选项，确保跨驱动程序行为的一致。

连接到副本集时，向 uri 的 host[:port] 组件提供副本集节点的种子列表。请参阅驱动程序文档，了解具体详情。

指定客户端是否直接连接到连接 URI 中的 host[:port]：

• true：客户端仅向指定主机发送操作。它不会尝试发现副本集的任何其他节点。

• false：客户端尝试发现副本集中的所有服务器，并向主节点发送操作。这是默认值。

对应于写关注 w 选项。w 选项请求确认写入操作已传播到指定数量的 mongod 实例或带有指定标签的 mongod 实例。

您可以指定 number、字符串 majority 或 tag set。

有关详细信息，请参阅 w 选项。

对应于写关注（write concern） 。 指定写关注（writewtimeout wtimeoutMSconcern）的时间限制（以毫秒为单位）。

当 wtimeoutMS 为 0 时，写操作永远不会超时。请参阅 wtimeout，了解更多信息。

对应于写关注（write concern）j Option 选项。journal 选项请求MongoDB确认写入操作已写入日志。有关详细信息，请参阅 j选项。

如果设立journal 设置为true ，并指定小于 的w 值，则以1 journal为准。

隔离级别。可接受以下值之一：

• local

• majority

• linearizable

• available

此连接字符串选项不适用于 mongosh。将读关注指定为特定操作的选项。

指定此连接的读取偏好。可能的值是：

• primary (默认)

• primaryPreferred

• secondary

• secondaryPreferred

• nearest

包含读操作的分布式事务必须使用读取偏好 primary。给定事务中的所有操作必须路由至同一节点。

该连接字符串选项不适用于 mongo shell。请参见 cursor.readPref() 和 Mongo.setReadPref()。

指定客户端在停止对从节点进行读取操作之前，从节点的陈旧程度（以秒为单位）。有关详情，请参阅读取偏好 maxStalenessSeconds。

默认情况下，没有最大过期时限，客户端在选择将读取操作定向到的节点时，也不会考虑从节点的滞后。

maxStalenessSeconds的最小值为90 秒。指定0 到90 秒之间的值将产生错误。 MongoDB驱动程序将 的maxStalenessSeconds 值视为“无最大陈旧度”，与省略-1 maxStalenessSeconds的情况相同。

指定标签文档为冒号分隔的键值对列表（逗号分隔）。例如，

• 要指定标记文档 { "dc": "ny", "rack": "r1" }，请在连接字符串中使用 readPreferenceTags=dc:ny,rack:r1。

• 要指定空标记文档 { }，请使用 readPreferenceTags= 无需设置该值。

要指定标记文档列表，请使用多个 readPreferenceTags。例如，readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=。

使用多个 readPreferenceTags 时顺序很重要。按顺序尝试 readPreferenceTags，直到找到匹配项。有关详情，请参阅标签匹配顺序。

该连接字符串选项不适用于 mongo shell。请参见 cursor.readPref() 和 Mongo.setReadPref()。

指定与用户凭证关联的数据库名称。如果未指定authSource authSourcedefaultauthdbdefaultauthdb，则 默认为连接字符串中指定的authSource 。如果未指定 ，则 默认为admin 。

PLAIN(LDAP)、GSSAPI (Kerberos) 和MONGODB-AWS (IAM )身份验证机制要求将authSource 设立为$external ，因为这些机制将档案存储委托给外部服务。

如果没有在连接字符串中或通过 参数提供用户名，authSource MongoDB将忽略--username 值。

指定 MongoDB 用于验证连接的身份验证机制。如果您不指定 authMechanism 但提供用户档案，则 MongoDB 会尝试使用 SCRAM-SHA-256。如果失败，则回退到 SCRAM-SHA-1。

• SCRAM-SHA-1

• SCRAM-SHA-256

• MONGODB-X509

• MONGODB-AWS

• GSSAPI (Kerberos)

• PLAIN (LDAP SASL)

只有 MongoDB Enterprise Edition 的mongod 和 mongos 实例提供 GSSAPI (Kerberos) 和 PLAIN (LDAP) 机制。

要使用 MONGODB-X509，必须启用 TLS/SSL。

要使用MONGODB-AWS ，您必须连接到MongoDB Atlas 群集，该集群已配置为支持通过 AWS IAM凭证（AWS访问权限密钥ID和秘密访问权限密钥，以及可选的 AWS 会话令牌）进行身份验证。MONGODB-AWS 身份验证机制要求将authSource 设立为$external 。

使用MONGODB-AWS 时，请提供您的 AWS访问权限密钥ID作为用户名，并提供秘密访问权限密钥作为密码。如果还使用 AWS 会话令牌，请为其提供AWS_SESSION_TOKENauthMechanismProperties 值。

如果AmazonAmazon Web Services IDWeb Services访问权限密钥ID 、秘密访问权限密钥或会话令牌包含以下字符，则必须使用百分比编码来转换这些字符。

$ : / ? # [ ] @

或者，如果 AWS 访问密钥 ID、秘密访问密钥或会话令牌是通过各自的 AWS IAM 环境变量在您的平台上定义的，那么 mongosh 将使用这些环境变量值进行身份验证；您无需在连接字符串中指定它们。

AtlasMONGODB-AWS有关使用连接string 和环境变量方法的 身份验证机制的示例用法，请参阅 连接到 集群 。

有关MongoDB中身份验证系统的更多信息，请参阅自管理部署上的身份验证。 另请考虑使用 x。 509用于对自管理部署上的客户端进行身份验证的证书，了解有关 x 509身份验证的更多信息。

将指定authMechanism 的属性指定为以逗号分隔的冒号分隔键值对列表。

可能的键值对有：

SERVICE_NAME:<string>

在连接到 Kerberized MongoDB 实例时设置 Kerberos 服务名称。该值必须与您要连接的 MongoDB 实例上设置的服务名称匹配。仅在使用 GSSAPI 身份验证机制时有效。

SERVICE_NAME 对于所有客户端和 MongoDB 实例，默认为 mongodb。如果更改 MongoDB 实例上的 saslServiceName 设置，则必须设置 SERVICE_NAME 以匹配该设置。仅在使用 GSSAPI 身份验证机制时有效。

CANONICALIZE_HOST_NAME:true|false

连接到 Kerberos 服务器时规范化客户端托管计算机的主机名。当主机报告的主机名与 Kerberos 数据库中的主机名不同时，这可能是必需的。默认值为 false。仅在使用 GSSAPI 身份验证机制时有效。

SERVICE_REALM:<string>

为 MongoDB 服务设置 Kerberos Realm。这对于支持跨 Realm 的身份验证（在此情况下，用户存在于一个 Realm，而服务则存在于另一 Realm 中）可能是必需的。仅在使用 GSSAPI 身份验证机制时有效。

AWS_SESSION_TOKEN:<security_token>

设置Amazon Web Services 会话令牌，以便在使用 AssumeRole 时使用临时凭证进行身份验证 请求，或使用指定此值的Amazon Web Services 资源（例如Lambda ）时。仅在使用MONGODB-AWS身份验证机制时有效。 您还必须拥有Amazon Web Services访问权限密钥ID和秘密访问权限密钥。 有关使用示例，请参阅连接到Atlas集群。

在连接到启用了 Kerberos 的MongoDB 实例时，负责设置 Kerberos 服务名称。该值必须与您要连接的 MongoDB 实例上所设的服务名称相匹配。

对于所有客户端和MongoDB实例，saslServiceNamegssapiServiceName 默认为mongodb 。如果更改MongoDB实例上的 设置，则必须设立gssapiServiceName 以匹配该设置。

gssapiServiceName是authMechanismProperties=SERVICE_NAME:mongodb 已弃用的别名。有关您的驾驶员支持哪些选项以及它们之间的相对优先级的更多信息，请参阅您的首选驾驶员版本的文档。