连接字符串URI格式_MonogDB 中文网

MongoDB 中文手册

参考 > 参考 > 连接字符串URI格式

在本页面

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

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

连接字符串格式¶

您可以使用以下任一方式指定MongoDB连接字符串：

的标准连接字符串的格式或
在DNS种子列表连接形式。

标准连接字符串格式¶

本部分描述用于连接到MongoDB部署的MongoDB连接URI的标准格式：独立，副本集或分片群集。

标准URI连接方案具有以下形式：

复制

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

例子¶

单机版
副本集
分片集群

对于独立版本：
复制
```
mongodb://mongodb0.example.com:27017
```
对于强制执行访问控制的独立服务器：
复制
```
mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:27017/?authSource=admin
```
如果用户名或密码包含at符号@，冒号:，斜杠/或百分号%字符，请使用百分比编码。

注意

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

对于副本集，请包括该replicaSet 选项。

对于副本集：

复制

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

对于实施访问控制的副本集，请包括用户凭证：
复制
```
mongodb://myDBReader:D1fficultP%40ssw0rd@mongodb0.example.com:27017,mongodb1.example.com:27017,mongodb2.example.com:27017/?authSource=admin&replicaSet=myRepl
```
如果用户名或密码包含at符号@，冒号:，斜杠/或百分号%字符，请使用百分比编码。

注意

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

对于分片群集：

复制

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

对于实施访问控制的分片群集，请包括用户凭证：
复制
```
mongodb://myDBReader:D1fficultP%40ssw0rd@mongos0.example.com:27017,mongos1.example.com:27017,mongos2.example.com:27017/?authSource=admin
```
如果用户名或密码包含at符号@，冒号:，斜杠/或百分号%字符，请使用百分比编码。

有关更多示例，请参见示例。

组件¶

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

零件	描述
`mongodb://`	必需的前缀，用于标识这是标准连接格式的字符串。
`username:password@`	可选的。身份验证凭据。如果指定，则客户端将尝试向验证用户`authSource`。如果 `authSource`未指定，则客户端将尝试向验证用户`defaultauthdb`。如果`defaultauthdb`未指定，则发送到`admin` 数据库。如果用户名或密码包含at符号`@`，冒号`:`，斜杠`/`或百分号`%`字符，请使用百分比编码。另请参阅`authSource`。
`host[:port]`	`mongod`实例（或分片`mongos` 群集的实例）运行所在的主机（和可选的端口号）。您可以指定主机名，IP地址或UNIX域套接字。根据您的部署拓扑指定尽可能多的主机：对于独立`mongod`实例，请指定独立实例的主机名。对于副本集，指定`mongod` 副本集配置中列出的实例的主机名。对于分片群集，请指定`mongos`实例的主机名。如果未指定端口号，`27017` 则使用默认端口。
`/defaultauthdb`	可选的。如果连接字符串包含`username:password@` 身份验证凭据但未`authSource`指定选项，则使用的身份验证数据库。如果`authSource`和`defaultauthdb`都未指定，则客户端将尝试向`admin`数据库认证指定的用户。
`?<options>`	可选的。查询字符串，将连接特定的选项指定为`<name>=<value>`对。有关这些选项的完整说明，请参见连接字符串选项。如果连接字符串未指定数据库/，则必须`/`在最后一个`host`和以`?`选项字符串开头的问号（）之间指定斜杠（）。

DNS的seedlist连接格式¶

3.6版的新功能。

除标准连接格式外，MongoDB还支持 DNS构造的种子列表。使用DNS构造可用的服务器列表，可以提供更大的部署灵活性，并可以轮流更改服务器而无需重新配置客户端。

为了利用DNS种子列表，请使用连接字符串前缀 mongodb+srv:而不是standard mongodb:。该+srv 指示的客户端遵循对应于DNS SRV记录的主机名。然后，驱动程序或mongo外壳程序将查询DNS以获取记录，以确定哪些主机正在运行 mongod实例。

