连接字符串URI格式

在本页面

• 连接字符串格式
• 连接字符串选项
• 例子

本文档介绍了URI格式，用于在官方MongoDB drivers.定义应用程序和MongoDB实例之间的连接 。有关驱动程序的列表和驱动程序文档的链接，请参见drivers。

连接字符串格式

你可以指定MongoDB连接字符串使用任何:

• the 标准连接字符串格式

• the DNS Seedlist 连接格式.

  标准连接字符串格式

本节描述用于连接到MongoDB部署的MongoDB连接URI的标准格式:独立、复制集或分片集群。

标准的URI连接方案有如下形式:

mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]

例子

• 单机版

  1.对于独立版本

mongodb://mongodb0.example.com:27017

​ 2. 对于一个强制访问控制:

mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:27017/?authSource=admin

• 复制集

注意

对于一个复制集，指定副本集配置中列出的mongod实例的主机名。

对于复制集，包括replicaSet 选项。

​ 1.对于一个复制集:

mongodb://mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/?replicaSet=myRepl

​ 2.对于强制访问控制的复制集，包括用户凭证:

mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/?authSource=admin&replicaSet=myRepl

• 分片集群

注意

对于分片集群的连接字符串，在连接字符串中指定mongos主机。

​ 1.对于分片集群:

mongodb://mongos0.example.com:27017,mongos1.example.com:27017,mongos2.example.com:27017

​ 2.对于实施访问控制的分片集群，包括用户凭证:

mongodb://myDBReader:D1fficultP%40ssw0rd@mongos0.example.com:27017,mongos1.example.com:27017,mongos2.example.com:27017/?authSource=admin

如果用户名或密码包含at符号@，冒号:，斜杠/或百分号%字符，请使用百分比编码

更多示例，请参见examples。

组件

标准的URI连接字符串包括以下组件:

DNS Seedlist 连接格式

新增3.6版

除了标准的连接格式，MongoDB还支持一个DNS构造的Seedlist列表。使用DNS构造可用服务器列表允许更灵活的部署，并允许在不重新配置客户机的情况下轮流更改服务器。

为了利用DNSSeedlist列表，使用一个连接字符串前缀 mongodb+srv:，而不是标准的 mongodb:。+srv向客户端表明后面的主机名对应于一个DNS srv记录。驱动程序或mongoshell将查询DNS记录，以确定哪些主机正在运行mongod实例。

注意

使用 +srv 连接字符串修饰符自动将该连接的tls(或等效的ssl)选项设置为true。您可以通过将查询字符串中的tls (或等效ssl)选项显式设置为false通过 tls=false（或ssl=false）来覆盖此行为。

下面的例子显示了一个典型的DNS seedlist连接字符串的连接字符串:

mongodb+srv://server.example.com/

对应的DNS配置如下:

Record                            TTL   Class    Priority Weight Port  Target
_mongodb._tcp.server.example.com. 86400 IN SRV   0        5      27317 mongodb1.example.com.
_mongodb._tcp.server.example.com. 86400 IN SRV   0        5      27017 mongodb2.example.com.

重要

SRV记录中返回的主机名必须与给定的主机名共享相同的父域(在本例中为example.com)。如果父域名和主机名不匹配，您将无法连接。

与标准连接字符串一样，DNS seedlist连接字符串支持将选项指定为查询字符串。使用DNSseedlist列表连接字符串，您还可以通过TXT记录指定以下选项:

• replicaSet
• authSource

您只能为每个mongod实例指定一个TXT记录。如果多个TXT记录出现在DNS/或如果TXT记录包含一个选项，而不是replicaSet或authSource，客户端将返回一个错误。

TXT记录server.example.comDN条目类似于：

    记录                    TTL      Class                     Text
server.example.com.       86400    IN TXT“            replicaSet = mySet＆authSource = authDB”

综合起来，DNS SRV记录和TXT记录中指定的选项解析为以下标准格式的连接字符串:

mongodb://mongodb1.example.com:27317,mongodb2.example.com:27017/?replicaSet=mySet&authSource=authDB

您可以通过在查询字符串中传递选项来重写TXT记录中指定的选项。在下面的示例中，查询字符串为TXT中配置的authSource选项提供了重写记录上面的DNS条目。

mongodb + srv：//server.example.com/？connectTimeoutMS = 300000＆authSource = aDifferentAuthDB

给定authSource的重写，标准格式的等效连接字符串为:

mongodb：//mongodb1.example.com：27317，mongodb2.example.com：27017 /？connectTimeoutMS = 300000＆replicaSet = mySet＆authSource = aDifferentAuthDB

注意

如果没有与连接字符串中标识的主机名对应的可用DNS记录，mongodb+srv选项将失败。此外，使用+srv连接字符串修饰符会自动为连接设置tls（或等效 ssl）选项true。您可以通过将查询字符串中的tls (或等效ssl)选项显式设置为false通过 tls=false（或ssl=false）来覆盖此行为。

