Class: Mongo::Server::Description

Relationships & Source Files
Namespace Children
Classes: `Features`, `LoadBalancer`
Inherits:	Object
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

Constant Summary

ARBITER =

Deprecated.

Constant for reading arbiter info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 38
```
'arbiterOnly'.freeze
```
ARBITERS =

Constant for reading arbiters info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 43
```
'arbiters'.freeze
```
CONNECTION_ID = Internal use only

Constant for reading connectionId info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 189
```
'connectionId'.freeze
```
DEFAULT_MAX_WRITE_BATCH_SIZE =

Default max write batch size.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 116
```
1000.freeze
```
ELECTION_ID =

Constant for reading electionId info from config.
Since:
- 2.1.0
# File 'lib/mongo/server/description.rb', line 164
```
'electionId'.freeze
```
EXCLUDE_FOR_COMPARISON =

Fields to exclude when comparing two descriptions.
Since:
- 2.0.6
# File 'lib/mongo/server/description.rb', line 194
```
[ LOCAL_TIME,
  LAST_WRITE,
  OPERATION_TIME,
  Operation::CLUSTER_TIME,
  CONNECTION_ID,
].freeze
```
HIDDEN =

Constant for reading hidden info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 48
```
'hidden'.freeze
```
HOSTS =

Constant for reading hosts info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 53
```
'hosts'.freeze
```
LAST_WRITE =

Constant for the lastWrite subdocument.
Since:
- 2.4.0
# File 'lib/mongo/server/description.rb', line 101
```
'lastWrite'.freeze
```
LAST_WRITE_DATE =

Constant for the lastWriteDate field in the lastWrite subdocument.
Since:
- 2.4.0
# File 'lib/mongo/server/description.rb', line 106
```
'lastWriteDate'.freeze
```
LEGACY_WIRE_VERSION =

Deprecated.

Will be removed in 3.0.

The legacy wire protocol version.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 122
```
0.freeze
```
LOCAL_TIME =

Constant for reading localTime info from config.
Since:
- 2.1.0
# File 'lib/mongo/server/description.rb', line 174
```
'localTime'.freeze
```
LOGICAL_SESSION_TIMEOUT_MINUTES =

Constant for reading logicalSessionTimeoutMinutes info from config.
Since:
- 2.5.0
# File 'lib/mongo/server/description.rb', line 184
```
'logicalSessionTimeoutMinutes'.freeze
```
MAX_BSON_OBJECT_SIZE =

Constant for reading max bson size info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 76
```
'maxBsonObjectSize'.freeze
```
MAX_MESSAGE_BYTES =

Constant for reading max message size info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 81
```
'maxMessageSizeBytes'.freeze
```
MAX_WIRE_VERSION =

Constant for the max wire version.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 86
```
'maxWireVersion'.freeze
```
MAX_WRITE_BATCH_SIZE =

Constant for reading max write batch size.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 96
```
'maxWriteBatchSize'.freeze
```
ME =

Constant for reading the me field.
Since:
- 2.1.0
# File 'lib/mongo/server/description.rb', line 111
```
'me'.freeze
```
MESSAGE =

Deprecated.

Constant for the key for the message value.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 59
```
'msg'.freeze
```
MIN_WIRE_VERSION =

Constant for min wire version.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 91
```
'minWireVersion'.freeze
```
MONGOS_MESSAGE =

Deprecated.

Constant for the message that indicates a sharded cluster.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 65
```
'isdbgrid'.freeze
```
OPERATION_TIME =

Constant for reading operationTime info from config.
Since:
- 2.5.0
# File 'lib/mongo/server/description.rb', line 179
```
'operationTime'.freeze
```
PASSIVE =

Constant for reading passive info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 127
```
'passive'.freeze
```
PASSIVES =

Constant for reading the passive server list.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 132
```
'passives'.freeze
```
PRIMARY =

Deprecated.

Constant for reading primary info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 138
```
'ismaster'.freeze
```
PRIMARY_HOST =

Constant for reading primary host field from config.
Since:
- 2.5.0
# File 'lib/mongo/server/description.rb', line 143
```
'primary'.freeze
```
REPLICA_SET =

Deprecated.

Constant for determining ghost servers.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 71
```
'isreplicaset'.freeze
```
SECONDARY =

Deprecated.

Constant for reading secondary info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 149
```
'secondary'.freeze
```
SET_NAME =

Constant for reading replica set name info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 154
```
'setName'.freeze
```
SET_VERSION =

Constant for reading setVersion info from config.
Since:
- 2.2.2
# File 'lib/mongo/server/description.rb', line 169
```
'setVersion'.freeze
```
TAGS =

