createIndexes

string

インデックスを作成するコレクション。

配列

作成するインデックスを指定します。 配列内の各ドキュメントは、個別のインデックスを指定します。

ドキュメント

任意。書込み保証（write concern）を表現するドキュメント。デフォルトの書込み保証を使用する場合は省略します。

整数または文字列

任意。 データを保持するレプリカセット ノードの最小数（ コミットクォーラム）で、プライマリがindexesを準備完了とマークする前に、インデックス ビルドの成功を報告する必要があるもの（プライマリを含む）を指します。

MongoDB v5.0 以降では、 から commit quorum is setのときに 中断されたインデックスビルドを"votingMembers" 一部再開できます。

コミットクォーラム内のレプリカセット ノードでは、 members[n].buildIndexesがtrueに設定されている必要があります。 いずれの投票ノードでもmembers[n].buildIndexesがfalseに設定されている場合、デフォルトの"votingMembers"コミットクォーラムは使用できません。 members[n].buildIndexesをtrueに設定してすべてのノードを構成するか、別のコミットクォーラムを選択します。

次の値をサポートします。

• "votingMembers" - データを保持するすべての投票レプリカセット ノード（デフォルト）。 「投票」ノードとは、 members[n].votesが0より大きい任意のレプリカセット ノードです。

• "majority" - データを保持するレプリカセット ノードの単純過半数。

• <int> - データを保持する特定数のレプリカセット ノード。

• 0 - クォーラム投票の動作を無効にします。ノードはインデックス構築を同時に開始しますが、インデックス構築を完了する前にクォーラムの投票や待機は行いません。0 のコミットクォーラムでインデックス構築を開始した場合、後で setIndexCommitQuorum を使用してコミットクォーラムを変更することはできません。

• レプリカセットのタグ名。

any

任意。このコマンドに添付するユーザー指定のコメント。設定すると、このコメントは以下の場所にこのコマンドの記録と合わせて表示されます。

• attr.command.cursor.comment フィールド内のmongod ログ メッセージ。

• command.comment フィールドのデータベースプロファイラー出力。

• command.comment フィールドのcurrentOp出力。

コメントには、有効な BSON 型（string, integer, object, array など）を使用できます。

ドキュメント

インデックスのフィールドを指定します。 各フィールドに対して、キーとインデックスを作成するフィールドの名前で、値がインデックス方向またはインデックスタイプのいずれかであるキーと値のペアを指定します。 方向を指定する場合は、昇順の場合は1を指定し、降順の場合は-1を指定します。

MongoDB は、次のような多彩なインデックス タイプをサポートしています。

• text

• 地理空間

• ハッシュされたインデックス

詳細については、「インデックス タイプ」を参照してください。

ワイルドカード インデックスは、ユーザーがカスタム フィールドまたはコレクション内の多種多様なフィールドに対してクエリを実行するワークロードをサポートします。

• ワイルドカード インデックスは、特定のフィールドとそのサブパス、またはドキュメント内のすべてのフィールドで作成できます。

  詳しくは、「ワイルドカード インデックス」を参照してください。

string

インデックスを一意に識別する名前。

ブール値

任意。インデックス キーの値がインデックスの既存値と一致するドキュメントの挿入または更新をコレクションが受け入れないように、ユニークインデックスを作成します。

ユニークインデックスを作成するには、true を指定します。デフォルト値は false です。

このオプションはハッシュされたインデックスには使用できません。

ドキュメント

任意。指定すると、インデックスはフィルター式に一致するドキュメントのみを参照します。詳細については、「部分インデックス」を参照してください。

フィルター式には、次の要素を含めることができます。

• 等式（field: value または $eq 演算子を使用するなど）

• $exists: true 式

• $gt, $gte, $lt, $lte expressions,

• $type 式

• $and 演算子

• $or 演算子

• $in 演算子

クライアント側フィールドレベル暗号化またはQueryable Encryptionを使用している場合、 partialFilterExpressionは暗号化されたフィールドを参照できません。

MongoDB ではすべてのインデックス タイプで partialFilterExpression オプションを指定できます。

ブール値

任意。true の場合、インデックスは指定されたフィールドを持つドキュメントのみを参照します。これらのインデックスの使用スペースは小さくなりますが、いくつかの状況（特にソート）で異なる動作をします。デフォルト値は false です。詳細については、「スパースインデックス」を参照してください。

次のインデックス タイプはデフォルトでスパースであり、このオプションを無視します。

• 2dsphere

• 2d

• Text

2dsphere インデックスキーを含む複合インデックスで、他の種類のキーも含まれている場合、インデックスがドキュメントを参照するかどうかは 2dsphere 個のインデックス フィールドによってのみ決定されます。

MongoDB には、部分インデックスを作成するオプションが用意されています。 これらは スパース インデックス の機能のスーパーセットを提供し、代わりに優先されます。

integer

任意。MongoDB がこのコレクション内のドキュメントを保持する期間を制御するための有効期間（TTL）の値を秒単位で指定します。このオプションは TTL インデックスにのみ適用されます。詳細については、「TTL によるコレクションのデータ期限設定」を参照してください。

