Class Mongo::Server::Description
In: lib/mongo/server/description.rb
lib/mongo/server/description/features.rb
Parent: Object

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

@since 2.0.0

Methods

==   arbiter?   arbiters   data_bearing?   election_id   eql?   features   ghost?   hidden?   hosts   inspect   is_server?   last_write_date   lists_server?   logical_session_timeout   max_bson_object_size   max_message_size   max_wire_version   max_write_batch_size   me   me_mismatch?   min_wire_version   mongos?   new   ok?   op_time   other?   passive?   passives   primary?   primary_host   replica_set_member?   replica_set_name   secondary?   server_type   servers   set_version   standalone?   tags   unknown?   wire_versions  

Classes and Modules

Class Mongo::Server::Description::Features

Constants

ARBITER = 'arbiterOnly'.freeze   Constant for reading arbiter info from config.

@since 2.0.0

ARBITERS = 'arbiters'.freeze   Constant for reading arbiters info from config.

@since 2.0.0

HIDDEN = 'hidden'.freeze   Constant for reading hidden info from config.

@since 2.0.0

HOSTS = 'hosts'.freeze   Constant for reading hosts info from config.

@since 2.0.0

MESSAGE = 'msg'.freeze   Constant for the key for the message value.

@since 2.0.0

MONGOS_MESSAGE = 'isdbgrid'.freeze   Constant for the message that indicates a sharded cluster.

@since 2.0.0

REPLICA_SET = 'isreplicaset'.freeze   Constant for determining ghost servers.

@since 2.0.0

MAX_BSON_OBJECT_SIZE = 'maxBsonObjectSize'.freeze   Constant for reading max bson size info from config.

@since 2.0.0

MAX_MESSAGE_BYTES = 'maxMessageSizeBytes'.freeze   Constant for reading max message size info from config.

@since 2.0.0

MAX_WIRE_VERSION = 'maxWireVersion'.freeze   Constant for the max wire version.

@since 2.0.0

MIN_WIRE_VERSION = 'minWireVersion'.freeze   Constant for min wire version.

@since 2.0.0

MAX_WRITE_BATCH_SIZE = 'maxWriteBatchSize'.freeze   Constant for reading max write batch size.

@since 2.0.0

LAST_WRITE = 'lastWrite'.freeze   Constant for the lastWrite subdocument.

@since 2.4.0

LAST_WRITE_DATE = 'lastWriteDate'.freeze   Constant for the lastWriteDate field in the lastWrite subdocument.

@since 2.4.0

ME = 'me'.freeze   Constant for reading the me field.

@since 2.1.0

DEFAULT_MAX_WRITE_BATCH_SIZE = 1000.freeze   Default max write batch size.

@since 2.0.0

LEGACY_WIRE_VERSION = 0.freeze   The legacy wire protocol version.

@since 2.0.0 @deprecated Will be removed in 3.0.

PASSIVE = 'passive'.freeze   Constant for reading passive info from config.

@since 2.0.0

PASSIVES = 'passives'.freeze   Constant for reading the passive server list.

@since 2.0.0

PRIMARY = 'ismaster'.freeze   Constant for reading primary info from config.

@since 2.0.0

PRIMARY_HOST = 'primary'.freeze   Constant for reading primary host field from config.

@since 2.5.0

SECONDARY = 'secondary'.freeze   Constant for reading secondary info from config.

@since 2.0.0

SET_NAME = 'setName'.freeze   Constant for reading replica set name info from config.

@since 2.0.0

TAGS = 'tags'.freeze   Constant for reading tags info from config.

@since 2.0.0

ELECTION_ID = 'electionId'.freeze   Constant for reading electionId info from config.

@since 2.1.0

SET_VERSION = 'setVersion'.freeze   Constant for reading setVersion info from config.

@since 2.2.2

LOCAL_TIME = 'localTime'.freeze   Constant for reading localTime info from config.

@since 2.1.0

OPERATION_TIME = 'operationTime'.freeze   Constant for reading operationTime info from config.

@since 2.5.0

LOGICAL_SESSION_TIMEOUT_MINUTES = 'logicalSessionTimeoutMinutes'.freeze   Constant for reading logicalSessionTimeoutMinutes info from config.

@since 2.5.0

EXCLUDE_FOR_COMPARISON = [ LOCAL_TIME, LAST_WRITE, OPERATION_TIME, Operation::CLUSTER_TIME ].freeze   Fields to exclude when comparing two descriptions.

@since 2.0.6

Attributes

address  [R]  @return [ Address ] address The server‘s address.
average_round_trip_time  [R]  @return [ Float ] The moving average time the ismaster call took to complete.
config  [R]  @return [ Hash ] The actual result from the ismaster command.
last_update_time  [R]  Time when the server was last checked.

@return [ Time ] Last check time.

@since 2.7.0

Public Class methods

new(address, config = {}, average_round_trip_time = nil)

Instantiate the new server description from the result of the ismaster command.

@example Instantiate the new description. 

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

@param [ Address ] address The server address. @param [ Hash ] config The result of the ismaster command. @param [ Float ] average_round_trip_time The moving average time (sec) the ismaster 

  call took to complete.

@since 2.0.0

Public Instance methods

==(other)

Check equality of two descriptions.

@example Check description equality. 

  description == other

@param [ Object ] other The other description.

@return [ true, false ] Whether the objects are equal.

@since 2.0.6

arbiter?()

Will return true if the server is an arbiter.

@example Is the server an arbiter? 

  description.arbiter?

@return [ true, false ] If the server is an arbiter.

@since 2.0.0

arbiters()

Get a list of all arbiters in the replica set.

@example Get the arbiters in the replica set. 

  description.arbiters

@return [ Array<String> ] The arbiters in the set.

@since 2.0.0

