创建客户端

在服务器版本 >= 3.4 中建立连接时打印到 mongod 日志的应用程序名称。

String

无

指定要使用的身份验证机制。 可以是以下值之一： :gssapi 、 :mongodb_cr 、 :mongodb_x509 、 :plain 、 :scram 、 :scram256 。 GSSAPI (Kerberos) 身份验证需要额外的依赖项。

Symbol

如果未提供用户档案，则nil . 如果提供了用户凭证，则默认值取决于服务器版本。 MongoDB 4.0 及更高版本：如果用户档案对应于支持:scram256 SCRAM-SHA-256 身份验证的用户，则为:scram ，否则为 。MongoDB 3.0-3.6： :scram 。 MongoDB 2.6： :mongodb_cr

提供其他身份验证机制属性。

属性中的键不区分大小写。 创建客户端时，密钥为小写。

Hash

使用 GSSAPI 身份验证机制时，默认属性为{service_name: "mongodb"} 。 否则默认值为 nil。

指定身份验证源。

String

对于 MongoDB 2.6 及更高版本：如果提供了档案，则为admin ，否则为当前数据库

用于配置自动加密的Hash选项。

• :key_vault_client - 连接到存储加密数据密钥的 MongoDB 实例的客户端（ Mongo::Client ，默认为顶级客户端实例）。

• :key_vault_namespace - 密钥保管库集合的命名空间，格式为"database.collection" （必须为String ）。

• :kms_providers — 密钥管理服务配置信息。 必须指定:local和:aws键之一或两个（ Hash ，必需）。 有关此选项的更多信息，请参阅客户端加密教程的“ kms_providers选项”部分。

• :schema_map - 一个或多个collection的 JSONSchema，指定应加密哪些字段（ Hash ，可选，defaults为nil ）。

• :bypass_auto_encryption - 执行数据库操作时是否跳过自动加密（ Boolean ，默认为false ）。

• :extra_options - 与生成 mongocryptd 相关的选项（ Hash ，可选，默认为nil ）。

有关格式化这些选项的更多信息，请参阅客户端加密教程中的“自动加密选项”部分。

Hash

无

实验性的。 控制当背景线程中发生错误时是否以及如何记录回溯。如果为true ，驱动程序将记录完整的回溯。 如果设置为正整数，则驱动程序将记录最多那么多的回溯行。 如果设置为false或nil ，则不会记录任何回溯。 其他值均会出错。

true, false , nil , Integer

无

要使用的潜在压缩器列表（按优先顺序排列）。 有关驱动程序如何实现压缩的详细信息，请参阅下文。

Array<String>

无

已弃用。 禁用通常由驱动程序执行的部署拓扑结构发现，并强制集群结构为特定类型。有效值为:direct 、 :load_balanced 、 :replica_set或:sharded 。 如果使用:load_balanced ，则客户端的行为就像已连接到负载均衡器一样，无论其连接的服务器是否将自身公布为负载均衡器。

Symbol

无

引发异常之前等待建立套接字连接的秒数。 此超时还用于 SRV DNS 记录解析。 nil和0平均值无超时。如果传递了无效的超时值（例如负值或非数字值），则创建客户端将失败并显示错误。

Float

10

要连接的数据库的名称。

String

管理员

直接连接到指定主机，不发现部署拓扑结构。

Boolean

false

服务器监控器异步刷新服务器状态的秒数。

Float

10

用于生成文档 ID 的自定义对象。 必须响应#generate。

Object

无

是否期望连接到负载均衡器。

Boolean

false

指定最近的服务器和可供选择进行操作的服务器之间的最大延迟（以秒为单位）。

Float

0.015

自定义记录器。

Object

Logger

连接池尝试并行建立的最大连接数。

Integer

2

连接在被连接池关闭之前可以处于空闲状态的最长时间（以秒为单位）。

Warning: when connected to a load balancer, the driver uses existing connections for iterating cursors (which includes change streams) and executing transactions. 通过此选项设置空闲时间可能会导致驱动程序关闭后续操作所需的连接，从而导致这些操作失败。

Integer

无

每个服务器连接池的最大大小。 将此选项设置为零会删除连接池的最大大小限制，允许其增长到任意数量的连接。

Integer

20

使用旧版读取重试时的最大读取重试次数。设置为 0 可禁用旧版读取重试。

