クラス: Mongo::ServerSelector::SecondaryPreferred

継承:
Base
  • オブジェクト
すべて表示
定義:
build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb

Overview

サーバーを選択するための仕様をカプセル化します。

secondaries preferred, given a list of candidates.

以来

  • 2.0.0

定数の概要の削減

SERVER_フォーマット_NAME =

サーバーの形式でのこの読み込み設定（read preference）の名前。

以来

  • 2.5.0

' secondaryPreferred '.freeze

インスタンス属性の概要

baseから継承される属性

#hedge, #max_staleness, #options, #tag_sets

インスタンス メソッドの概要を折りたたむ

baseから継承されたメソッド

# ===============================================================================================

コンストラクターの詳細

このクラスは、 Mongo::ServerSelector::Baseからコンストラクターを継承します。

インスタンス メソッドの詳細

# hedge_allowed? = true

このサーバー設定にヘッジ オプションを定義できるかどうか。

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



66
67
68
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行66

デフォルト hedge_allowed?
  true
end

#name ⇒ Symbol

サーバー モード タイプの名前を取得します。

例:

この設定のサーバー モードの名前を取得します。

preference.name

次の値を返します。

以来

  • 2.0.0



41
42
43
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行41

デフォルト name
  :secondary_preferred
end

# secondary_ok? = true

このメソッドは、プライベート API の一部です。 このメソッドは将来削除または変更される可能性があるため、可能な限り使用しないでください。

ワイヤプロトコルのメッセージで secondaryOk ビットを設定するかどうか。

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

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



50
51
52
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行50

デフォルト secondary_ok?
  true
end

タグ_許可はありますか？ = true

このサーバー設定でタグセットを定義できるかどうか。

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



59
60
61
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行59

デフォルト tags_許可されていますか？
  true
end

#to_doc ⇒ Hash

このサーバー設定の定義を適切な形式に変換します

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

次の値を返します。

  • （ハッシュ） —

    コマンド フィールド値として形式化されたサーバー設定。

以来

  • 2.0.0



76
77
78
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行76

デフォルト to_doc
  full_doc
end

#to_mongos ⇒ Hash | nil

このサーバー設定の定義を適切な値に変換します

for sending to a mongos.

読み込み設定 (read preference) が mongos に送信されない場合、このメソッドは nil を返すことがあります。

次の値を返します。

  • (ハッシュ | nil ) —

    サーバーの設定を mongos コマンドの フィールド値に変換しました。

以来

  • 2.0.0



90
91
92
93
 
# ファイル 'Build/ruby-Driver-v 2.19 /lib/mongo/server_selector/secondary_preferred.rb', 行90

デフォルト to_mongos
  # 読み込み設定（read preference）は常に mongos: Drivers- 1642に送信します。
  to_doc
end