请看：

使用DNSSeedlist列表连接格式连接到复制集提供一个使用DNSseedlist列表连接格式连接mongo shell到复制集的示例。

连接字符串选项

本节列出了所有连接选项。

连接选项是成对的，格式如下：name=value。

• name使用驱动程序时，该选项不区分大小写。
• name使用4.2+版本的mongoShell 时，该选项不区分大小写 。
• name使用4.0版或更早版本的mongoShell 时，此选项区分大小写。
• value始终是区分大小写的。

用&字符分隔选项(即:&)name1=value1&name2=value2。在以下示例中，连接包括replicaSet和 connectTimeoutMS选项：

mongodb：//db1.example.net：27017，db2.example.net：2500 /？replicaSet = test＆connectTimeoutMS = 300000

用于连接字符串参数的分号分隔符:

为了提供向后兼容性，驱动程序目前接受分号(即;)作为选项分隔符。

复制集选项

以下连接字符串到一个名为myRepl的复制集，成员运行在指定的主机上:

mongodb：//db0.example.com：27017，db1.example.com：27017，db2.example.com：27017 /？replicaSet = myRepl

连接选项

TLS选项

下面的连接字符串到一个复制集包括 tls=true选项(在MongoDB 4.2可用):

mongodb：//db0.example.com,db1.example.com,db2.example.com/？replicaSet = myRepl＆tls = true

或者，你也可以使用等价的ssl=true选项:

mongodb：//db0.example.com,db1.example.com,db2.example.com/？replicaSet = myRepl＆ssl = true

超时选项

压缩选项

连接池选项

大多数驱动程序实现某种类型的连接池处理。有些驱动程序不支持连接池。有关连接池实现的更多信息，请参见驱动程序文档。这些选项允许应用程序在连接到MongoDB部署时配置连接池。

写关注选项

写关注描述了MongoDB请求的确认级别。下列情况支持写关注选项：

• MongoDB驱动程序
• mongo shell
• mongofiles
• mongoimport
• mongorestore

您可以在连接字符串中指定写关注，也可以将其指定为诸如insert或update等方法的参数。如果在两个地方都指定了写关注点，则method参数将覆盖连接字符串设置。

下面的连接字符串到一个复制集指定 "majority"写关注和5秒超时使用wtimeoutMS写关注参数:

mongodb：//db0.example.com,db1.example.com,db2.example.com/？replicaSet = myRepl＆w = majority＆wtimeoutMS = 5000

有关更多信息，请参见写关注点。

readConcern选项

版本3.2中的新特性:对于WiredTiger存储引擎，MongoDB 3.2为复制集和复制集分片引入了readConcern选项。

Read Concern允许客户端为从复制集读取选择隔离级别。

下面的复制集连接字符串指定 readConcernLevel=majority：

mongodb：//db0.example.com,db1.example.com,db2.example.com/？replicaSet = myRepl＆readConcernLevel = majority

有关更多信息，请参见读关注。

阅读首选项选项

读取首选项描述了与复制集相关的读取操作的行为。这些参数允许您在连接字符串中以每个连接为基础指定读取首选项。

注意

要使用驱动程序指定已对冲的读取选项，请参考 驱动程序的读取首选项API。

例如：

• 以下到复制集的连接字符串指定 secondary读取首选项模式和maxStalenessSeconds120秒的值：

  mongodb：//db0.example.com,db1.example.com,db2.example.com/？replicaSet = myRepl＆readPreference = secondary＆maxStalenessSeconds = 120
  

• 以下到分片群集的连接字符串指定 secondary读取首选项模式和maxStalenessSeconds120秒的值：

  mongodb：//mongos1.example.com,mongos2.example.com/？readPreference = secondary＆maxStalenessSeconds = 120
  

• 以下到分片群集的连接字符串指定 secondary读取首选项模式以及三种 readPreferenceTags：

  mongodb：//mongos1.example.com,mongos2.example.com/？readPreference = secondary＆readPreferenceTags = dc：ny，rack：r1＆readPreferenceTags = dc：ny＆readPreferenceTags =
  

使用多个readPreferenceTags时，顺序很重要。按顺序尝试readPreferenceTags，直到找到匹配项为止。一旦找到，该规范将用于查找所有符合条件的匹配成员，并忽略任何剩余的readPreferenceTags。有关详细信息，请参见标签匹配顺序。

有关更多信息，请参阅阅读首选项。

验证选项

下面到复制集的连接字符串指定admin数据库的 authSource。也就是说，根据admin数据库对用户凭据进行身份验证。

mongodb：// myDBReader：D1fficultP%40ssw0rd@mongodb0.example.com：27017，mongodb1.example.com：27017，mongodb2.example.com：27017 /？replicaSet = myRepl ＆authSource = admin

