类:Mongo::Server::Description

继承:
对象
  • 对象
显示全部
定义于:
构建/ruby-driver-v2.19/lib/ mongo / 服务器/description.rb
构建/ruby-driver-v2.19/lib/ mongo / 服务器/description/features.rb,
构建/ruby-driver-v2.19/lib/ mongo / 服务器/description/load_balancer.rb

Overview

表示服务器的描述,由 hello 命令的结果填充。

注意:未知的服务器没有传输版本,但由于传统原因,我们会为任何没有传输版本的服务器的 min_wire_version 和 max_wire_version 返回0 。 目前,驾驶员有时会在服务器未知的情况下构造命令,因此对 min_wire_version 和 max_wire_version 的引用不应为零。 当驾驶员行为发生更改时 ( jira.mongodb.org/browse/RUBY-{2 1805 ), 这可能不再是必要的。

由于:

  • 2.0.0

在命名空间下定义

类: 功能, LoadBalancer

常量摘要折叠

ARBITER =
已弃用。

用于从配置中读取仲裁节点信息的常量。

由于:

  • 2.0.0

' arbiterOnly '.冻结
ARBITERS =

用于从配置中读取仲裁节点信息的常量。

由于:

  • 2.0.0

' arbiters '.冻结
HIDDEN =

用于从配置中读取隐藏信息的常量。

由于:

  • 2.0.0

' hidden '.冻结
HOSTS =

用于从配置中读取主机信息的常量。

由于:

  • 2.0.0

' hosts '.冻结
MESSAGE =
已弃用。

消息值的键常量。

由于:

  • 2.0.0

'msg'.冻结
MONGOS_MESSAGE =
已弃用。

指示分分片集群的消息常量。

由于:

  • 2.0.0

' isdbgrid '.冻结
REPLICA_SET =
已弃用。

用于确定虚拟服务器的常量。

由于:

  • 2.0.0

' isreplicaset '.冻结
MAX_BSON_OBJECT_SIZE =

用于从配置中读取最大BSON大小信息的常量。

由于:

  • 2.0.0

'maxBsonObjectSize'.冻结
MAX_MESSAGE_BYTES =

用于从配置中读取最大消息大小信息的常量。

由于:

  • 2.0.0

'maxMessageSizeBytes'.冻结
MAX_WIRE_VERSION =

最大线路版本常量。

由于:

  • 2.0.0

' maxWireVersion '.冻结
MIN_WIRE_VERSION =

最小线路版本常量。

由于:

  • 2.0.0

' minWireVersion '.冻结
MAX_WRITE_BATCH_SIZE =

读取最大写入批处理大小的常量。

由于:

  • 2.0.0

' maxWriteBatchSize '.冻结
LAST_WRITE =

lastWrite 子文档的常量。

由于:

  • 2.4.0

' lastWrite '.冻结
LAST_WRITE_DATE =

lastWrite 子文档中 lastWriteDate 字段的常量。

由于:

  • 2.4.0

' lastWriteDate '.冻结
ME =

用于读取 me字段的常量。

由于:

  • 2.1.0

'me'.冻结
DEFAULT_MAX_WRITE_BATCH_SIZE =

默认最大写入批处理大小。

由于:

  • 2.0.0

1000.冻结
LEGACY_WIRE_VERSION =
已弃用。

将在3.0中删除。

传统传输协议版本。

由于:

  • 2.0.0

0.冻结
被动 =

用于从配置中读取被动信息的常量。

由于:

  • 2.0.0

' passive '.冻结
被动 =

用于读取无源服务器列表的常量。

由于:

  • 2.0.0

' Passives '.冻结
主节点 =
已弃用。

用于从配置中读取主节点 (primary node in the replica set)节点信息的常量。

由于:

  • 2.0.0

' ismaster '.冻结
PRIMARY_HOST =

用于从配置中读取主节点 (primary node in the replica set)托管字段的常量。

由于:

  • 2.5.0

' primary '.冻结
SECONDARY =
已弃用。

用于从配置从节点(secondary node from replica set)读取从节点信息的常量。

由于:

  • 2.0.0

' secondary '.冻结
SET_NAME =

用于从配置中读取副本集名称信息的常量。

由于:

  • 2.0.0

'setName'.冻结
标签 =

用于从配置中读取标签信息的常量。

由于:

  • 2.0.0

'tags'.冻结
ELECTION_ID =

用于从配置中读取选举 ID 信息的常量。

由于:

  • 2.1.0

' electionId '.冻结
SET_VERSION =

用于从配置中读取 setVersion 信息的常量。

由于:

  • 2.2.2

'setVersion'.冻结
LOCAL_TIME =

用于从配置中读取 localTime 信息的常量。

由于:

  • 2.1.0

' localTime '.冻结
OPERATION_TIME =

用于从配置中读取 operationTime 信息的常量。

由于:

  • 2.5.0

' operationTime '.冻结
LOGICAL_SESSION_TIMEOUT_MINUTES =

用于从配置中读取 LogicalSessionTimeoutMinutes 信息的常量。

由于:

  • 2.5.0

' logicalSessionTimeoutMinutes '.冻结
CONNECTION_ID =

此常量是私有 API 的一部分。 应尽可能避免使用此常量,因为它将来可能会被删除或更改。

用于从配置中读取 connectionId 信息的常量。

由于:

  • 2.0.0

' connectionId '.冻结
EXCLUDE_FOR_COMPARISON =

比较两个描述时要排除的字段。

由于:

  • 2.0.6

[ LOCAL_TIME,
  LAST_WRITE,
  OPERATION_TIME,
  操作::CLUSTER_TIME,
  CONNECTION_ID,
].冻结

实例属性摘要折叠

实例方法摘要折叠

构造函数详情

#initialize (address, config = {}, average_round_trip_time: nil, load_balancer: false, force_load_balancer: false) ⇒说明

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

根据 hello 命令的结果实例化新的服务器描述,或为未知服务器和 LoadBalancer 服务器制作占位符描述。

例子:

实例化新描述。

Description.new(address, { 'isWritablePrimary' => true }, 0.5)

参数:

  • 地址 (地址)

    服务器解决。

  • config 哈希 (默认为: {}

    hello 命令的结果。

  • average_round_trip_time 浮点 (默认为: nil

    hello 命令完成所需的移动平均时间(秒)。

  • average_round_trip_time 浮点 (默认为: nil

    ismaster 调用完成所需的移动平均时间(秒)。

  • load_balancer ( true | false ) (默认为: false

    是否将服务器视为负载负载均衡器。

  • force_load_balancer ( true | false ) (默认为: false

    是否强制服务器充当负载负载均衡器。

由于:

  • 2.0.0



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第220行

def 初始化(地址, config = {}, average_round_trip_time: nil,
  load_balancer: false, force_load_balancer: false
)
  @address = 地址
  @config = config
  @load_balancer = !!load_balancer
  @force_load_balancer = !!force_load_balancer
  @features = 功能.new(wire_versions, me || @address.to_s)
  @average_round_trip_time = average_round_trip_time
  @last_update_time = 时间.now.冻结
  @last_update_monotime = Utils.monotic_time

  if load_balancer
    # 当设立了 loadBalanced=true URI 选项时,驾驶员将拒绝
    # 在与其通信的服务器未设立serviceId 的情况下运行
    # 在 ismaster/hello 响应中。
    #
    # 目前,我们无法在常青树上运行适当的负载负载均衡器设置
    #
    # 因此,当使用 connect=:load_balanced Ruby选项时
    # loadBalanced=true URI 选项的值(如果未在 中设立serviceId)
    # ismaster/hello 响应,驾驶员会制造一个 serviceId 和
    # 将未报告自身的服务器视为
    #在负载均衡器后面作为位于负载负载均衡器负载均衡器的服务器。
    #
    # 5.0 + 服务器应提供topologyVersion.processId,其中
    # 特定于特定进程实例。 我们可以使用
    #字段作为 serviceId 的代理。
    #
    # 如果由于某种原因未提供拓扑版本,我们将
    # 在本地创建一个 serviceId。
    #
    # 无论哪种情况,后面的实际服务器提供的 serviceId
    # 负载负载均衡器应该是BSON::ObjectId。 捏造的
    # 服务 ID 是字符串,用于将其与真实服务区分开来。
    # 特别是,processId 也是BSON::ObjectId,但会
    # 映射到string ,以便清楚地看出这是一个假服务ID 。
    #
    # TODO:完成 https://jira.mongodb.org/browse/RUBY-{0 2881后将其删除。
    if 确定吗? && !service_id
      除非 force_load_balancer
        提高 错误::MissingServiceId, “ 服务器 #{ address.seed} 服务器 未 在握手响应中提供服务 ID”
      end

      false_service_id = if process_id = topology_version && topology_version['processId']
        " 进程: #{ process_id } "
      else
        " false: #{ rand ( 2 ** 32 - 1 ) + 1 } "
      end
      @config = @config.合并(merge)(' serviceId ' => false_service_id)
    end
  end

  if mongo::Lint.已启用?
    # 预填充缓存实例变量
    主机
    仲裁节点
    被动语态
    topology_version

    冻结
  end
end

实例属性详细信息

#解决地址(只读)

返回地址 服务器的地址。

返回:

  • (地址)

    解决服务器的解决。

由于:

  • 2.0.0



285
286
287
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第285行

def 地址
  @address
end

# average_round_trip_time浮点(只读)

返回 hello 调用完成所需的移动平均时间。

返回:

  • (浮点)

    完成 hello 调用所需的移动平均时间。

由于:

  • 2.0.0



303
304
305
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第303行

def average_round_trip_time
  @average_round_trip_time
end

# config哈希(只读)

返回 hello 命令的实际结果。

返回:

  • (哈希)

    hello 命令的实际结果。

由于:

  • 2.0.0



288
289
290
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第288行

def config
  @config
end

# last_update_monotime浮点(只读)

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

根据单调时钟创建此服务器描述的时间。

返回:

  • (浮点)

    MongoDB Server描述创建单调时间。

另请参阅:

  • 了解更多详情

由于:

  • 2.0.0



835
836
837
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第835行

def last_update_monotime
  @last_update_monotime
end

# last_update_time时间(只读)

注意:

该时间并不表示服务器何时成功检查

创建此服务器描述的时间。

已完成,因为将服务器标记为未知会更新其描述和 last_update_time。 使用 Server#last_scan 查明监视器上次成功检查服务器的时间。

返回:

  • 时间

    MongoDB Server描述创建时间。

由于:

  • 2.7.0



826
827
828
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第826行

def last_update_time
  @last_update_time
end

实例方法详细信息

# == (other) ⇒ true , false也称为: eql?

检查两个描述是否相等。

例子:

检查描述相等性。

description == other

参数:

  • 其他 ( Object )

    其他描述。

返回:

  • ( true , false )

    对象是否相等。

由于:

  • 2.0.6



859
860
861
862
863
864
865
866
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第859行

def ==(其他)
  return false if self.class != 其他.class
  return false if 未知? || 其他.未知?

  (config.密钥 + 其他.config.密钥).uniq.全部? do |k|
    config[k] == 其他.config[k] || EXCLUDE_FOR_COMPARISON.包括?(k)
  end
end

#仲裁节点?true , false

根据 SDAM 规范,返回此服务器是否为仲裁节点节点。

例子:

服务器是仲裁节点吗?

description.arbiter?

返回:

  • ( true , false )

    如果服务器是仲裁节点。

由于:

  • 2.0.0



313
314
315
316
317
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第313行

def 仲裁节点?
  确定吗? &&
  config[' arbiterOnly '] == true &&
  !!config['setName']
end

#仲裁节点Array<String>

获取副本集所有仲裁节点的列表。

例子:

获取副本集的仲裁节点。

description.arbiters

返回:

  • ( Array<String> )

    集合中的仲裁节点。

由于:

  • 2.0.0



327
328
329
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第327行

def 仲裁节点
  @arbiters ||= (config[仲裁节点] || []).map { |s| s.Downcase }
end

# data_ Bearing?true , false

此描述是否来自数据承载服务器(独立运行运行、 mongos、主节点 (primary node in the replica set)节点或从从节点(secondary node from replica set))。

返回:

  • ( true , false )

    描述是否来自承载数据的服务器。

由于:

  • 2.7.0



789
790
791
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第789行

def data_ Bearing?
  mongos? || 主节点? || 从节点(secondary node from replica set)? || 独立运行?
end

#election_id =" BSON::ObjectId "

从配置中获取选举 ID。

例子:

获取选举 ID。

description.election_id

返回:

  • ( BSON::ObjectId )

    选举 ID。

由于:

  • 2.1.0



475
476
477
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第475行

def election_id
  config[ELECTION_ID]
end

# 个特征特征

返回功能服务器的功能。

返回:

  • (功能)

    features 服务器的功能。

由于:

  • 2.0.0



298
299
300
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第298行

def 功能
  @features
end

#幽灵?true , false

根据 SDAM 规范,此服务器是否为虚拟服务器。

例子:

服务器是幽灵吗?

description.ghost?

返回:

  • ( true , false )

    如果服务器是幽灵。

由于:

  • 2.0.0



339
340
341
342
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第339行

def ghost?
  确定吗? &&
  config[' isreplicaset '] == true
end

#隐藏?true , false

如果服务器处于隐藏状态,则返回 true。

例子:

服务器是隐藏的吗?

description.hidden?

返回:

  • ( true , false )

    如果服务器处于隐藏状态。

由于:

  • 2.0.0



352
353
354
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第352行

def 隐藏?
  确定吗? && !!config[Hidden]
end

#hostsArray<String>

获取副本集中所有服务器的列表。

例子:

获取副本集的服务器。

description.hosts

返回:

  • ( Array<String> )

    设立中的服务器。

由于:

  • 2.0.0



364
365
366
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第364行

def 主机
  @hosts ||= (config[HOSTS] || []).map { |s| s.Downcase }
end

#检查string

检查服务器描述。

例子:

检查服务器描述

description.inspect

返回:

  • ( string )

    检查。

由于:

  • 2.0.0



376
377
378
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第376行

def 检查
  " #<Mongo::Server:Description: 0 x #{ object_id } config= #{ config } average_round_trip_time= #{ average_round_trip_time } > "
end

# is_server? (服务器) ⇒ true , false

已弃用。

这是来自给定服务器的描述吗?

例子:

检查描述是否来自给定服务器。

description.is_server?(server)

返回:

  • ( true , false )

    如果描述来自服务器。

由于:

  • 2.0.6



751
752
753
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第751行

def is_server?(server)
  地址 == server.地址
end

# last_write_date时间

从配置中的 lastWrite 子文档获取 lastWriteDate。

例子:

获取 lastWriteDate 值。

description.last_write_date

返回:

  • 时间

    上次写入日期。

由于:

  • 2.4.0



540
541
542
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第540行

def last_write_date
  config[LAST_WRITE][LAST_WRITE_DATE] if config[LAST_WRITE]
end

#lists_server? (服务器) ⇒ true , false

已弃用。

服务器是否包含在此描述的服务器列表中。

例子:

检查服务器是否在服务器描述列表中。

description.lists_server?(server)

返回:

  • ( true , false )

    如果服务器位于描述的服务器列表中。

由于:

  • 2.0.6



765
766
767
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第765行

def lists_server?(server)
  服务器.包括?(server.地址.to_s)
end

# load_balancer?true | false

返回此服务器是否为负载负载均衡器。

返回:

  • ( true | false )

    此服务器是否为负载负载均衡器。

由于:

  • 2.0.0



293
294
295
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第293行

def load_balancer?
  @load_balancer
end

#logic_session_timeout整数?

从配置中获取logicSessionTimeoutMinutes。

例子:

获取logicSessionTimeoutMinutes(以分钟为单位)值。

description.logical_session_timeout

返回:

  • ( Integer , nil )

    逻辑会话超时(以分钟为单位)。

由于:

  • 2.5.0



552
553
554
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第552行

def logic_session_timeout
  config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
end

# max_bson_object_size整数

获取此服务器版本的最大BSON对象大小。

例子:

获取最大BSON对象大小。

description.max_bson_object_size

返回:

  • ( Integer )

    最大对象大小(以字节为单位)。

由于:

  • 2.0.0



388
389
390
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第388行

def max_bson_object_size
  config[MAX_BSON_OBJECT_SIZE]
end

# max_message_size整数

获取此服务器版本的最大消息大小。

例子:

获取最大消息大小。

description.max_message_size

返回:

  • ( Integer )

    最大消息大小(以字节为单位)。

由于:

  • 2.0.0



400
401
402
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第400行

def max_message_size
  config[MAX_MESSAGE_BYTES]
end

#max_wire_versionInteger

获取最大线路版本。 默认为零。

例子:

获取最大线路版本。

description.max_wire_version

返回:

  • ( Integer )

    支持的最大线路版本。

由于:

  • 2.0.0



424
425
426
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第424行

def max_wire_version
  config[MAX_WIRE_VERSION] || 0
end

# max_write_batch_size整数

获取写入的最大批处理大小。

例子:

获取最大批处理大小。

description.max_write_batch_size

返回:

  • ( Integer )

    最大批处理大小。

由于:

  • 2.0.0



412
413
414
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第412行

def max_write_batch_size
  config[MAX_WRITE_BATCH_SIZE] || DEFAULT_MAX_WRITE_BATCH_SIZE
end

# mestring

注意:

me字段中的值可能与服务器描述的解决不同。 示例,这可能发生在水平分割配置中。 SDAM 规范仅要求在某些情况下删除 me 与其解决不匹配的服务器(例如,当相关服务器是 RS 成员但不是主节点 (primary node in the replica set)节点时)。

获取 me字段值。

返回:

  • ( string )

    me字段。

由于:

  • 2.1.0



451
452
453
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第451行

def me
  config[ME]
end

# me_mismatch?true , false

检查解决托管和 me字段是否不匹配。

例子:

检查是否存在不匹配的情况。

description.me_mismatch?

返回:

  • ( true , false )

    如果 me字段与解决托管不匹配。

由于:

  • 2.0.6



801
802
803
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第801行

def me_mismatch?
  !!(地址.to_s.Downcase != me.Downcase if me)
end

# min_wire_version整数

获取最低传输版本。 默认为零。

例子:

获取最低传输版本。

description.min_wire_version

返回:

  • ( Integer )

    支持的最低线路版本。

由于:

  • 2.0.0



436
437
438
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第436行

def min_wire_version
  config[MIN_WIRE_VERSION] || 0
end

# mongos?true , false

根据 SDAM 规范,返回此服务器是否为mongos。

例子:

服务器是 mongos 吗?

description.mongos?

返回:

  • ( true , false )

    如果服务器是mongos.

由于:

  • 2.0.0



564
565
566
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第564行

def mongos?
  确定吗? && config['msg'] == ' isdbgrid '
end

#可以吗?布尔

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

返回:

  • 布尔值

由于:

  • 2.0.0



725
726
727
728
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第725行

def 确定吗?
  config[操作::结果::正常] &&
    config[操作::结果::正常] == 1 || false
end

#op_timeBSON::Timestamp

hello 响应的 lastWrite 子文档中的optime 。

返回:

  • ( BSON::Timestamp )

    时间戳。

由于:

  • 2.7.0



810
811
812
813
814
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第810行

def op_time
  if config[' lastWrite '] && config[' lastWrite '][' optime ']
    config[' lastWrite '][' optime ']['ts']
  end
end

# other?true , false

根据 SDAM 规范,返回服务器是否为其他服务器。

例子:

是 other 类型的描述。

description.other?

返回:

  • ( true , false )

    如果描述的是其他。

由于:

  • 2.0.0



576
577
578
579
580
581
582
583
584
585
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第576行

def 其他?
  # SDAM 规范对“其他”的含义有点令人困惑,
  # 但它被称为“RSOTHER”,意思是非 RS 成员
  # 不能是“其他”。
  确定吗? &&
  !!config['setName'] && (
    config[' hidden '] == true ||
    !主节点? && !从节点(secondary node from replica set)? && !仲裁节点?
  )
end

# Passive?true , false

如果服务器处于被动状态,则返回 true。

例子:

服务器是被动的吗?

description.passive?

返回:

  • ( true , false )

    如果服务器处于被动状态。

由于:

  • 2.0.0



595
596
597
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第595行

def 被动?
  确定吗? && !!config[PASSIVE]
end

# PassivesArray<String>

获取集群中无源服务器的列表。

例子:

获取被动语态。

description.passives

返回:

  • ( Array<String> )

    被动列表。

由于:

  • 2.0.0



607
608
609
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第607行

def 被动语态
  @passives ||= (config[PASSIVES] || []).map { |s| s.Downcase }
end

#主节点?true , false

根据 SDAM 规范,返回此服务器是否主节点 (primary node in the replica set)节点。

例子:

服务器是主节点 (primary node in the replica set)吗?

description.primary?

返回:

  • ( true , false )

    如果服务器是主节点 (primary node in the replica set).

由于:

  • 2.0.0



631
632
633
634
635
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第631行

def 主节点?
  确定吗? &&
    (config[' ismaster '] == true || config[' isWritablePrimary '] == true ) &&
  !!config['setName']
end

#primary_hoststring | nil

获取主节点 (primary node in the replica set)托管的解决。

例子:

获取主节点 (primary node in the replica set)节点的解决。

description.primary_host

返回:

  • ( string | nil )

    主节点的地址。

由于:

  • 2.6.0



619
620
621
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第619行

def primary_host
  config[PRIMARY_HOST] && config[PRIMARY_HOST].Downcase
end

# replica_set_member?true , false

此描述是否对应于副本集成员。

例子:

检查描述是否来自副本集节点。

description.replica_set_member?

返回:

  • ( true , false )

    如果描述来自副本集成员。

由于:

  • 2.0.6



778
779
780
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第778行

def replica_set_member?
  确定吗? && !(独立运行? || mongos?)
end

# replica_set_namestring ?

获取服务器所属副本集的名称,如果没有,则返回 nil。

例子:

获取副本集名称。

description.replica_set_name

返回:

  • ( string , nil )

    副本集的名称。

由于:

  • 2.0.0



646
647
648
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第646行

def replica_set_name
  config[SET_NAME]
end

# secondary?true , false

根据从节点(secondary node from replica set)规范,返回此服务器是否为从节点。

例子:

服务器是从从节点(secondary node from replica set)吗?

description.secondary?

返回:

  • ( true , false )

    如果服务器是从从节点(secondary node from replica set).

由于:

  • 2.0.0



670
671
672
673
674
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第670行

def 从节点(secondary node from replica set)?
  确定吗? &&
  config[' secondary '] == true &&
  !!config['setName']
end

# server_connection_id对象

由于:

  • 2.0.0



838
839
840
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第838行

def server_connection_id
  config[' connectionId ']
end

# server_type符号

以符号形式返回服务器类型。

例子:

获取服务器类型。

description.server_type

返回:

  • (符号)

    服务器类型。

由于:

  • 2.4.0



684
685
686
687
688
689
690
691
692
693
694
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第684行

def server_type
  return :load_balancer if load_balancer?
  return :仲裁节点 if 仲裁节点?
  return :ghost if ghost?
  return :sharded if mongos?
  return :primary if 主节点?
  return :secondary if 从节点(secondary node from replica set)?
  return :独立运行 if 独立运行?
  return :other if 其他?
  :unknown
end

#server_version_gte?(version) ⇒ Boolean

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

返回:

  • 布尔值

由于:

  • 2.0.0



870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第870行

def server_version_gte?(版本)
  required_wv = 案例 版本
    when ' 7.0 '
      21
    when ' 6.0 '
      17
    when ' 5.2 '
      15
    when ' 5.1 '
      14
    when ' 5.0 '
      12
    when ' 4.4 '
      9
    when ' 4.2 '
      8
    when ' 4.0 '
      7
    when ' 3.6 '
      6
    when ' 3.4 '
      5
    when ' 3.2 '
      4
    when ' 3.0 '
      3
    when ' 2.6 '
      2
    else
      提高 ArgumentError, " Bogus required version #{ version } "
    end

  if load_balancer?
    # 如果我们正在与负载均衡器通信,则没有监控
    # 并且我们不知道负载负载均衡器后面是哪台服务器。
    # 假设一切都受支持。
    # TODO 在实施 RUBY- 2220时删除此项。
    return true
  end

  required_wv >= min_wire_version && required_wv <= max_wire_version
end

#serversArray<String>

获取集群已知的所有服务器的列表。

例子:

获取所有服务器。

description.servers

返回:

  • ( Array<String> )

    所有服务器的列表。

由于:

  • 2.0.0



658
659
660
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第658行

def 服务器
  主机 + 仲裁节点 + 被动语态
end

# service_id =" nil |对象

返回 服务 ID(如果有)。

返回:

  • ( nil | Object )

    服务 ID(如果有)。

由于:

  • 2.0.0



845
846
847
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第845行

def service_id
  config[' serviceId ']
end

#set_versionInteger

从配置中获取 setVersion。

例子:

获取 setVersion。

description.set_version

返回:

  • ( Integer )

    设立的版本。

由于:

  • 2.2.2



487
488
489
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第487行

def set_version
  config[SET_VERSION]
end

#独立运行?true , false

根据 SDAM 规范,返回此服务器是否为独立运行运行的服务器。

例子:

服务器是独立运行的吗?

description.standalone?

返回:

  • ( true , false )

    如果服务器是独立运行的。

由于:

  • 2.0.0



704
705
706
707
708
709
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第704行

def 独立运行?
  确定吗? &&
  config['msg'] != ' isdbgrid ' &&
  config['setName'].nil? &&
  config[' isreplicaset '] != true
end

#个标签哈希

获取为服务器配置的标签。

例子:

获取标签。

description.tags

返回:

  • (哈希)

    服务器的标签。

由于:

  • 2.0.0



463
464
465
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第463行

def 标记
  config[标签] || {}
end

# topology_versionTopologyVersion | nil

返回 拓扑版本。

返回:

由于:

  • 2.0.0



492
493
494
495
496
497
498
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第492行

def topology_version
  除非 定义?(@topology_version)
    @topology_version = config['topologyVersion'] &&
      TopologyVersion.new(config['topologyVersion'])
  end
  @topology_version
end

# topology_version_gt? (other_desc) ⇒ true | false

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

返回此描述中的拓扑结构版本是否可能晚于或等于其他描述中的拓扑结构版本。

参数:

返回:

  • ( true | false )

    此描述中的拓扑结构版本是否可能更新或相同。

由于:

  • 2.0.0



508
509
510
511
512
513
514
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第508行

def topology_version_gt?(other_desc)
  if topology_version.nil? || other_desc.topology_version.nil?
    true
  else
    topology_version.gt?(other_desc.topology_version)
  end
end

# topology_version_gte? (other_desc) ⇒ true | false

此方法是私有 API 的一部分。 您应尽可能避免使用此方法,因为它将来可能会被删除或更改。

返回此描述中的拓扑版本是否可能比其他描述中的拓扑版本新。

参数:

返回:

  • ( true | false )

    此描述中的拓扑结构版本是否可能较新。

由于:

  • 2.0.0



524
525
526
527
528
529
530
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第524行

def topology_version_gte?(other_desc)
  if topology_version.nil? || other_desc.topology_version.nil?
    true
  else
    topology_version.gte?(other_desc.topology_version)
  end
end

#未知?true , false

根据 SDAM 规范,返回此服务器是否为未知服务器。

例子:

服务器描述未知?

description.unknown?

返回:

  • ( true , false )

    如果服务器描述未知。

由于:

  • 2.0.0



719
720
721
722
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第719行

def 未知?
  return false if load_balancer?
  config.空? || config.密钥 == %w(拓扑版本) || !确定吗?
end

#wire_versions范围

获取服务器支持的传输版本范围。

例子:

获取传输版本范围。

description.wire_versions

返回:

  • (范围)

    传输版本范围。

由于:

  • 2.0.0



738
739
740
# File 'build/Ruby-driver-v 2.19 /lib/mongo/server/description.rb', 第738行

def wire_versions
  min_wire_version..max_wire_version
end