data_bearing?()

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

@return [ true, false ] Whether the description is from a data-bearing 

  server.

@since 2.7.0

election_id()

Get the electionId from the config.

@example Get the electionId. 

  description.election_id

@return [ BSON::ObjectId ] The election id.

@since 2.1.0

eql?(other)

Alias for #==

features()

@return [ Features ] features The features for the server.

ghost?()

Is the server a ghost in a replica set?

@example Is the server a ghost? 

  description.ghost?

@return [ true, false ] If the server is a ghost.

@since 2.0.0

hidden?()

Will return true if the server is hidden.

@example Is the server hidden? 

  description.hidden?

@return [ true, false ] If the server is hidden.

@since 2.0.0

hosts()

Get a list of all servers in the replica set.

@example Get the servers in the replica set. 

  description.hosts

@return [ Array<String> ] The servers in the set.

@since 2.0.0

inspect()

Inspect the server description.

@example Inspect the server description 

  description.inspect

@return [ String ] The inspection.

@since 2.0.0

is_server?(server)

Is this description from the given server.

@example Check if the description is from a given server. 

  description.is_server?(server)

@return [ true, false ] If the description is from the server.

@since 2.0.6

last_write_date()

Get the lastWriteDate from the lastWrite subdocument in the config.

@example Get the lastWriteDate value. 

  description.last_write_date

@return [ Time ] The last write date.

@since 2.4.0

lists_server?(server)

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

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

  description.lists_server?(server)

@return [ true, false ] If a server is in the description‘s list 

  of servers.

@since 2.0.6

logical_session_timeout()

Get the logicalSessionTimeoutMinutes from the config.

@example Get the logicalSessionTimeoutMinutes value in minutes. 

  description.logical_session_timeout

@return [ Integer, nil ] The logical session timeout in minutes.

@since 2.5.0

max_bson_object_size()

Get the max BSON object size for this server version.

@example Get the max BSON object size. 

  description.max_bson_object_size

@return [ Integer ] The maximum object size in bytes.

@since 2.0.0

max_message_size()

Get the max message size for this server version.

@example Get the max message size. 

  description.max_message_size

@return [ Integer ] The maximum message size in bytes.

@since 2.0.0

max_wire_version()

Get the maximum wire version.

@example Get the max wire version. 

  description.max_wire_version

@return [ Integer ] The max wire version supported.

@since 2.0.0

max_write_batch_size()

Get the maximum batch size for writes.

@example Get the max batch size. 

  description.max_write_batch_size

@return [ Integer ] The max batch size.

@since 2.0.0

me()

Get the me field value.

@example Get the me field value. 

  description.me

@return [ String ] The me field.

@since 2.1.0

me_mismatch?()

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

@example Check if there is a mismatch. 

  description.me_mismatch?

@return [ true, false ] If there is a mismatch between the me field and the address host.

@since 2.0.6

min_wire_version()

Get the minimum wire version.

@example Get the min wire version. 

  description.min_wire_version

@return [ Integer ] The min wire version supported.

@since 2.0.0

mongos?()

Is the server a mongos?

@example Is the server a mongos? 

  description.mongos?

@return [ true, false ] If the server is a mongos.

@since 2.0.0

ok?()

@api private

op_time()

opTime in lastWrite subdocument of the ismaster response.

@return [ BSON::Timestamp ] The timestamp.

@since 2.7.0

other?()

Is the description of type other.

@example Is the description of type other. 

  description.other?

@return [ true, false ] If the description is other.

@since 2.0.0

passive?()

Will return true if the server is passive.

@example Is the server passive? 

  description.passive?

@return [ true, false ] If the server is passive.

@since 2.0.0

passives()

Get a list of the passive servers in the cluster.

@example Get the passives. 

  description.passives

@return [ Array<String> ] The list of passives.

@since 2.0.0

primary?()

Will return true if the server is a primary.

@example Is the server a primary? 

  description.primary?

@return [ true, false ] If the server is a primary.

@since 2.0.0

primary_host()

Get the address of the primary host.

@example Get the address of the primary. 

  description.primary_host

@return [ String | nil ] The address of the primary.

@since 2.6.0

replica_set_member?()

Does this description correspond to a replica set member.

@example Check if the description is from a replica set member. 

  description.replica_set_member?

@return [ true, false ] If the description is from a replica set 

  member.

@since 2.0.6

replica_set_name()

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

@example Get the replica set name. 

  description.replica_set_name

@return [ String, nil ] The name of the replica set.

@since 2.0.0

secondary?()

Will return true if the server is a secondary.

@example Is the server a secondary? 

  description.secondary?

@return [ true, false ] If the server is a secondary.

@since 2.0.0

server_type()

Returns the server type as a symbol.

@example Get the server type. 

  description.server_type

@return [ Symbol ] The server type.

@since 2.4.0

servers()

Get a list of all servers known to the cluster.

@example Get all servers. 

  description.servers

@return [ Array<String> ] The list of all servers.

@since 2.0.0

set_version()

Get the setVersion from the config.

@example Get the setVersion. 

  description.set_version

@return [ Integer ] The set version.

@since 2.2.2

standalone?()

Is this server a standalone server?

@example Is the server standalone? 

  description.standalone?

@return [ true, false ] If the server is standalone.

@since 2.0.0

tags()

Get the tags configured for the server.

@example Get the tags. 

  description.tags

@return [ Hash ] The tags of the server.

@since 2.0.0

unknown?()

Is the server description currently unknown?

@example Is the server description unknown? 

  description.unknown?

@return [ true, false ] If the server description is unknown.

@since 2.0.0

wire_versions()

Get the range of supported wire versions for the server.

@example Get the wire version range. 

  description.wire_versions

@return [ Range ] The wire version range.

@since 2.0.0

[Validate]