如果用户名或密码包含'at'符号@，冒号:，斜杠/或百分号%字符，请使用百分比编码。

服务器选择和查找选项

MongoDB提供以下选项来配置MongoDB驱动程序和mongos实例如何选择要将读取或写入操作定向到的服务器。

杂项配置

例子

以下提供了用于公共连接目标的示例URI字符串。

在本地运行的数据库服务器

以下连接到在默认端口上本地运行的数据库服务器：

mongodb：//本地主机

admin数据库

以下内容admin以用户身份sysop使用密码连接并登录到数据库 moon：

mongodb：// sysop：moon @ localhost

records数据库

以下内容records以用户身份sysop使用密码连接并登录到数据库 moon：

mongodb：// sysop：moon @ localhost / records

UNIX域套接字

连接到UNIX域套接字时，请使用URL编码的连接字符串。

以下连接到具有文件路径的UNIX域套接字 /tmp/mongodb-27017.sock：

mongodb：//%2Ftmp%2Fmongodb-27017.sock

注意

并非所有驱动程序都支持UNIX域套接字。有关驱动程序的信息，请参阅驱动程序 文档。

在不同计算机上具有成员的副本集

以下内容连接到具有两个成员的副本集，一个成员db1.example.net在另一个成员 上db2.example.net：

注意

对于副本集，请指定mongod 副本集配置中列出的实例的主机名。

mongodb：//db1.example.net,db2.example.com/？replicaSet = test

带有成员的副本集localhost

下面连接到副本集具有三个成员上运行localhost的端口27017，27018以及27019：

注意

对于副本集，请指定mongod 副本集配置中列出的实例的主机名。

mongodb：//本地主机，本地主机：27018，本地主机：27019 /？replicaSet = test

具有读取分布的副本集

以下内容连接到具有三个成员的副本集，并将读取内容分发给第二副本：

注意

对于副本集，请指定mongod 副本集配置中列出的实例的主机名。

mongodb：//example1.com,example2.com,example3.com/？replicaSet = test＆readPreference = secondary

具有写关注级别的副本集

以下内容连接到具有写关注点的副本集，该副本集被配置为等待跨大多数数据承载投票成员的复制成功，并具有两秒的超时。

注意

对于副本集，请指定mongod 副本集配置中列出的实例的主机名。

mongodb：//example1.com,example2.com,example3.com/？replicaSet = test＆w = majority＆wtimeoutMS = 2000

分片群集

以下连接到具有三个mongos实例的分片群集：

mongodb：//router1.example.com：27017，router2.example2.com：27017，router3.example3.com：27017 /

MongoDB Atlas集群

版本4.4中的新功能。

以下连接到已配置为支持通过AWS IAM凭证进行身份验证的MongoDB Atlas集群：

mongo'mongodb + srv：// <aws访问密钥ID>：<aws秘密访问密钥> @ cluster0.example.com / testdb？authSource = $ external＆authMechanism = MONGODB-AWS'

如本示例所示，以这种方式使用AWS IAM凭据连接到Atlas使用 和和。MONGODB-AWS [`$external authSource

如果还使用AWS会话令牌，请为其提供AWS_SESSION_TOKEN authMechanismProperties值，如下所示：

mongo'mongodb + srv：// <aws访问密钥ID>：<aws秘密访问密钥> @ cluster0.example.com / testdb？authSource = $ external＆authMechanism = MONGODB-AWS＆authMechanismProperties = AWS_SESSION_TOKEN：<aws会话令牌>'

如果AWS访问密钥ID，秘密访问密钥或会话令牌包括'at'符号@，冒号:，斜杠/或百分号%字符，则必须使用百分比编码转换这些字符 。

您也可以使用标准AWS IAM环境变量在平台上设置这些凭证 。使用mongo以下命令时，shell将检查以下环境变量：MONGODB-AWS authentication mechanism

• AWS_ACCESS_KEY_ID
• AWS_SECRET_ACCESS_KEY
• AWS_SESSION_TOKEN

如果设置，则无需在连接字符串中指定这些凭据。

以下示例在bash 外壳中设置这些环境变量：

导出AWS_ACCESS_KEY_ID ='<aws访问密钥ID>'
导出AWS_SECRET_ACCESS_KEY ='<aws秘密访问密钥>'
导出AWS_SESSION_TOKEN ='<aws会话令牌>'

在其他shell中设置环境变量的语法将有所不同。有关更多信息，请查阅您平台的文档。

您可以使用以下命令验证是否已设置这些环境变量：

env | grep AWS

设置完成后，以下示例将使用以下环境变量连接到MongoDB Atlas集群：

mongo'mongodb + srv：//cluster0.example.com/testdb？authSource = $ external＆authMechanism

参见

原文 - Connection String URI Format