SecondaryPreferred — Documentation by YARD 0.9.37 (original) (raw)

Class: Mongo::ServerSelector::SecondaryPreferred

Inherits:

Base

• Object
• Base
• Mongo::ServerSelector::SecondaryPreferred show all

Defined in:

lib/mongo/server_selector/secondary_preferred.rb

Overview

Encapsulates specifications for selecting servers, with

secondaries preferred, given a list of candidates.

Constant Summarycollapse

SERVER_FORMATTED_NAME =

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

'secondaryPreferred'.freeze

Instance Attribute Summary

Attributes inherited from Base

#hedge, #max_staleness, #options, #tag_sets

Instance Method Summarycollapse

• #hedge_allowed? ⇒ true
  Whether the hedge option is allowed to be defined for this server preference.
• #name ⇒ Symbol
  Get the name of the server mode type.
• #secondary_ok? ⇒ true private
  Whether the secondaryOk bit should be set on wire protocol messages.
• #tags_allowed? ⇒ true
  Whether tag sets are allowed to be defined for this server preference.
• #to_doc ⇒ Hash
  Convert this server preference definition into a format appropriate for sending to a MongoDB server (i.e., as a command field).
• #to_mongos ⇒ Hash | nil
  Convert this server preference definition into a value appropriate for sending to a mongos.

Methods inherited from Base

#==, #candidates, #initialize, #inspect, #local_threshold, #local_threshold_with_cluster, #select_server, #server_selection_timeout, #suitable_servers, #try_select_server

Instance Method Details

#hedge_allowed? ⇒ true

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

#name ⇒ Symbol

Get the name of the server mode type.

#secondary_ok? ⇒ true

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

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

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

#tags_allowed? ⇒ true

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

#to_doc ⇒ Hash

Convert this server preference definition into a format appropriate

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

#to_mongos ⇒ Hash | nil

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.