Class: Mongo::Server::Description

Inherits:
Object
  • Object
show all
Defined in:
lib/mongo/server/description.rb,
lib/mongo/server/description/features.rb,
lib/mongo/server/description/load_balancer.rb

Overview

Represents a description of the server, populated by the result of the hello command.

Note: Unknown servers do not have wire versions, but for legacy reasons we return 0 for min_wire_version and max_wire_version of any server that does not have them. Presently the driver sometimes constructs commands when the server is unknown, so references to min_wire_version and max_wire_version should not be nil. When driver behavior is changed (jira.mongodb.org/browse/RUBY-1805), this may no longer be necessary.

Since:

  • 2.0.0

Defined Under Namespace

Classes: Features, LoadBalancer

Constant Summary collapse

ARBITER =
Deprecated.

Constant for reading arbiter info from config.

Since:

  • 2.0.0

'arbiterOnly'
ARBITERS =

Constant for reading arbiters info from config.

Since:

  • 2.0.0

'arbiters'
HIDDEN =

Constant for reading hidden info from config.

Since:

  • 2.0.0

'hidden'
HOSTS =

Constant for reading hosts info from config.

Since:

  • 2.0.0

'hosts'
MESSAGE =
Deprecated.

Constant for the key for the message value.

Since:

  • 2.0.0

'msg'
MONGOS_MESSAGE =
Deprecated.

Constant for the message that indicates a sharded cluster.

Since:

  • 2.0.0

'isdbgrid'
REPLICA_SET =
Deprecated.

Constant for determining ghost servers.

Since:

  • 2.0.0

'isreplicaset'
MAX_BSON_OBJECT_SIZE =

Constant for reading max bson size info from config.

Since:

  • 2.0.0

'maxBsonObjectSize'
MAX_MESSAGE_BYTES =

Constant for reading max message size info from config.

Since:

  • 2.0.0

'maxMessageSizeBytes'
MAX_WIRE_VERSION =

Constant for the max wire version.

Since:

  • 2.0.0

'maxWireVersion'
MIN_WIRE_VERSION =

Constant for min wire version.

Since:

  • 2.0.0

'minWireVersion'
MAX_WRITE_BATCH_SIZE =

Constant for reading max write batch size.

Since:

  • 2.0.0

'maxWriteBatchSize'
LAST_WRITE =

Constant for the lastWrite subdocument.

Since:

  • 2.4.0

'lastWrite'
LAST_WRITE_DATE =

Constant for the lastWriteDate field in the lastWrite subdocument.

Since:

  • 2.4.0

'lastWriteDate'
ME =

Constant for reading the me field.

Since:

  • 2.1.0

'me'
DEFAULT_MAX_WRITE_BATCH_SIZE =

Default max write batch size.

Since:

  • 2.0.0

1000
LEGACY_WIRE_VERSION =
Deprecated.

Will be removed in 3.0.

The legacy wire protocol version.

Since:

  • 2.0.0

0
PASSIVE =

Constant for reading passive info from config.

Since:

  • 2.0.0

'passive'
PASSIVES =

Constant for reading the passive server list.

Since:

  • 2.0.0

'passives'
PRIMARY =
Deprecated.

Constant for reading primary info from config.

Since:

  • 2.0.0

'ismaster'
PRIMARY_HOST =

Constant for reading primary host field from config.

Since:

  • 2.5.0

'primary'
SECONDARY =
Deprecated.

Constant for reading secondary info from config.

Since:

  • 2.0.0

'secondary'
SET_NAME =

Constant for reading replica set name info from config.

Since:

  • 2.0.0

'setName'
TAGS =

Constant for reading tags info from config.

Since:

  • 2.0.0

'tags'
ELECTION_ID =

Constant for reading electionId info from config.

Since:

  • 2.1.0

'electionId'
SET_VERSION =

Constant for reading setVersion info from config.

Since:

  • 2.2.2

'setVersion'
LOCAL_TIME =

Constant for reading localTime info from config.

Since:

  • 2.1.0

'localTime'
OPERATION_TIME =

Constant for reading operationTime info from config.

Since:

  • 2.5.0

'operationTime'
LOGICAL_SESSION_TIMEOUT_MINUTES =

Constant for reading logicalSessionTimeoutMinutes info from config.