MongoDB 5.0 より前のバージョンで作成された TTL インデックスを使用する場合、または MongDB 5.0 で作成されたデータを 5.0 より前のインストールと同期する場合は、「NaN を使用して構成されたインデックス」を参照して誤った構成の問題を回避してください。

TTLインデックスの expireAfterSeconds 値は、0 から 2147483647 の範囲内（両端を含む）である必要があります。

ブール値

任意。 インデックスがクエリ プランナーから非表示かどうかを決定するブール値。 非表示インデックスは、クエリプラン選択手順の一部として評価されません。

デフォルトは、false に設定されています。

ドキュメント

任意。インデックス作成時に、インデックス単位でストレージエンジンを構成できるようにします。

storageEngine オプションは次のような形式をとります。

storageEngine: { <storage-engine-name>: <options> }

インデックスの作成時に指定されたストレージエンジン構成オプションは、異なるストレージエンジンを使用するノードのあるレプリカセットをサポートするために、レプリケーション中に検証され、oplog に記録されます。

ドキュメント

任意。 テキストインデックスの場合、フィールドと重みを含むドキュメントが組み合わされます。 重みは1から99までの整数で、 999はスコアに関して他のインデックス付きフィールドと比較したフィールドの重要性を示します。 重みはインデックス フィールドの一部またはすべてに指定できます。 スコアを調整するには、「自己管理型配置のテキスト検索結果への重みの割り当て」を参照してください。 デフォルト値は1です。

string

任意。 テキストインデックスで、ストップワードのリストとステマーとトークナイザのルールを決定する言語。 使用可能な言語については「 自己管理型配置のテキスト検索言語」を、詳細と例については「 自己管理型配置のテキストインデックスのデフォルト言語の指定」を参照してください。 デフォルト値はenglishです。

string

任意。 テキストインデックスの場合、ドキュメントの上書き言語を含む、コレクション内のドキュメントのフィールド名です。 デフォルト値はlanguageです。 例については、「自己管理型配置のテキストインデックスのデフォルト言語の指定」を参照してください。

integer

任意。text インデックスのバージョン番号。ユーザーはこのオプションを使用してデフォルトのバージョン番号を上書きできます。

使用可能なバージョンについては、「自己管理型配置のテキストインデックス バージョン 」を参照してください。

integer

任意。2dsphere インデックスのバージョン番号。ユーザーはこのオプションを使用してデフォルトのバージョン番号を上書きできます。

使用可能なバージョンについては、「2dsphere インデックス」を参照してください。

integer

任意。2d インデックスで、ロケーション データの保存されたジオハッシュ値の精度数。

bits 値の範囲は 1 から 32 まで（32 を含む）です。デフォルト値は 26 です。

数値

任意。 2dインデックスで、経度と緯度の境界（下限を含む）。 デフォルト値は-180.0です。

数値

任意。 2dインデックスで、経度と緯度の値の境界（上限を含む） デフォルト値は180.0です。

ドキュメント

任意。インデックスの照合を指定します。

照合を指定すると、大文字・小文字やアクセント記号など、文字列を比較するための言語独自のルールを指定できます。

コレクション レベルで照合を指定した場合、次のようになります。

• インデックスの作成時に照合を指定しない場合、MongoDB はコレクションのデフォルトの照合でインデックスを作成します。

• インデックスの作成時に照合を指定する場合、MongoDB は指定された照合でインデックスを作成します。

照合オプションの構文は次のとおりです。

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
}

照合を指定する場合、locale フィールドは必須ですが、その他の照合フィールドはすべて任意です。フィールドの説明については、照合ドキュメントを参照してください。

ドキュメント

任意。

ユーザーが{ "$**" : 1}キー パターンを使用して、ワイルドカード インデックスに特定のフィールドパスを含めたり、 ワイルドカード インデックスから特定のフィールドパスを除外したりできます。 このオプションは、すべてのドキュメント フィールドにワイルドカード インデックスを作成する場合にのみ有効です。 特定のフィールドパスとそのサブフィールドにワイルドカード インデックスを作成する場合は、このオプションは指定できません。例: { "path.to.field.$**" : 1 }

wildcardProjection オプションは次のような形式をとります。

wildcardProjection: {
  "path.to.field.a" : <value>,
  "path.to.field.b" : <value>
}

<value> は次のいずれかになります。

• 1 または true の場合は、ワイルドカード インデックスにフィールドが追加されます。

• 0 または false の場合は、ワイルドカード インデックスからフィールドが除外されます。

ワイルドカード インデックスでは、デフォルトで _id フィールドが省略されます。_id フィールドをワイルドカード インデックスに含めるには、wildcardProjection ドキュメントに明示的に含める必要があります。

{
  "wildcardProjection" : {
    "_id" : 1,
    "<field>" : 0|1
  }
}

wildcardProjection ドキュメント内のすべてのステートメントは、包含ステートメントまたは除外ステートメントのいずれかである必要があります。除外ステートメントに _id フィールドを含めることもできます。これは、このルールの唯一の例外です。