Ruby操作MongoDB(进阶)-创建数据库客户端连接

Posted 2020-10-01

在Ruby的MongoDB2.4.3驱动版本中，通过创建一个Mongo::Client对象来构建一个Ruby的数据库连接。Mongo::Client构造器提供两种构造方式：一是通过提供主机列表和一些可选参数，另外还有通过一个连接URI。创建好的数据库连接默认连接到admin数据库。

1.使用Mongo::Client创建数据库客户端连接

1.1. 单服务器模式创建数据库连接

在单服务器模式下创建数据库连接，只需提供一个主机连接参数。另外，还可以通过消除自动发现步骤强制将集群拓扑转换为单机模式。可以通过下述三种方式创建单服务器模式下的数据库连接

Mongo::Client.new([‘127.0.0.1:27017‘],:database=>‘mydb‘)

Mongo::Client.new([‘127.0.0.1:27017‘],:database=>‘mydb‘,:connect=>:direct)

Mongo::Client.new(‘mongodb://127.0.0.1:27017/mydb‘)

1.2. 副本集模式创建数据库连接

通过传递一个或多个主机地址参数和副本集名字，可以创建一个到副本集的数据库连接。即使在创建时没有完全提供副本集的所有信息，MongoDB的驱动器的自动探索模式可以找到副本集中的所有成员。创建副本集中的数据库连接可以通过下面的形式创建：

Mongo::Client.new([‘127.0.0.1:27017‘,‘127.0.0.1:27018‘],:database=>‘mydb‘,:replica_set=>‘myapp‘)

Mongo::Client.new(‘mongdb://127.0.0.1:27017,127.0.0.1:27018/mydb?replicaSet=myapp‘)

1.3. 共享集群模式创建数据库连接

通过传递一个或多的Mongos 主机，来创建一个共享集群模式。自动探索模式可以限定服务器是mongos实例，但如果你关闭了自动探索模式，就要将shared参数传递到连接中来实现集群模式数据库连接的创建。通过以下三种例子可以创建数据库连接：

Mongo::Client.new([‘127.0.0.1:27017‘],:database=>‘mydb‘)

Mongo::Client.new([‘127.0.0.1:27017‘],:database=>‘mydb‘,:connect=>:shared)

Mongo::Client.new(‘mongodb://127.0.0.1:27017/mydb?connect=shared‘)

2. 数据库客户端连接参数选项

在使用Mongo::Client时，可以通过多个不同的可选参数来配置驱动的行为，可以通过在构造器中配置这些参数或者将它们通过URI提供给Mongo::Client.

鉴于URI的参数设置方式需要使用驼峰格式，这不是Ruby的标准格式。下面的表格中列出了URI格式的参数配置选项，以及相对应的使用Ruby构造器的参数选项。使用上述两种参数设置方式时需要注意URI参数设置中的选项时间单位是毫秒，而在Ruby构造器中对应的是float类型的秒。

3. URI参数及对应Ruby参数

URI选项	Ruby选项
replicaSet=String	:replica_set=>String
connect=String	:connect=>Symbol
ssl=Boolean	:ssl=>true|false
connectTimeoutMS=Integer	:connect_timeout=>Float
socketTimeoutMS=Integer	:socket_timeout=>Float
serverSelectionTimeoutMS=Integer	:server_selection_timeout=>Float
localThresholdMS=Integer	:local_threshold=>Float
maxPoolSize=Integer	:max_pool_size=>Integer

minPoolSize=Integer	:min_pool_size=>Integer
waitQueueTimeoutMS=Integer	:wait_queue_timeout=>Float
w=Integer|String	{ :write=>{:w=>Integer|String}}
wtimeoutMS=Integer	{ :write=>{:wtimeout=>Float}}
journal=Boolean	{ :write=>{:j=>true|false}}
fsync=Boolean	{ :write =>{:fsync=>true|false}}
readPreference=String	{ :read=>{:mode=>Symbol}}
readPreferenceTags=String	{ :read=>{:tag_sets=>Array<String> }}

authSource=String	:auth_source=>String
authMechanism=String	:auth_meth=>Symbol
authMechanismProperties=Strings	{ :auth_mech_properties=>{:service_realm=>String,:canonicalize_host_name=>true|false,:service_name=>String}}

4. 下面会详细讲解Ruby中每个选项的作用，默认值和类型

参数	参数描述	参数类型	默认值
:replica_set	当使用副本集模式时，该参数用于设置副本集的名字，且可以在启用自动探索模式时通过名字过滤服务器	String	none
:ssl	通知客户端通过SSL连接到服务器	Boolean	false
:ssl_cert	用于设置证书文件路径，该证书用于识别鉴定到MongoDB连接是否有效。如果设置了该选项，将会比:ssl_cret_string的值和:ssl_sret_object的值具有更高的使用优先级	String	none
:ssl_cert_string	该string字段包含了使用PEM编码的用于鉴别连接有效性的证书信息。如果设置了该参数，它比:ssl_cret_object的值具有更高的使用优先级	String	none
:ssl_cert_object	使用OpenSSL::X509::Certificate证书鉴别到MongoDB的连接	OpenSSL::X509::Certificate	none
:ssl_key	鉴别连接有效性的私钥文件。虽然秘钥文件与证书存储在同一个文件，但是两个需要被精确匹配。如果设置了该参数，它比:ssl_key_string和:ssl_key_object具有更高的使用优先级	String	none
:ssl_key_string	包含用于鉴别连接有效性的使用PEM编码的私钥字符串信息。如果设置了这个参数，它比:ssl_key_object具有更高的使用优先级	String	none
:ssl_key_object	鉴别连接有效性的私钥对象	OpenSSL::PKey	none
:ssl_key_pass_phrase	私钥的密码信息	String	none

:ssl_ca_cert	一组把授权证书连接起来的证书信息的存储路径，这些授权证书用于从连接的另一端验证证书会否通过。参数:ssl_verfiy的使用需要设置:ssl_ca_cret,:ssl_ca_cret_string,:ssl_ca_cret_object三个参数中的一个。	String	none
:ssl_ca_cert_string	包含一组把授权证书连接起来的证书信息的字符串，这些授权证书用于从连接的另一端验证证书会否通过。参数:ssl_verfiy的使用需要设置:ssl_ca_cret,:ssl_ca_cret_string,:ssl_ca_cret_object三个参数中的一个。	String	none
:ssl_ca_cert_object	代表了把授权证书连接起来的证书信息的OpenSSL::X509::Certificate数组，这些授权证书用于从连接的另一端验证证书会否通过。参数:ssl_verfiy的使用需要设置:ssl_ca_cret,:ssl_ca_cret_string,:ssl_ca_cret_object三个参数中的一个。	Array<OpenSSL::X509::Certificate>	none
:ssl_verify	用于设置是否进行对等证书验证	Boolean	false
:connect_timeout	创建一个socket连接，抛出异常之前的等待时间（秒）	Float	10秒
:socket_timeout	在一个socket执行操作抛出异常之前的等待时间（秒）	Float	5秒
:max_pool_size	单个服务器的连接池的最大连接数	Integer	5
:min_pool_size	单个服务器的连接池的最小连接数	Integer	1
:wait_queue_timeout	等待连接池中连接变为有效状态的等待时间	Float	1
:write	具体设置与写相关的Hash类型的参数。其值可以为:w,:wtimeout,:j,:fsync 如{ :write =>{ :w=>2}}	Hash	{:w=>1}

:read	Hash类型的参数，用于具体设置首选读模式以及对于选定服务器的标签集合。其值可以设置为:mode和:tag_sets。例如{ :read=>{ :mode=>secondary,:tag_sets=>["berlin"]}}	Hash	{:mode =>:primary}
:auth_source	具体设置了授权源信息	String	2.6及其之后版本，如果提供了授权证书，则默认为admin；否则的话就是当前的数据库
:auth_mech	具体设置使用的授权机制。可以是下述值的其中之一：:mongodb_cr,:mongodb_x509,:plain,:scram	Symbol	MongoDB3.0后的版本，如果用户提供了资格证书但是又没有设置:auth_mech属性，则默认为:scram。2.6版本之前，默认为:mongodb_cr
:auth_mech_properties	提供了额外的授权机制属性	Hash	none
:user	认证使用的用户名称	String	none
:password	认证使用的用户密码	String	none
:connect	覆盖驱动的自动探索特性，并且强制将集群拓扑结构转变为一个特定的类型。包括：:direct,:replica_set或者:shared	Symbol	none
:heartbeat_frequency	多个监视器异步刷新服务器状态的时间（秒）	Float	30
:database	需要连接的数据库名字	String	admin
:server_selection_timeout	选定一个合适的服务器去执行某些操作，在抛出异常之前的等待时间	Float	30

:local_threshold

设置了最近的服务器和可以被选中的服务器之间切换的最大延迟时间

Float

0.015

5. 超时相关参数的设置细节

本文出自 “techFuture” 博客，谢绝转载！