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
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 39 def name :secondary end
Whether the slaveOk bit should be set on wire protocol messages.
I.e. whether the operation can be performed on a secondary server.
@return [ true ] true
@since 2.0.0
# File lib/mongo/server_selector/secondary.rb, line 49 def slave_ok? true end
Convert this server preference definition into a format appropriate
for a mongos server.
@example Convert this server preference definition into a format
for mongos. preference = Mongo::ServerSelector::Secondary.new preference.to_mongos
@return [ Hash ] The server preference formatted for a mongos server.
@since 2.0.0
# File lib/mongo/server_selector/secondary.rb, line 73 def to_mongos @doc ||= (preference = { :mode => SERVER_FORMATTED_NAME } preference.merge!({ :tags => tag_sets }) unless tag_sets.empty? preference.merge!({ maxStalenessSeconds: max_staleness }) if max_staleness preference) end
Private Instance Methods
# File lib/mongo/server_selector/secondary.rb, line 97 def max_staleness_allowed? true end
Select the secondary servers taking into account any defined tag sets and
local threshold between the nearest secondary and other secondaries.
@example Select secondary servers given a list of candidates.
preference = Mongo::ServerSelector::Secondary.new preference.select([candidate_1, candidate_2])
@return [ Array ] The secondary servers from the list of candidates.
@since 2.0.0
# File lib/mongo/server_selector/secondary.rb, line 93 def select(candidates) near_servers(secondaries(candidates)) end