注意

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

以下示例显示了DNS种子列表连接字符串的典型连接字符串：

复制

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种子列表连接字符串支持将选项指定为查询字符串。随着DNS的seedlist连接字符串，可以还指定通过TXT记录下列选项：

replicaSet
authSource

每个mongod实例只能指定一个TXT记录。如果DNS中出现多个TXT记录和/或TXT记录包含除replicaSet或以外的选项authSource，则客户端将返回错误。

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

复制

Record              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记录中指定的选项。在下面的示例中，查询字符串提供了authSource上面DNS条目的TXT记录中配置的选项的替代。

复制

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

注意

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

看到

使用DNS种子列表连接格式连接到副本集提供了一个使用DNS种子列表连接格式将mongo外壳连接到副本集的示例。

连接字符串选项¶

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

连接选项是成对的，格式如下：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

连接选项	描述
`replicaSet`¶	指定的名称副本集，如果 `mongod`是副本集的成员。连接到副本集时，请将副本集成员的种子列表提供给`host[:port]`uri 的组件。有关特定的详细信息，请参阅驱动程序文档。

连接选项¶

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

连接选项	描述
`tls`¶	为连接启用或禁用TLS / SSL： `true`：使用TLS / SSL启动连接。DNS种子列表连接格式的默认设置。 `false`：在没有TLS / SSL的情况下启动连接。标准连接字符串格式的默认设置。注意该`tls`选项等效于该 `ssl`选项。如果`mongo`外壳程序在命令行中指定了其他 tls / ssl选项，请改用`--tls` 命令行选项。 4.2版中的新功能。
`ssl`¶	用于为连接启用或禁用TLS / SSL的布尔值： `true`：使用TLS / SSL启动连接。DNS种子列表连接格式的默认设置。 `false`：在没有TLS / SSL的情况下启动连接。标准连接字符串格式的默认设置。注意该`ssl`选项等效于该 `tls`选项。如果`mongo`外壳程序在命令行中指定了其他 tls / ssl选项，请改用`--ssl` 命令行选项。
`tlsCertificateKeyFile`¶	指定`.pem`包含客户端的TLS / SSL证书或客户端的TLS / SSL证书和密钥的本地文件的位置。客户端将此文件呈现给 `mongod`/ `mongos`实例。并非所有驱动程序都支持此选项。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。 4.2版中的新功能。
`tlsCertificateKeyFilePassword`¶	指定用于解密的密码 `tlsCertificateKeyFile`。并非所有驱动程序都支持此选项。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。 4.2版中的新功能。
`tlsCAFile`¶	指定`.pem`包含来自证书颁发机构的根证书链的本地文件的位置。此文件用于验证`mongod`/ `mongos` 实例提供的证书。并非所有驱动程序都支持此选项。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。 4.2版中的新功能。
`tlsAllowInvalidCertificates`¶	绕过`mongod`/ `mongos`实例提供的证书的验证设置为`true`连接到MongoDB实例，即使服务器当前存在无效证书。并非所有驱动程序都支持此选项。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。警告禁用证书验证会产生漏洞。 4.2版中的新功能。
`tlsAllowInvalidHostnames`¶	禁用`mongod`/ `mongos`实例提供的证书的主机名验证。设置为`true`连接到MongoDB实例，即使服务器证书中的主机名与服务器的主机不匹配也是如此。并非所有驱动程序都支持此选项。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。警告禁用证书验证会产生漏洞。 4.2版中的新功能。
`tlsInsecure`¶	禁用各种证书验证。设置为`true`禁用证书验证。禁用的确切验证因驱动程序而异。请参阅驱动程序文档。此连接字符串选项不可用的`mongo` 外壳和MongoDB的实用程序（例如`mongodump`， `mongorestore`）。请改用命令行选项。警告禁用证书验证会产生漏洞。 4.2版中的新功能。

超时选项¶

