class Mongo::ServerSelector::Secondary

Encapsulates specifications for selecting secondary servers given a list

of candidates.

@since 2.0.0

Constants

SERVER_FORMATTED_NAME

Name of the this read preference in the server's format.

@since 2.5.0

Public Instance Methods

hedge_allowed?() click to toggle source

Whether the hedge option is allowed to be defined for this server preference.

@return [ true ] true

# File lib/mongo/server_selector/secondary.rb, line 65
def hedge_allowed?
  true
end
name() click to toggle source

Get the name of the server mode type.

@example Get the name of the server mode for this preference.

preference.name

@return [ Symbol ] :secondary

@since 2.0.0

# File lib/mongo/server_selector/secondary.rb, line 40
def name
  :secondary
end
secondary_ok?() click to toggle source

Whether the secondaryOk bit should be set on wire protocol messages.

I.e. whether the operation can be performed on a secondary server.

@return [ true ] true @api private

# File lib/mongo/server_selector/secondary.rb, line 49
def secondary_ok?
  true
end
tags_allowed?() click to toggle source

Whether tag sets are allowed to be defined for this server preference.

@return [ true ] true

@since 2.0.0

# File lib/mongo/server_selector/secondary.rb, line 58
def tags_allowed?
  true
end
to_doc() click to toggle source

Convert this server preference definition into a format appropriate

for sending to a MongoDB server (i.e., as a command field).

@return [ Hash ] The server preference formatted as a command field value.

@since 2.0.0

# File lib/mongo/server_selector/secondary.rb, line 75
def to_doc
  full_doc
end
Also aliased as: to_mongos
to_mongos()

Convert this server preference definition into a value appropriate

for sending to a mongos.

This method may return nil if the read preference should not be sent to a mongos.

@return [ Hash | nil ] The server preference converted to a mongos

command field value.

@since 2.0.0

Alias for: to_doc

Private Instance Methods

max_staleness_allowed?() click to toggle source
# File lib/mongo/server_selector/secondary.rb, line 103
def max_staleness_allowed?
  true
end
select_in_replica_set(candidates) click to toggle source

Select the secondary servers taking into account any defined tag sets and

local threshold between the nearest secondary and other secondaries.

@return [ Array ] The secondary servers from the list of candidates.

@since 2.0.0

# File lib/mongo/server_selector/secondary.rb, line 99
def select_in_replica_set(candidates)
  near_servers(secondaries(candidates))
end