Integer

1

使用旧版写入重试时的最大写入重试次数。设置为 0 可禁用旧版写入重试。

Integer

1

每个服务器连接池中的最小连接数。 驱动程序将在背景建立连接，直到池包含这么多连接。

Integer

0

监控对象。

Object

无

用于进行身份验证的用户的密码。

String

无

在服务器版本 >= 3.4 中建立连接时打印到 mongod 日志的元数据中包含的平台信息。

String

无

将用于选择服务器的读取偏好模式和标签集指定为Hash 。 哈希中允许的键为:mode 、 :tag_sets和:max_staleness 。

{ read:
  { mode: :secondary,
    tag_sets: [ "data_center" => "berlin" ],
    max_staleness: 5,
  }
}

如果提供了标签集，则它们必须是哈希数组。 如果服务器的标签与所提供的标签集中的任何一个哈希匹配，则服务器满足读取偏好（read preference）。

每个标签集都必须是哈希值，并且在用于服务器选择之前会在内部转换为BSON::Document实例。 哈希键可以是字符串或符号。 按键区分大小写。 哈希值必须是字符串，并且与副本集配置中的值完全匹配。

Hash

{ :mode => :primary }

指定读关注（read concern）选项。 唯一有效的键是level ，其有效值为:local 、 :available 、 :majority 、 :snapshot和:linearizable 。

Hash

无

重试读取 mongos 的时间间隔（以秒为单位）。

Integer

5

连接到副本集时，这是用于筛选服务器的副本集的名称。

String

无

如果单声明写入操作因网络错误而失败，驱动程序会在连接到服务器版本 3.6+ 时自动重试一次。

Boolean

true

由于客户端在构建完成后立即开始在后台监控部署，因此构建客户端然后在单独的语句中订阅SDAM事件可能会导致订阅者收不到某些 SDAM 事件。 :sdam_proc选项允许在发布任何 SDAM 事件之前在正在构建的客户端上添加事件订阅者。

传递一个Proc ，它将在客户端的事件订阅机制初始化之后但在任何服务器添加到客户端之前以Client作为参数进行调用。 使用此Proc在客户端上设置 SDAM 事件订阅者。

注意：当:sdam_proc is invoked, in particular the cluster is nil at this time. ``:sdam_proc过程中提供的Proc应将自身限制为仅在传递的客户端上调用Client#subscribe和Client#unsubscribe方法时，客户端尚未完全构建。

Proc

无

请求的服务器 API 版本。 这是一个包含以下允许项的哈希值：- :version （字符串）- :strict （true 或 false）- :deprecation_errors （true 或 false）

请注意，服务器 API 版本只能指定为 Ruby 选项，而不能指定为 URI 选项，并且不能针对数据库和 collection 对象进行覆盖。

如果在客户端上更改服务器 API 版本（例如通过with调用），则整个 API 版本哈希将替换为新规范（不合并新旧单个字段）。

Hash

无

在引发异常之前等待选择适当的服务器来执行操作的秒数。

Float

30

在引发异常之前等待在套接字上执行操作的秒数。 nil和0平均值无超时。如果传递了无效的超时值（例如负值或非数字值），则创建客户端将失败并显示错误。

Float

无

驱动程序在分片拓扑结构中与之通信的 mongos 的最大数量。 如果该选项设置为 0，则没有最大 mongoses 数量限制。 如果给定 URI 解析的主机数量超过:srv_max_hosts ，则客户端将随机选择:srv_max_hosts大小的主机子集。 请注意，驱动程序在客户端构造期间忽略的主机将永远不会被使用。 如果驱动程序选择的主机不可用，则客户端将完全停止工作，即使部署具有其他功能正常的 mongos。

Integer

0

要在 SRV DNS 查询中使用的服务名称。

String

mongodb

指示客户端通过 TLS 连接到服务器。

Boolean

false

包含串联的证书颁发机构证书的文件路径，用于验证从连接另一端传递的证书。 :ssl_verify需要:ssl_ca_cert 、 :ssl_ca_cert_string或:ssl_ca_cert_object之一（按优先级顺序）。

String

无

表示证书颁发机构证书的 OpenSSL::X509::Certificate 数组，用于验证从连接另一端传递的证书。 :ssl_verify需要:ssl_ca_cert 、 :ssl_ca_cert_string或:ssl_ca_cert_object之一（按优先级顺序）。