连接选项	描述
`connectTimeoutMS`¶	超时之前尝试连接的时间（以毫秒为单位）。默认值是永不超时，尽管不同的驱动程序可能有所不同。请参阅驱动程序文档。
`socketTimeoutMS`¶	尝试超时之前在套接字上尝试发送或接收的时间（以毫秒为单位）。默认值是永不超时，尽管不同的驱动程序可能有所不同。请参阅驱动程序文档。

压缩选项¶

连接选项描述

compressors¶

逗号分隔的压缩字符串，用于启用网络压缩以在此客户端和mongod/ mongos 实例之间进行通信。

您可以指定以下压缩器：

活泼的
zlib（在MongoDB 3.6或更高版本中可用）
zstd（在MongoDB 4.2或更高版本中可用）

如果指定多个压缩器，则列出压缩器的顺序以及通信启动器都很重要。例如，如果客户机指定了以下网络压缩机"zlib,snappy"和所述mongod指定 "snappy,zlib"，在客户端和之间的消息 mongod的用途zlib。

重要

当双方都启用网络压缩时，消息将被压缩。否则，双方之间的消息将不被压缩。

如果各方不共享至少一个公共压缩器，则各方之间的消息将不被压缩。

从MongoDB 4.0.5（和MongoDB 3.6.10）开始， mongoshell支持uri连接字符串option compressors。

zlibCompressionLevel¶

一个整数，如果将zlib用于则指定压缩级别。network compression

您可以指定一个介于-1到之间的整数值9：

值	笔记
`-1`	默认压缩级别，通常是级别`6`压缩。
`0`	无压缩
`1` -- `9`	增加压缩级别但以速度为代价，具有： `1` 提供最佳速度，但压缩最少，并且 `9` 提供最佳压缩效果，但速度最慢。

mongo外壳不支持。

连接池选项¶

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

连接选项	描述
`maxPoolSize`¶	连接池中的最大连接数。默认值为`100`。
`minPoolSize`¶	连接池中的最小连接数。默认值为`0`。注意 `minPoolSize`并非所有驱动程序都支持该选项。有关驱动程序的信息，请参阅驱动程序文档。
`maxIdleTimeMS`¶	在删除和关闭连接之前，连接在池中可以保持空闲状态的最大毫秒数。并非所有驱动程序都支持此选项。
`waitQueueMultiple`¶	驱动程序将`maxPoolSize` 值乘以的数字，以提供允许最大数量的线程等待连接从池中可用。有关默认值，请参见/ drivers 文档。并非所有驱动程序都支持此选项。
`waitQueueTimeoutMS`¶	线程可以等待连接可用的最长时间（以毫秒为单位）。有关默认值，请参见 / drivers文档。并非所有驱动程序都支持此选项。

编写关注选项¶

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

MongoDB驱动程序
mongo 贝壳
mongofiles
mongoimport
mongorestore

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

到副本集的以下连接字符串"majority"使用wtimeoutMSwrite担忧参数指定了写入关注和5秒钟的超时：

复制

mongodb://db0.example.com,db1.example.com,db2.example.com/?replicaSet=myRepl&w=majority&wtimeoutMS=5000

连接选项	描述
`w`¶	对应于写选项w Option。该`w`选项请求确认写操作已传播到指定数量的`mongod`实例或 `mongod`具有指定标签的实例。您可以指定`number`，字符串`majority`或。`tag set` 有关详细信息，请参见w选项。
`wtimeoutMS`¶	对应于写担忧wtimeout。 `wtimeoutMS`指定写关注的时间限制（以毫秒为单位）。如果`wtimeoutMS`是`0`，写操作永远不会超时。有关更多信息，请参见wtimeout。
`journal`¶	对应于写关注点j Option选项。该 `journal`选项要求MongoDB确认已将写操作写入日志。有关详细信息，请参见j选项。如果设置`journal`为`true`，并指定 `w`v