クラス: Mongo::ServerSelector::SecondaryPreferred

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

Overview

候補者のリストが指定された場合に、セカンダリを優先してサーバーを選択するための仕様をカプセル化します。

以来

  • 2.0.0

定数の概要の削減

SERVER_フォーマット_NAME =

サーバーの形式での、この読み込み設定 (read preference)の名前。

以来

  • 2.5.0

'secondaryPreferred'

インスタンス属性の概要

baseから継承される属性

#hedge, #max_staleness, #options, #tag_sets

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

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

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

コンストラクターの詳細

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

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

# hedge_allowed? = true

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

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



62
63
64
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 62

デフォルト hedge_allowed?
  true
end

#name ⇒ Symbol

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

例:

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

preference.name

次の値を返します。

以来

  • 2.0.0



37
38
39
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 37

デフォルト name
  :secondary_preferred
end

# secondary_ok? = true

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

ワイヤプロトコルのメッセージで secondaryOk ビットを設定するかどうか。すなわち操作をセカンダリサーバーで実行できるかどうか。

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



46
47
48
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 46

デフォルト secondary_ok?
  true
end

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

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

次の値を返します。

  • ( true ) —

    true

以来

  • 2.0.0



55
56
57
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 55

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

#to_doc ⇒ Hash

このサーバー設定の定義を、MongoDB サーバーに送信するのに適した形式（つまり、 コマンドフィールドとして）に変換します。

次の値を返します。

  • （ハッシュ） —

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

以来

  • 2.0.0



72
73
74
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 72

デフォルト to_doc
  full_doc
end

#to_mongos ⇒ Hash | nil

このサーバー設定の定義を mongos に送信するのに適した値に変換します。

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

次の値を返します。

  • (ハッシュ | nil ) —

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

以来

  • 2.0.0



86
87
88
89
 
ファイル 'lib/mongo/server_selector/secondary_preferred.rb' 行 86

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