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
Whether the hedge option is allowed to be defined for this server preference.
@return [ true ] true
# File lib/mongo/server_selector/secondary.rb, line 64 def hedge_allowed? true end
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 38 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 48 def slave_ok? true end
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 74 def to_doc full_doc end
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
Private Instance Methods
# File lib/mongo/server_selector/secondary.rb, line 102 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.
@return [ Array ] The secondary servers from the list of candidates.
@since 2.0.0
# File lib/mongo/server_selector/secondary.rb, line 98 def select_in_replica_set(candidates) near_servers(secondaries(candidates)) end