Constant for reading tags info from config.
Since:
- 2.0.0
# File 'lib/mongo/server/description.rb', line 159
```
'tags'.freeze
```

Class Method Summary

.new(address, config = {}, average_round_trip_time: nil, minimum_round_trip_time: 0, load_balancer: false, force_load_balancer: false) ⇒ Description constructor Internal use only Internal use only

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

Instance Attribute Summary

#address ⇒ Address readonly
#arbiter? ⇒ true, false readonly

Returns whether this server is an arbiter, per the SDAM spec.
#average_round_trip_time ⇒ Float readonly
#config ⇒ Hash readonly
#data_bearing? ⇒ true, false readonly

Whether this description is from a data-bearing server (standalone, mongos, primary or secondary).
#ghost? ⇒ true, false readonly

Whether this server is a ghost, per the SDAM spec.
#hidden? ⇒ true, false readonly

Will return true if the server is hidden.
#last_update_monotime ⇒ Float readonly Internal use only Internal use only

Time when this server description was created according to monotonic clock.
#last_update_time ⇒ Time readonly

Time when this server description was created.
#load_balancer? ⇒ true | false readonly

Returns whether this server is a load balancer.
#me_mismatch? ⇒ true, false readonly

Check if there is a mismatch between the address host and the me field.
#minimum_round_trip_time ⇒ Float readonly
#mongocryptd? ⇒ true, false readonly

Whether this description is from a mongocryptd server.
#mongos? ⇒ true, false readonly

Returns whether this server is a mongos, per the SDAM spec.
#ok? ⇒ Boolean readonly Internal use only Internal use only
#other? ⇒ true, false readonly

Returns whether the server is an other, per the SDAM spec.
#passive? ⇒ true, false readonly

Will return true if the server is passive.
#primary? ⇒ true, false readonly

Returns whether this server is a primary, per the SDAM spec.
#replica_set_member? ⇒ true, false readonly

Does this description correspond to a replica set member.
#secondary? ⇒ true, false readonly

Returns whether this server is a secondary, per the SDAM spec.
#standalone? ⇒ true, false readonly

Returns whether this server is a standalone, per the SDAM spec.
#unknown? ⇒ true, false readonly

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

Instance Method Summary

#==(other) ⇒ true, false (also: #eql?)

Check equality of two descriptions.
#arbiters ⇒ Array<String>

Get a list of all arbiters in the replica set.
#election_id ⇒ BSON::ObjectId

Get the electionId from the config.
#eql?(other)

Alias for #==.
#features ⇒ Features
#hosts ⇒ Array<String>

Get a list of all servers in the replica set.
#inspect ⇒ String

Inspect the server description.
#is_server?(server) ⇒ true, false deprecated Deprecated.
#last_write_date ⇒ Time

Get the lastWriteDate from the lastWrite subdocument in the config.
#lists_server?(server) ⇒ true, false deprecated Deprecated.
#logical_session_timeout ⇒ Integer^?

Get the logicalSessionTimeoutMinutes from the config.
#max_bson_object_size ⇒ Integer

Get the max BSON object size for this server version.
#max_message_size ⇒ Integer

Get the max message size for this server version.
#max_wire_version ⇒ Integer

Get the maximum wire version.
#max_write_batch_size ⇒ Integer

Get the maximum batch size for writes.
#me ⇒ String

Get the me field value.
#min_wire_version ⇒ Integer

Get the minimum wire version.
#op_time ⇒ BSON::Timestamp

opTime in lastWrite subdocument of the hello response.
#passives ⇒ Array<String>

Get a list of the passive servers in the cluster.
#primary_host ⇒ String | nil

Get the address of the primary host.
#replica_set_name ⇒ String^?

Get the name of the replica set the server belongs to, returns nil if none.
#server_connection_id
#server_type ⇒ Symbol

Returns the server type as a symbol.
#server_version_gte?(version) ⇒ Boolean Internal use only Internal use only
#servers ⇒ Array<String>

Get a list of all servers known to the cluster.
#service_id ⇒ nil | Object
#set_version ⇒ Integer

Get the setVersion from the config.
#tags ⇒ Hash

Get the tags configured for the server.
#topology_version ⇒ TopologyVersion | nil
#topology_version_gt?(other_desc) ⇒ true | false Internal use only Internal use only

Returns whether topology version in this description is potentially newer than or equal to topology version in another description.
#topology_version_gte?(other_desc) ⇒ true | false Internal use only Internal use only

Returns whether topology version in this description is potentially newer than topology version in another description.
#wire_versions ⇒ Range

Get the range of supported wire versions for the server.

Instance Attribute Details

#address ⇒ Address (readonly)

Returns:

(Address) —

address The server’s address.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 287


attr_reader :address

#arbiter? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

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


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

#average_round_trip_time ⇒ `Float` (readonly)

Returns:

(Float) —

The moving average time the hello call took to complete.

Since:

2.0.0

[ GitHub ]

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


attr_reader :average_round_trip_time

#config ⇒ `Hash` (readonly)

Returns:

(Hash) —

The actual result from the hello command.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 290


attr_reader :config

#data_bearing? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 794


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

#ghost? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 345


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

#hidden? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

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


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

#last_update_monotime ⇒ `Float` (readonly)

This method is for internal use only.

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

Returns:

(Float) —

::Mongo::Server description creation monotonic time.

#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) —

::Mongo::Server description creation time.

Since:

2.7.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 839


attr_reader :last_update_time

#load_balancer? ⇒ `true` | `false` (readonly)

Returns whether this server is a load balancer.

Returns:

(true | false) —

Whether this server is a load balancer.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 295


def load_balancer?
  @load_balancer
end

#me_mismatch? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 806


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

#minimum_round_trip_time ⇒ `Float` (readonly)

Returns:

(Float) —

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

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 309


attr_reader :minimum_round_trip_time

#mongocryptd? ⇒ `true`, `false` (readonly)

Whether this description is from a mongocryptd server.

Returns:

(true, false) —

Whether this description is from a mongocryptd server.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 814


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

#mongos? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 570


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

#ok? ⇒ `Boolean` (readonly)

This method is for internal use only.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 731


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

