cursor.readPref()

項目一覧

定義

定義

cursor.readPref(mode, tagSet, hedgeOptions)

重要

mongosh メソッド

これは mongoshメソッドです。これは、 Node.jsまたはその他のプログラミング言語固有のドライバーメソッドのドキュメントではありません。

ほとんどの場合、 mongoshメソッドはレガシーの mongo shell メソッドと同じように動作します。ただし、一部のレガシーメソッドはmongoshでは利用できません。

レガシーmongo shell のドキュメントについては、対応する MongoDB Server リリースのドキュメントを参照してください。

MongoDB API ドライバーについては、各言語のMongoDB ドライバードキュメントを参照してください。

カーソルにreadPref()を追加して、クライアントがレプリカセットのノードにクエリをルーティングする方法を制御します。

注意

データベースからドキュメントを取得する前に、カーソルにreadPref()を適用する必要があります。

パラメーター

Parameter	タイプ	説明
モード	string	次の読み取り設定モードのいずれか: `primary`、`primaryPreferred`、`secondary`、`secondaryPreferred`、または `nearest`
tagSet	ドキュメントの配列	任意。指定されたタグを持つメンバーへの読み取りをターゲットにするために使用されるタグセット。 `tagSet`は使用できません`primary` 詳しくは、「読み込み設定（read preference）のタグセットリスト」を参照してください。
hedgeOptions	ドキュメント	任意。ヘッジの使用を有効にするかどうかを指定するドキュメント。 `{ enabled: <boolean> }` `enabled` フィールドのデフォルトは true です。つまり、空のドキュメント `{ }` を指定することは `{ enabled: true }` を指定することと同じです。ヘッジされた読み取りはシャーディングされたクラスターで利用できます。ヘッジされた読み取りを使用するには、 `mongos`にヘッジされた読み取り用の`enabled support` （デフォルト）と、 `primary`以外の読み込み設定（ read preference ）がヘッジされた読み取りの使用を有効にする必要があります。読み込み設定（read preference）`nearest` により、シャーディングされたクラスターでのヘッジ読み取りの使用がデフォルトで有効になります。つまり、デフォルトでは `{ enabled: true }` になります。

readPref()は、読み込み設定（read preference）の読み込み設定（read preference maxStalenessSecondsオプションをサポートしていません。

例

読み込み設定（read preference）モードを指定する

次の操作では、読み込み設定（read preference）モードを使用して、セカンダリメンバーへの読み取りをターゲットにします。

db.collection.find({ }).readPref( "secondary")

読み込み設定（read preference）のタグセットを指定する

特定のタグを持つセカンダリを対象とするには、モードとtagsSet配列の両方を含めます。

db.collection.find({ }).readPref(
   "secondary",
   [
      { "datacenter": "B" },    // First, try matching by the datacenter tag
      { "region": "West"},      // If not found, then try matching by the region tag
      { }                       // If not found, then use the empty document to match all eligible members
   ]
)

セカンダリ選択プロセス中に、MongoDB は最初に datacenter: "B" タグを持つセカンダリノードを検索しようとします。

見つかった場合、MongoDB は適格なセカンダリを datacenter: "B" タグを持つものに制限し、残りのタグを無視します。
何も見つからない場合、MongoDB は "region": "West" タグを持つセカンダリノードを検索しようとします。
- 見つかった場合、MongoDB は適格なセカンダリを "region": "West" タグのあるものに制限します。
- 何も見つからない場合、MongoDB は適格なセカンダリを使用します。

詳しくは、「タグの一致順序」を参照してください。

Tip

以下も参照してください。

レプリカセットタグセットの構成

ヘッジされた読み取りを指定する

シャーディングされたクラスターの場合、非プライマリ読み込み設定（ read preference ）でヘッジされた読み取りを有効にできます。ヘッジされた読み取りを使用するには、 mongosにヘッジされた読み取り用のenabled support （デフォルト）と、 primary以外の読み込み設定（ read preference ）でヘッジされた読み取りの使用が有効になっている必要があります。

ヘッジされた読み取りを使用してシャーディングされたクラスター上のセカンダリを対象とするには、次の例のようにモードとhedgeOptionsの両方を含めます。

タグセットなし
```
db.collection.find({ }).readPref(
   "secondary",            // mode
   null,                   // tag set
   { enabled: true }       // hedge options
)
```
タグセットあり
```
db.collection.find({ }).readPref(
   "secondary",                      // mode
   [ { "datacenter": "B" },  { } ],  // tag set
   { enabled: true }                 // hedge options
)
```

戻る

cursor.readConcern

cursor.returnKey