class Mongo::ServerSelector::Primary
Encapsulates specifications for selecting the primary server 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
Source
# File lib/mongo/server_selector/primary.rb, line 64 def hedge_allowed? false end
Whether the hedge option is allowed to be defined for this server preference.
@return [ false ] false
Source
# File lib/mongo/server_selector/primary.rb, line 38 def name :primary end
Get the name of the server mode type.
@example Get the name of the server mode for this preference.
preference.name
@return [ Symbol
] :primary
@since 2.0.0
Source
# File lib/mongo/server_selector/primary.rb, line 48 def slave_ok? false 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 [ false ] false
@since 2.0.0
Source
# File lib/mongo/server_selector/primary.rb, line 74 def to_doc { mode: SERVER_FORMATTED_NAME } 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.5.0
Source
# File lib/mongo/server_selector/primary.rb, line 88 def to_mongos nil 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
Source
# File lib/mongo/server_selector/primary.rb, line 103 def max_staleness_allowed? false end
Source
# File lib/mongo/server_selector/primary.rb, line 99 def select_in_replica_set(candidates) primary(candidates) end
Select the primary server from a list of candidates.
@return [ Array ] The primary server from the list of candidates.
@since 2.0.0