#other? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 582


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` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 601


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

#primary? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 637


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

#replica_set_member? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 783


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

#secondary? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 676


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

#standalone? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 710


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

#unknown? ⇒ `true`, `false` (readonly)

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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 725


def unknown?
  return false if load_balancer?
  config.empty? || config.keys == %w(topologyVersion) || !ok?
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 872


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

  (config.keys + other.config.keys).uniq.all? do |k|
    config[k] == other.config[k] || EXCLUDE_FOR_COMPARISON.include?(k)
  end
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 333


def arbiters
  @arbiters ||= (config[ARBITERS] || []).map { |s| s.downcase }
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 481


def election_id
  config[ELECTION_ID]
end

#eql?(other)

Alias for #==.

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 880


alias_method :eql?, :==

#features ⇒ Features

Returns:

(Features) —

features The features for the server.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 300


def features
  @features
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 370


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 382


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 756


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 546


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 770


def lists_server?(server)
  servers.include?(server.address.to_s)
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 558


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 394


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 406


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 430


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 418


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

[ GitHub ]

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


def me
  config[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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 442


def min_wire_version
  config[MIN_WIRE_VERSION] || 0
end

#op_time ⇒ `BSON::Timestamp`

opTime in lastWrite subdocument of the hello response.

Returns:

(BSON::Timestamp) —

The timestamp.

Since:

2.7.0

[ GitHub ]

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


def op_time
  if config['lastWrite'] && config['lastWrite']['opTime']
    config['lastWrite']['opTime']['ts']
  end
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 613


def passives
  @passives ||= (config[PASSIVES] || []).map { |s| s.downcase }
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 625


def primary_host
  config[PRIMARY_HOST] && config[PRIMARY_HOST].downcase
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 652


def replica_set_name
  config[SET_NAME]
end

#server_connection_id

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 851


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 690


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 for internal use only.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 883


def server_version_gte?(version)
  required_wv = case version
    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
      raise ArgumentError, "Bogus required version #{version}"
    end

  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 >= min_wire_version && 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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 664


def servers
  hosts + arbiters + passives
end

#service_id ⇒ `nil` | `Object`

Returns:

(nil | Object) —

The service id, if any.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 858


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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 493


def set_version
  config[SET_VERSION]
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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 469


def tags
  config[TAGS] || {}
end

#topology_version ⇒ TopologyVersion | `nil`

Returns:

(TopologyVersion | nil) —

The topology version.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 498


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 for internal use only.

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

Parameters:

other_desc (Server::Description) —

The other server description.

Returns:

(true | false) —

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

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 514


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 for internal use only.

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

Parameters:

other_desc (Server::Description) —

The other server description.

Returns:

(true | false) —

Whether topology version in this description is potentially newer.

Since:

2.0.0

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 530


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

#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

[ GitHub ]

# File 'lib/mongo/server/description.rb', line 743


def wire_versions
  min_wire_version..max_wire_version
end

Class: Mongo::Server::Description

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#address ⇒ Address (readonly)

#arbiter? ⇒ true, false (readonly)

#average_round_trip_time ⇒ Float (readonly)

#config ⇒ Hash (readonly)

#data_bearing? ⇒ true, false (readonly)

#ghost? ⇒ true, false (readonly)

#hidden? ⇒ true, false (readonly)

#last_update_monotime ⇒ Float (readonly)

#last_update_time ⇒ Time (readonly)

#load_balancer? ⇒ true | false (readonly)

#me_mismatch? ⇒ true, false (readonly)

#minimum_round_trip_time ⇒ Float (readonly)

#mongocryptd? ⇒ true, false (readonly)

#mongos? ⇒ true, false (readonly)

#ok? ⇒ Boolean (readonly)

#other? ⇒ true, false (readonly)

#passive? ⇒ true, false (readonly)

#primary? ⇒ true, false (readonly)

#replica_set_member? ⇒ true, false (readonly)

#secondary? ⇒ true, false (readonly)

#standalone? ⇒ true, false (readonly)

#unknown? ⇒ true, false (readonly)

Instance Method Details

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

#arbiters ⇒ Array<String>

#election_id ⇒ BSON::ObjectId

#eql?(other)

#features ⇒ Features

#hosts ⇒ Array<String>

#inspect ⇒ String

#is_server?(server) ⇒ true, false

#last_write_date ⇒ Time

#lists_server?(server) ⇒ true, false

#logical_session_timeout ⇒ Integer?

#max_bson_object_size ⇒ Integer

#max_message_size ⇒ Integer

#max_wire_version ⇒ Integer

#max_write_batch_size ⇒ Integer

#me ⇒ String

#min_wire_version ⇒ Integer

#op_time ⇒ BSON::Timestamp

#passives ⇒ Array<String>

#primary_host ⇒ String | nil

#replica_set_name ⇒ String?

#server_connection_id

#server_type ⇒ Symbol

#server_version_gte?(version) ⇒ Boolean

#servers ⇒ Array<String>

#service_id ⇒ nil | Object

#set_version ⇒ Integer

#tags ⇒ Hash

#topology_version ⇒ TopologyVersion | nil

#topology_version_gt?(other_desc) ⇒ true | false

#topology_version_gte?(other_desc) ⇒ true | false

#wire_versions ⇒ Range

#arbiter? ⇒ `true`, `false` (readonly)

#average_round_trip_time ⇒ `Float` (readonly)

#config ⇒ `Hash` (readonly)

#data_bearing? ⇒ `true`, `false` (readonly)

#ghost? ⇒ `true`, `false` (readonly)

#hidden? ⇒ `true`, `false` (readonly)

#last_update_monotime ⇒ `Float` (readonly)

#last_update_time ⇒ `Time` (readonly)

#load_balancer? ⇒ `true` | `false` (readonly)

#me_mismatch? ⇒ `true`, `false` (readonly)

#minimum_round_trip_time ⇒ `Float` (readonly)

#mongocryptd? ⇒ `true`, `false` (readonly)

#mongos? ⇒ `true`, `false` (readonly)

#ok? ⇒ `Boolean` (readonly)

#other? ⇒ `true`, `false` (readonly)

#passive? ⇒ `true`, `false` (readonly)

#primary? ⇒ `true`, `false` (readonly)

#replica_set_member? ⇒ `true`, `false` (readonly)

#secondary? ⇒ `true`, `false` (readonly)

#standalone? ⇒ `true`, `false` (readonly)

#unknown? ⇒ `true`, `false` (readonly)

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

#arbiters ⇒ `Array`<`String`>

#election_id ⇒ `BSON::ObjectId`

#hosts ⇒ `Array`<`String`>

#inspect ⇒ `String`

#is_server?(server) ⇒ `true`, `false`

#last_write_date ⇒ `Time`

#lists_server?(server) ⇒ `true`, `false`

#logical_session_timeout ⇒ `Integer`^?

#max_bson_object_size ⇒ `Integer`

#max_message_size ⇒ `Integer`

#max_wire_version ⇒ `Integer`

#max_write_batch_size ⇒ `Integer`

#me ⇒ `String`

#min_wire_version ⇒ `Integer`

#op_time ⇒ `BSON::Timestamp`

#passives ⇒ `Array`<`String`>

#primary_host ⇒ `String` | `nil`

#replica_set_name ⇒ `String`^?

#server_version_gte?(version) ⇒ `Boolean`

#servers ⇒ `Array`<`String`>

#service_id ⇒ `nil` | `Object`

#set_version ⇒ `Integer`

#tags ⇒ `Hash`

#topology_version ⇒ TopologyVersion | `nil`

#topology_version_gt?(other_desc) ⇒ `true` | `false`

#topology_version_gte?(other_desc) ⇒ `true` | `false`

#wire_versions ⇒ `Range`