Array< OpenSSL::X509::Certificate >

无

包含连接的证书颁发机构证书的字符串，用于验证从连接另一端传递的证书。 :ssl_verify需要:ssl_ca_cert 、 :ssl_ca_cert_string或:ssl_ca_cert_object之一（按优先级顺序）。

String

无

用于向 MongoDB Server 标识应用程序的客户端证书文件的路径。该文件还可能包含证书的私钥；如果是这样，则该选项将忽略私钥。 该文件还可能包含形成从客户端证书到 CA 证书的证书链的中间证书；所有中间证书都将由驱动程序进行解析，并提供给extra_chain_cert属性中的 OpenSSL 上下文。 如果提供了中间证书，则它们必须位于客户端证书之后，客户端证书必须是文件中的第一个证书。

此选项（如果存在）优先于:ssl_cert_string和:ssl_cert_object选项。

String

无

OpenSSL::X509::Certificate 用于向 MongoDB Server 标识应用程序。通过此选项只能传递一个证书。

OpenSSL::X509::Certificate

无

包含 PEM 编码证书的字符串，用于向 MongoDB Server 标识应用程序。该字符串还可能包含证书的私钥；如果是这样，则该选项将忽略私钥。 该字符串还可能包含形成从客户端证书到 CA 证书的证书链的中间证书；所有中间证书都将由驱动程序进行解析，并提供给extra_chain_cert属性中的 OpenSSL 上下文。 如果提供了中间证书，则它们必须位于客户端证书之后，客户端证书必须是字符串中的第一个证书。

此选项（如果存在）优先于:ssl_cert_object选项。

String

无

用于识别针对 MongoDB 的连接的私钥文件。 请注意，即使密钥与证书存储在同一文件中，也需要显式指定两者。 此选项（如果存在）优先于 :ssl_key_string 和 :ssl_key_object 的值。

String

无

用于识别针对 MongoDB 的连接的私钥。

OpenSSL::PKey

无

私钥的密码。

String

无

包含 PEM 编码私钥的字符串，用于识别针对 MongoDB 的连接。 此参数（如果存在）优先于选项 :ssl_key_object 的值。

String

无

是否执行对等互连证书、主机名和 OCSP 端点验证。请注意，如果设置了:ssl_verify_certificate ，则是否验证证书的决定将被覆盖；如果设置了:ssl_verify_hostname ，则是否验证主机名的决定将被覆盖；如果设置了:ssl_verify_ocsp_endpoint ，则是否验证 OCSP 端点的决定将被覆盖。 已设置。

Boolean

true

是否执行对等互连证书验证。在是否执行证书验证方面，此设置会覆盖:ssl_verify设置。

Boolean

true

是否执行对等互连主机名验证。此设置会覆盖有关是否执行主机名验证的:ssl_verify设置。

Boolean

true

如果证书中指定了 OCSP 端点，是否根据证书中指定的 OCSP 端点验证服务器提供的证书。 在是否执行 OCSP 端点验证方面，此设置会覆盖 :ssl_verify。

Boolean

true

是否按默认的 250 个字符截断日志。

Boolean

true

要进行身份验证的用户的名称。

String

无

等待连接池中的连接变为可用状态的秒数。

Float

10

有关包装驱动程序的库（例如 ODM）的信息。 首先指定较低级别的库。 允许的哈希键：:name、:version、:platform。 示例： [name: 'Mongoid', version: '7.1.2']

Array<Hash>

无

已弃用。 相当于:write_concern选项。 如果同时指定了:write和:write_concern ，则它们的值必须相同。

Hash

{ w: 1 }

将写关注（write concern）选项指定为Hash 。哈希中的键可以是:w 、 :wtimeout 、 :j 、 :fsync 。 请注意， :wtimeout的单位是毫秒，而不是秒。

{ write_concern: { w: 2 } }

Hash

{ w: 1 }

要使用的 Zlib 压缩级别（如果使用压缩）。 有关有效级别，请参阅 Ruby 的 Zlib 模块。

Integer

无

:app_name => String

:auth_mech => Symbol

身份验证机制值按如下方式从 URI 选项转换为 Ruby 选项：

• GSSAPI => :gssapi

• MONGODB-CR => :mongodb_cr