Since:

  • 2.5.0

'logicalSessionTimeoutMinutes'
CONNECTION_ID =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Constant for reading connectionId info from config.

Since:

  • 2.0.0

'connectionId'
IS_WRITABLE_PRIMARY =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Constant for reading the modern primary flag from config.

Since:

  • 2.0.0

'isWritablePrimary'
HELLO_OK =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Constant for reading the helloOk capability flag from config.

Since:

  • 2.0.0

'helloOk'
EXCLUDE_FOR_COMPARISON =

Fields to exclude when comparing two descriptions.

The PRIMARY (legacy ‘ismaster`), IS_WRITABLE_PRIMARY (modern `hello`), and HELLO_OK keys are excluded because the driver does a one-time legacy-`isMaster` to modern-`hello` protocol switch on the initial handshake (per the SDAM Server Monitoring spec). Two responses for the same logical role differ only in which of these keys is populated. The role itself is still differentiated by the SECONDARY flag and the remaining replica-set metadata.

Since:

  • 2.0.6

[ LOCAL_TIME,
LAST_WRITE,
OPERATION_TIME,
Operation::CLUSTER_TIME,
CONNECTION_ID,
PRIMARY,
IS_WRITABLE_PRIMARY,
HELLO_OK, ].freeze
SERVER_VERSION_WIRE_VERSION_MAP =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

Since:

  • 2.0.0

{
  '8.2' => 27,
  '8.0' => 25,
  '7.0' => 21,
  '6.0' => 17,
  '5.2' => 15,
  '5.1' => 14,
  '5.0' => 12,
  '4.4' => 9,
  '4.2' => 8,
}.freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(address, config = {}, average_round_trip_time: nil, minimum_round_trip_time: 0, load_balancer: false, force_load_balancer: false) ⇒ Description

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Instantiate the new server description from the result of the hello command or fabricate a placeholder description for Unknown and LoadBalancer servers.

Examples:

Instantiate the new description.

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

Parameters:

  • address (Address) —

    The server address.

  • config (Hash) (defaults to: {}) —

    The result of the hello command.

  • average_round_trip_time (Float) (defaults to: nil) —

    The moving average time (sec) the hello command took to complete.

  • minimum_round_trip_time (Float) (defaults to: 0) —

    The minimum round trip time of ten last hello commands.

  • load_balancer (true | false) (defaults to: false) —

    Whether the server is treated as a load balancer.

  • force_load_balancer (true | false) (defaults to: false) —

    Whether the server is forced to be a load balancer.

Since:

  • 2.0.0



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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/mongo/server/description.rb', line 237

def initialize(address, config = {}, average_round_trip_time: nil,
               minimum_round_trip_time: 0, load_balancer: false,
               force_load_balancer: false)
  @address = address
  @config = config
  @load_balancer = !!load_balancer
  @force_load_balancer = !!force_load_balancer
  @features = Features.new(wire_versions, me || @address.to_s)
  @average_round_trip_time = average_round_trip_time
  @minimum_round_trip_time = minimum_round_trip_time
  @last_update_time = Time.now.freeze
  @last_update_monotime = Utils.monotonic_time

  # When loadBalanced=true URI option is set, the driver will refuse
  # to work if the server it communicates with does not set serviceId
  # in ismaster/hello response.
  #
  # At the moment we cannot run a proper load balancer setup on evergreen
  #
  # Therefore, when connect=:load_balanced Ruby option is used instead
  # of the loadBalanced=true URI option, if serviceId is not set in
  # ismaster/hello response, the driver fabricates a serviceId and
  # proceeds to treat a server that does not report itself as being
  # behind a load balancer as a server that is behind a load balancer.
  #
  # 5.0+ servers should provide topologyVersion.processId which
  # is specific to the particular process instance. We can use that
  # field as a proxy for serviceId.
  #
  # If the topologyVersion isn't provided for whatever reason, we
  # fabricate a serviceId locally.
  #
  # In either case, a serviceId provided by an actual server behind
  # a load balancer is supposed to be a BSON::ObjectId. The fabricated
  # service ids are strings, to distinguish them from the real ones.
  # In particular processId is also a BSON::ObjectId, but will be
  # mapped to a string for clarity that this is a fake service id.
  #
  # TODO: Remove this when https://jira.mongodb.org/browse/RUBY-2881 is done.
  if load_balancer && ok? && !service_id
    unless force_load_balancer
      raise Error::MissingServiceId,
            "The server at #{address.seed} did not provide a service id in handshake response"
    end

    fake_service_id = if process_id = topology_version && topology_version['processId']
                        "process:#{process_id}"
                      else
                        "fake:#{rand((2**32) - 1) + 1}"
                      end
    @config = @config.merge('serviceId' => fake_service_id)
  end

  return unless Mongo::Lint.enabled?

  # prepopulate cache instance variables
  hosts
  arbiters
  passives
  topology_version

  freeze
end

Instance Attribute Details

#address ⇒ Address (readonly)

Returns address The server’s address.

Returns:

  • (Address) —

    address The server’s address.

Since:

  • 2.0.0



302
303
304
 
# File 'lib/mongo/server/description.rb', line 302

def address
  @address
end

#average_round_trip_time ⇒ Float (readonly)

Returns The moving average time the hello call took to complete.

Returns:

  • (Float) —

    The moving average time the hello call took to complete.

Since:

  • 2.0.0



318
319
320
 
# File 'lib/mongo/server/description.rb', line 318

def average_round_trip_time
  @average_round_trip_time
end

#config ⇒ Hash (readonly)

Returns The actual result from the hello command.

Returns:

  • (Hash) —

    The actual result from the hello command.

Since:

  • 2.0.0



305
306
307
 
# File 'lib/mongo/server/description.rb', line 305

def config
  @config
end

#features ⇒ Features (readonly)

Returns features The features for the server.

Returns:

  • (Features) —

    features The features for the server.

Since:

  • 2.0.0



315
316
317
 
# File 'lib/mongo/server/description.rb', line 315

def features
  @features
end

#last_update_monotime ⇒ Float (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Time when this server description was created according to monotonic clock.

Returns:

  • (Float) —

    Server description creation monotonic time.

See Also:

  • for more detail

Since:

  • 2.0.0



863
864
865
 
# File 'lib/mongo/server/description.rb', line 863

def last_update_monotime
  @last_update_monotime
end

#last_update_time ⇒ Time (readonly)

Note:

This time does not indicate when a successful server check

Time when this server description was created.

completed, because marking a server unknown updates its description and last_update_time. Use Server#last_scan to find out when the server was last successfully checked by its Monitor.

Returns:

  • (Time) —

    Server description creation time.

Since:

  • 2.7.0



854
855
856
 
# File 'lib/mongo/server/description.rb', line 854

def last_update_time
  @last_update_time
end

#minimum_round_trip_time ⇒ Float (readonly)

Returns The minimum time that the ten last hello calls took to complete.

Returns:

  • (Float) —

    The minimum time that the ten last hello calls took to complete.

Since:

  • 2.0.0



322
323
324
 
# File 'lib/mongo/server/description.rb', line 322

def minimum_round_trip_time
  @minimum_round_trip_time
end

Instance Method Details

#==(other) ⇒ true, false Also known as: eql?

Check equality of two descriptions.

Examples:

Check description equality.

description == other

Parameters:

  • other (Object) —

    The other description.

Returns:

  • (true, false) —

    Whether the objects are equal.

Since:

  • 2.0.6



887
888
889
890
891
892
893
894
895
 
# File 'lib/mongo/server/description.rb', line 887

def ==(other)
  return false if self.class != other.class
  return false if unknown? || other.unknown?
  return false if server_type != other.server_type

  (config.keys + other.config.keys).uniq.all? do |k|
    config[k] == other.config[k] || EXCLUDE_FOR_COMPARISON.include?(k)
  end
end

#arbiter? ⇒ true, false

Returns whether this server is an arbiter, per the SDAM spec.

Examples:

Is the server an arbiter?

description.arbiter?

Returns:

  • (true, false) —

    If the server is an arbiter.

Since:

  • 2.0.0



332
333
334
335
336
 
# File 'lib/mongo/server/description.rb', line 332

def arbiter?
  ok? &&
    config['arbiterOnly'] == true &&
    !!config['setName']
end

#arbiters ⇒ Array<String>

Get a list of all arbiters in the replica set.

Examples:

Get the arbiters in the replica set.

description.arbiters

Returns:

  • (Array<String>) —

    The arbiters in the set.

Since:

  • 2.0.0



346
347
348
 
# File 'lib/mongo/server/description.rb', line 346

def arbiters
  @arbiters ||= (config[ARBITERS] || []).map { |s| s.downcase }
end

#data_bearing? ⇒ true, false

Whether this description is from a data-bearing server (standalone, mongos, primary or secondary).

Returns:

  • (true, false) —

    Whether the description is from a data-bearing server.

Since:

  • 2.7.0



809
810
811
 
# File 'lib/mongo/server/description.rb', line 809

def data_bearing?
  mongos? || primary? || secondary? || standalone?
end

#election_id ⇒ BSON::ObjectId

Get the electionId from the config.

Examples:

Get the electionId.

description.election_id

Returns:

  • (BSON::ObjectId) —

    The election id.

Since:

  • 2.1.0



494
495
496
 
# File 'lib/mongo/server/description.rb', line 494

def election_id
  config[ELECTION_ID]
end

#ghost? ⇒ true, false

Whether this server is a ghost, per the SDAM spec.

Examples:

Is the server a ghost?

description.ghost?

Returns:

  • (true, false) —

    If the server is a ghost.

Since:

  • 2.0.0



358
359
360
361
 
# File 'lib/mongo/server/description.rb', line 358

def ghost?
  ok? &&
    config['isreplicaset'] == true
end

#hidden? ⇒ true, false

Will return true if the server is hidden.

Examples:

Is the server hidden?

description.hidden?

Returns:

  • (true, false) —

    If the server is hidden.

Since:

  • 2.0.0



371
372
373
 
# File 'lib/mongo/server/description.rb', line 371

def hidden?
  ok? && !!config[HIDDEN]
end

#hosts ⇒ Array<String>

Get a list of all servers in the replica set.

Examples:

Get the servers in the replica set.

description.hosts

Returns:

  • (Array<String>) —

    The servers in the set.

Since:

  • 2.0.0



383
384
385
 
# File 'lib/mongo/server/description.rb', line 383

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

#inspect ⇒ String

Inspect the server description.

Examples:

Inspect the server description

description.inspect

Returns:

  • (String) —

    The inspection.

Since:

  • 2.0.0



395
396
397
 
# File 'lib/mongo/server/description.rb', line 395

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

#is_server?(server) ⇒ true, false

Deprecated.

Is this description from the given server.

Examples:

Check if the description is from a given server.

description.is_server?(server)

Returns:

  • (true, false) —

    If the description is from the server.

Since:

  • 2.0.6



771
772
773
 
# File 'lib/mongo/server/description.rb', line 771

def is_server?(server)
  address == server.address
end

#last_write_date ⇒ Time

Get the lastWriteDate from the lastWrite subdocument in the config.

Examples:

Get the lastWriteDate value.

description.last_write_date

Returns:

  • (Time) —

    The last write date.

Since:

  • 2.4.0



559
560
561
 
# File 'lib/mongo/server/description.rb', line 559

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

#lists_server?(server) ⇒ true, false

Deprecated.

Is a server included in this description’s list of servers.

Examples:

Check if a server is in the description list of servers.

description.lists_server?(server)

Returns:

  • (true, false) —

    If a server is in the description’s list of servers.

Since:

  • 2.0.6



785
786
787
 
# File 'lib/mongo/server/description.rb', line 785

def lists_server?(server)
  servers.include?(server.address.to_s)
end

#load_balancer? ⇒ true | false

Returns whether this server is a load balancer.

Returns:

  • (true | false) —

    Whether this server is a load balancer.

Since:

  • 2.0.0



310
311
312
 
# File 'lib/mongo/server/description.rb', line 310

def load_balancer?
  @load_balancer
end

#logical_session_timeout ⇒ Integer?

Get the logicalSessionTimeoutMinutes from the config.

Examples:

Get the logicalSessionTimeoutMinutes value in minutes.

description.logical_session_timeout

Returns:

  • (Integer, nil) —

    The logical session timeout in minutes.

Since:

  • 2.5.0



571
572
573
 
# File 'lib/mongo/server/description.rb', line 571

def logical_session_timeout
  config[LOGICAL_SESSION_TIMEOUT_MINUTES] if config[LOGICAL_SESSION_TIMEOUT_MINUTES]
end

#max_bson_object_size ⇒ Integer

Get the max BSON object size for this server version.

Examples:

Get the max BSON object size.

description.max_bson_object_size

Returns:

  • (Integer) —

    The maximum object size in bytes.

Since:

  • 2.0.0



407
408
409
 
# File 'lib/mongo/server/description.rb', line 407

def max_bson_object_size
  config[MAX_BSON_OBJECT_SIZE]
end

#max_message_size ⇒ Integer

Get the max message size for this server version.

Examples:

Get the max message size.

description.max_message_size

Returns:

  • (Integer) —

    The maximum message size in bytes.

Since:

  • 2.0.0



419
420
421
 
# File 'lib/mongo/server/description.rb', line 419

def max_message_size
  config[MAX_MESSAGE_BYTES]
end

#max_wire_version ⇒ Integer

Get the maximum wire version. Defaults to zero.

Examples:

Get the max wire version.

description.max_wire_version

Returns:

  • (Integer) —

    The max wire version supported.

Since:

  • 2.0.0



443
444
445
 
# File 'lib/mongo/server/description.rb', line 443

def max_wire_version
  config[MAX_WIRE_VERSION] || 0
end

#max_write_batch_size ⇒ Integer

Get the maximum batch size for writes.

Examples:

Get the max batch size.

description.max_write_batch_size

Returns:

  • (Integer) —

    The max batch size.

Since:

  • 2.0.0



431
432
433
 
# File 'lib/mongo/server/description.rb', line 431

def max_write_batch_size
  config[MAX_WRITE_BATCH_SIZE] || DEFAULT_MAX_WRITE_BATCH_SIZE
end

#me ⇒ String

Note:

The value in me field may differ from the server description’s address. This can happen, for example, in split horizon configurations. The SDAM spec only requires removing servers whose me does not match their address in some of the situations (e.g. when the server in question is an RS member but not a primary).

Get the me field value.

Returns:

  • (String) —

    The me field.

Since:

  • 2.1.0



470
471
472
 
# File 'lib/mongo/server/description.rb', line 470

def me
  config[ME]
end

#me_mismatch? ⇒ true, false

Check if there is a mismatch between the address host and the me field.

Examples:

Check if there is a mismatch.

description.me_mismatch?

Returns:

  • (true, false) —

    If there is a mismatch between the me field and the address host.

Since:

  • 2.0.6



821
822
823
 
# File 'lib/mongo/server/description.rb', line 821

def me_mismatch?
  !!(address.to_s.downcase != me.downcase if me)
end

#min_wire_version ⇒ Integer

Get the minimum wire version. Defaults to zero.

Examples:

Get the min wire version.

description.min_wire_version

Returns:

  • (Integer) —

    The min wire version supported.

Since:

  • 2.0.0



455
456
457
 
# File 'lib/mongo/server/description.rb', line 455

def min_wire_version
  config[MIN_WIRE_VERSION] || 0
end

#mongocryptd? ⇒ true, false

Whether this description is from a mongocryptd server.

Returns:

  • (true, false) —

    Whether this description is from a mongocryptd server.

Since:

  • 2.0.0



829
830
831
 
# File 'lib/mongo/server/description.rb', line 829

def mongocryptd?
  ok? && config['iscryptd'] == true
end

#mongos? ⇒ true, false

Returns whether this server is a mongos, per the SDAM spec.

Examples:

Is the server a mongos?

description.mongos?

Returns:

  • (true, false) —

    If the server is a mongos.

Since:

  • 2.0.0



583
584
585
 
# File 'lib/mongo/server/description.rb', line 583

def mongos?
  ok? && config['msg'] == 'isdbgrid'
end

#ok? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Since:

  • 2.0.0



746
747
748
 
# File 'lib/mongo/server/description.rb', line 746

def ok?
  config[Operation::Result::OK] == 1
end

#op_time ⇒ BSON::Timestamp

opTime in lastWrite subdocument of the hello response.

Returns:

  • (BSON::Timestamp) —

    The timestamp.

Since:

  • 2.7.0



838
839
840
841
842
 
# File 'lib/mongo/server/description.rb', line 838

def op_time
  return unless config['lastWrite'] && config['lastWrite']['opTime']

  config['lastWrite']['opTime']['ts']
end

#other? ⇒ true, false

Returns whether the server is an other, per the SDAM spec.

Examples:

Is the description of type other.

description.other?

Returns:

  • (true, false) —

    If the description is other.

Since:

  • 2.0.0



595
596
597
598
599
600
601
602
603
604
 
# File 'lib/mongo/server/description.rb', line 595

def other?
  # The SDAM spec is slightly confusing on what "other" means,
  # but it's referred to it as "RSOther" which means a non-RS member
  # cannot be "other".
  ok? &&
    !!config['setName'] && (
    config['hidden'] == true ||
    (!primary? && !secondary? && !arbiter?)
  )
end

#passive? ⇒ true, false

Will return true if the server is passive.

Examples:

Is the server passive?

description.passive?

Returns:

  • (true, false) —

    If the server is passive.

Since:

  • 2.0.0



614
615
616
 
# File 'lib/mongo/server/description.rb', line 614

def passive?
  ok? && !!config[PASSIVE]
end

#passives ⇒ Array<String>

Get a list of the passive servers in the cluster.

Examples:

Get the passives.

description.passives

Returns:

  • (Array<String>) —

    The list of passives.

Since:

  • 2.0.0



626
627
628
 
# File 'lib/mongo/server/description.rb', line 626

def passives
  @passives ||= (config[PASSIVES] || []).map { |s| s.downcase }
end

#primary? ⇒ true, false

Returns whether this server is a primary, per the SDAM spec.

Examples:

Is the server a primary?

description.primary?

Returns:

  • (true, false) —

    If the server is a primary.

Since:

  • 2.0.0



650
651
652
653
654
 
# File 'lib/mongo/server/description.rb', line 650

def primary?
  ok? &&
    (config['ismaster'] == true || config['isWritablePrimary'] == true) &&
    !!config['setName']
end

#primary_host ⇒ String | nil

Get the address of the primary host.

Examples:

Get the address of the primary.

description.primary_host

Returns:

  • (String | nil) —

    The address of the primary.

Since:

  • 2.6.0



638
639
640
 
# File 'lib/mongo/server/description.rb', line 638

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

#replica_set_member? ⇒ true, false

Does this description correspond to a replica set member.

Examples:

Check if the description is from a replica set member.

description.replica_set_member?

Returns:

  • (true, false) —

    If the description is from a replica set member.

Since:

  • 2.0.6



798
799
800
 
# File 'lib/mongo/server/description.rb', line 798

def replica_set_member?
  ok? && !(standalone? || mongos?)
end

#replica_set_name ⇒ String?

Get the name of the replica set the server belongs to, returns nil if none.

Examples:

Get the replica set name.

description.replica_set_name

Returns:

  • (String, nil) —

    The name of the replica set.

Since:

  • 2.0.0



665
666
667
 
# File 'lib/mongo/server/description.rb', line 665

def replica_set_name
  config[SET_NAME]
end

#secondary? ⇒ true, false

Returns whether this server is a secondary, per the SDAM spec.

Examples:

Is the server a secondary?

description.secondary?

Returns:

  • (true, false) —

    If the server is a secondary.

Since:

  • 2.0.0



689
690
691
692
693
 
# File 'lib/mongo/server/description.rb', line 689

def secondary?
  ok? &&
    config['secondary'] == true &&
    !!config['setName']
end

#server_connection_id ⇒ Object

Since:

  • 2.0.0



866
867
868
 
# File 'lib/mongo/server/description.rb', line 866

def server_connection_id
  config['connectionId']
end

#server_type ⇒ Symbol

Returns the server type as a symbol.

Examples:

Get the server type.

description.server_type

Returns:

  • (Symbol) —

    The server type.

Since:

  • 2.4.0



703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/mongo/server/description.rb', line 703

def server_type
  return :load_balancer if load_balancer?
  return :arbiter if arbiter?
  return :ghost if ghost?
  return :sharded if mongos?
  return :primary if primary?
  return :secondary if secondary?
  return :standalone if standalone?
  return :other if other?

  :unknown
end

#server_version_gte?(version) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)

Raises:

  • (NotImplementedError)

Since:

  • 2.0.0



912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/mongo/server/description.rb', line 912

def server_version_gte?(version)
  if load_balancer?
    # If we are talking to a load balancer, there is no monitoring
    # and we don't know what server is behind the load balancer.
    # Assume everything is supported.
    # TODO remove this when RUBY-2220 is implemented.
    return true
  end

  required_wv = SERVER_VERSION_WIRE_VERSION_MAP[version]
  raise NotImplementedError, "Unexpected server version #{version.inspect}" unless required_wv

  required_wv <= max_wire_version
end

#servers ⇒ Array<String>

Get a list of all servers known to the cluster.

Examples:

Get all servers.

description.servers

Returns:

  • (Array<String>) —

    The list of all servers.

Since:

  • 2.0.0



677
678
679
 
# File 'lib/mongo/server/description.rb', line 677

def servers
  hosts + arbiters + passives
end

#service_id ⇒ nil | Object

Returns The service id, if any.

Returns:

  • (nil | Object) —

    The service id, if any.

Since:

  • 2.0.0



873
874
875
 
# File 'lib/mongo/server/description.rb', line 873

def service_id
  config['serviceId']
end

#set_version ⇒ Integer

Get the setVersion from the config.

Examples:

Get the setVersion.

description.set_version

Returns:

  • (Integer) —

    The set version.

Since:

  • 2.2.2



506
507
508
 
# File 'lib/mongo/server/description.rb', line 506

def set_version
  config[SET_VERSION]
end

#standalone? ⇒ true, false

Returns whether this server is a standalone, per the SDAM spec.

Examples:

Is the server standalone?

description.standalone?

Returns:

  • (true, false) —

    If the server is standalone.

Since:

  • 2.0.0



724
725
726
727
728
729
 
# File 'lib/mongo/server/description.rb', line 724

def standalone?
  ok? &&
    config['msg'] != 'isdbgrid' &&
    config['setName'].nil? &&
    config['isreplicaset'] != true
end

#tags ⇒ Hash

Get the tags configured for the server.

Examples:

Get the tags.

description.tags

Returns:

  • (Hash) —

    The tags of the server.

Since:

  • 2.0.0



482
483
484
 
# File 'lib/mongo/server/description.rb', line 482

def tags
  config[TAGS] || {}
end

#topology_version ⇒ TopologyVersion | nil

Returns The topology version.

Returns:

Since:

  • 2.0.0



511
512
513
514
515
516
517
 
# File 'lib/mongo/server/description.rb', line 511

def topology_version
  unless defined?(@topology_version)
    @topology_version = config['topologyVersion'] &&
                        TopologyVersion.new(config['topologyVersion'])
  end
  @topology_version
end

#topology_version_gt?(other_desc) ⇒ true | false

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns whether topology version in this description is potentially newer than or equal to topology version in another description.

Parameters:

Returns:

  • (true | false) —

    Whether topology version in this description is potentially newer or equal.

Since:

  • 2.0.0



527
528
529
530
531
532
533
 
# File 'lib/mongo/server/description.rb', line 527

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

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns whether topology version in this description is potentially newer than topology version in another description.

Parameters:

Returns:

  • (true | false) —

    Whether topology version in this description is potentially newer.

Since:

  • 2.0.0



543
544
545
546
547
548
549
 
# File 'lib/mongo/server/description.rb', line 543

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

#unknown? ⇒ true, false

Returns whether this server is an unknown, per the SDAM spec.

Examples:

Is the server description unknown?

description.unknown?

Returns:

  • (true, false) —

    If the server description is unknown.

Since:

  • 2.0.0



739
740
741
742
743
 
# File 'lib/mongo/server/description.rb', line 739

def unknown?
  return false if load_balancer?

  config.empty? || config.keys == %w[topologyVersion] || !ok?
end

#wire_versions ⇒ Range

Get the range of supported wire versions for the server.

Examples:

Get the wire version range.

description.wire_versions

Returns:

  • (Range) —

    The wire version range.

Since:

  • 2.0.0



758
759
760
 
# File 'lib/mongo/server/description.rb', line 758

def wire_versions
  min_wire_version..max_wire_version
end