setIndexCommitQuorum（データベースコマンド）

setIndexCommitQuorum: setIndexCommitQuorumコマンドは、プライマリノードがインデックスをコミットする前に、ローカルインデックス構築をコミットするために準備しておく必要があるデータを保持するノードの最小数を設定します。

互換性

このコマンドは、次の環境でホストされている配置で使用できます。

MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

注意

This command is supported in all MongoDB Atlas clusters. For information on Atlas support for all commands, see Unsupported Commands.

MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン
MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

構文

このコマンドの構文は、次のとおりです。

db.runCommand(
   {
     setIndexCommitQuorum: <string>,
     indexNames: [ <document> ],
     commitQuorum: <int> | <string>,
     comment: <any>
   }
)

コマンドフィールド

このコマンドは、次のフィールドを使用します。

フィールド	タイプ	説明
setIndexCommitQuorum	`string`	インデックスが構築されるコレクションの名前。
インデックス名	`array`	変更する進行中のインデックスビルドの配列。配列の各要素は、インデックスの名前である必要があります。 `indexNames`に指定されるインデックスは、特定のインデックスビルダに関連付けられている進行中のビルドのセット全体である必要があります。つまり、単一の`createIndexes`または`db.collection.createIndexes()`操作によってビルドされたインデックスです。
commitQuorum	`int` or `string`	データを保持するレプリカセットノードの最小数（コミットクォーラム）で、プライマリが`indexes`を準備完了とマークする前に、インデックスビルドの成功を報告する必要があるもの（プライマリを含む）を指します。コミットクォーラムがデフォルトの `"votingMembers"` に設定されている場合は、中断されたインデックス構築の一部を再開できます。 commitQuorum を更新するには、ノードレプリカセットノードで`members[n].buildIndexes`を`true`に設定する必要があります。いずれの投票ノードでも`members[n].buildIndexes`が`false`に設定されている場合、デフォルトの`"votingMembers"`コミットクォーラムは使用できません。 `members[n].buildIndexes`を`true`に設定してすべてのノードを構成するか、別のコミットクォーラムを選択します。次の値をサポートします。 `"votingMembers"` - データを保持するすべての投票レプリカセットノード（デフォルト）。「投票」ノードとは、 `members[n].votes`が`0`より大きい任意のレプリカセットノードです。 `"majority"` - データを保持するレプリカセットノードの単純過半数。 `<int>` - データを保持する特定数のレプリカセットノード。 `0`より大きい整数を指定します。レプリカセットのタグ名。
`comment`	any	任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。 `attr.command.cursor.comment` フィールド内のmongod ログメッセージ。 `command.comment` フィールドのデータベースプロファイラー出力。 `command.comment` フィールドの`currentOp`出力。コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

動作

注意

FeatureCompatibilityVersion 4.4 以上が必要です。

レプリカセット全体でインデックス構築を同時に開始するには、レプリカセットまたはシャーディングされたクラスター内の各 mongod は、featureCompatibilityVersion を少なくとも 4.4 に設定する必要があります。

インデックス作成はマルチステージプロセスです。インデックス作成プロセスでは、セカンダリノードでのレプリケーションラグを最小限に抑えるためにcommit quorumが使用されます。

セカンダリノードがcommitIndexBuild oplog エントリを受信すると、そのノードはローカルインデックスのビルドがコミットされるまで、それ以上の oplog アプリケーションを停止します。インデックスビルドが完了までにかかる時間は秒から日までであるため、セカンダリノードのビルドがプライマリノードよりも遅い場合、レプリケーションラグが大きくなる可能性があります。

レプリケーションラグを管理するために、コミットクォーラムは、最小数のセカンダリもインデックスビルドをコミットする準備ができるまで、プライマリノードでのインデックスビルドのコミットを遅らせます。

コミットクォーラムは、コマンドの完了時にセカンダリのインデックスが使用可能になることを保証するものではありません。特定の数のセカンダリを使用可能にするには、適切な書込み保証 ( write concern) を設定します。

コミットクォーラムに含まれていないセカンダリノードがcommitIndexBuild oplog エントリを受信した場合、そのノードはインデックスのビルドが完了するまでレプリケーションをブロックする可能性があります。

Issuing setIndexCommitQuorum has no effect on index builds started with commitQuorum of 0.

重要

buildIndexesがfalseに設定されているレプリカセットノードはコミットクォーラムに含めることができません。

コミットクォーラムと書込み保証の対比

コミットクォーラムと書込み保証には重要な違いがあります。

インデックス構築にはコミットクォーラムを使用します。
書き込み操作には書込み保証が必要です。

クラスタ内の各データ保有ノードは投票ノードです。

コミットクォーラムは、プライマリを含むデータを保持する投票ノードの数、またはどの投票ノードがインデックス構築を同時にコミットする準備ができている必要があるかを指定し、その後プライマリがコミットを実行します。

書き込み保証 (write concern) とは、指定された数のインスタンスに書き込み (write) が伝わったことを確認するレベルです。

バージョン8.0での変更：

コミットクォーラムでは、プライマリがインデックス構築にコミットする前に、インデックス構築を完了する準備が整っていなければならないノードの数を指定します。対照的に、プライマリがインデックス構築にコミットした時に、書き込み保証によって、コマンドが正常に返されるまでにインデックス構築の oplog エントリを複製する必要があるノードの数が指定されます。

以前のリリースでは、プライマリがインデックス構築にコミットした時に、書き込み保証によって、コマンドが正常に返されるまでにインデックス構築を完了する必要があるノードの数が指定されていました。

例

レプリカセットまたはシャーディングされたクラスター上のインデックスは、データを保持するすべてのレプリカセットノードで同時に構築されます。シャーディングされたクラスターの場合、インデックス構築は、インデックスが作成されるコレクションのデータを含むシャードでのみ行われます。プライマリは、インデックスを使用可能とマークする前に、自身を含む最小限のデータを保持する voting ノード（コミットクォーラム）でインデックス構築を完了する必要があります。詳細については、「レプリケートされた環境でのインデックス構築」を参照してください。

次の操作では、2 つのインデックスのインデックスビルドを開始します。

db.getSiblingDB("examples").invoices.createIndexes(
  [
    { "invoices" : 1 },
    { "fulfillmentStatus" : 1 }
  ]
)

デフォルトでは、インデックスビルドでは"votingMembers"コミットクォーラム、またはすべてのデータを持つ投票レプリカセットメンバーが使用されます。次の操作を実行すると、インデックスビルドのコミットクォーラムが"majority"またはデータを保持する投票ノードの単純過半数に変更されます。

db.getSiblingDB("examples").runCommand(
  {
    "setIndexCommitQuorum" : "invoices",
    "indexNames" : ["invoices_1", "fullfillmentStatus_1"],
    "commitQuorum" : "majority"
  }
)

indexNamesに指定されるインデックスは、特定のインデックスビルダに関連付けられている進行中のビルドのセット全体である必要があります（つまりcreateIndexes()操作）。
indexNamesフィールドは、インデックスの名前を指定します。インデックスは明示的な名前なしで作成されたため、MongoDB はインデックスフィールドの名前とソート順序を連結してインデックス名を生成しました。

戻る

setFeatureCompatibilityVersion

setParameter