• MONGODB-X509 => :mongodb_x509

• PLAIN => :plain

• SCRAM-SHA-1 => :scram

• SCRAM-SHA-256 => :scram256

如果为身份验证机制提供了不同的值，则会将其转换为未修改的 Ruby 选项，并保留其String类型。 请注意，虽然该驱动程序目前允许使用无法识别的身份验证机制构造Client 实例，但此行为 可能会在未来版本的驱动程序 中发生变化。 。

{ :auth_mech_properties => { :service_realm => String, :canonicalize_host_name => true|false, :service_name => String } }

指定为以逗号分隔的键:值对，例如 "SERVICE_REALM:foo,CANONICALIZE_HOST_NAME:TRUE" 。

:auth_source => String

:compressors => Array<String>

以逗号分隔的潜在要使用的压缩器列表，按优先顺序排列。 有关驱动程序如何实现压缩的详细信息，请参阅下文。

:connect => Symbol

此处接受的值与:connect Ruby 选项接受的值相同。 对于多单词值，必须使用下划线分隔单词来提供值，即connect=replica_set和connect=load_balanced 。

:connect_timeout => Float

与相应的 Ruby 选项不同，相应的 Ruby 选项因值无效（例如 负值和非数字值），通过此 URI 选项提供的无效值将被忽略，并显示警告。

:direct_connection => Boolean

{ :write_concern => { :fsync => true|false }}

:heartbeat_frequency => Float

{ :write_concern => { :j => true|false }}

:load_balanced => Boolean

:local_threshold => Float

:max_connecting => Integer

:max_idle_time => Float

{ :read => { :max_staleness => Integer }}

如果 maxStalenessSeconds URI 选项值为 -1，则驱动程序会将其视为根本未给出该选项。 否则，如果选项值为数字，则 Ruby 选项将设置为转换为Integer的指定值。 请注意，大于 0 但小于 90 或小于 -1 的数值会被Client构造函数接受，但会导致服务器选择失败（除非通过with方法更改选项，例如通过对驱动程序执行的任何操作）。 如果选项值是非数字值，则会被忽略，并且驱动程序会将这种情况视为根本未给出该选项。

:max_pool_size => Integer

:min_pool_size => Integer

:read_concern => Hash

{ :read => { :mode => Symbol }}

{ :read => { :tag_sets => Array<Hash> }}

readPreferenceTags 字段的每个实例都是逗号分隔的键:值对，将按照指定顺序出现在 :tag_sets 数组中。实例， "readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny"将转换为[ { 'dc' => 'ny', 'rack' => '1' }, { 'dc' => 'ny' }] 。

:replica_set => String

:retry_writes => boolean

:server_selection_timeout => Float

:socket_timeout => Float

与相应的 Ruby 选项不同，相应的 Ruby 选项因值无效（例如 负值和非数字值），通过此 URI 选项提供的无效值将被忽略，并显示警告。

:srv_max_hosts => Integer

:srv_service_name => String

:ssl => true|false

:ssl => boolean

:ssl_verify_certificate => boolean

由于tlsAllowInvalidCertificates使用true表示应禁用验证，而ssl_verify_certificate使用false表示应禁用验证，因此在用于设置ssl_verify_certificate之前，布尔值会被反转。

:ssl_verify_hostname => boolean

由于tlsAllowInvalidHostnames使用true表示应禁用验证，而ssl_verify_hostname使用false表示应禁用验证，因此在用于设置ssl_verify_hostname之前，布尔值会被反转。

:ssl_ca_cert => String

:ssl_cert => String

:ssl_key => String

:ssl_key_pass_phrase => String

:ssl_verify_ocsp_endpoint => boolean

由于tlsDisableOCSPEndpointCheck使用true表示应禁用验证，而ssl_verify_ocsp_endpoint使用false表示应禁用验证，因此在用于设置ssl_verify_ocsp_endpoint之前，布尔值会被反转。

:ssl_verify => boolean

由于 tlsInsecure 使用true来表示应禁用验证，而ssl_verify使用false来表示应禁用验证，因此在用于设置ssl_verify之前，布尔值会被反转。

{ :write_concern => { :w => Integer|String }}

:wait_queue_timeout => Float

{ :write_concern => { :wtimeout => Integer }}

:zlib_compression_level => Integer