db.コレクション.createIndexes()（mongoshメソッド）

keyPatterns

ドキュメント

インデックス仕様ドキュメントを含む配列。各ドキュメントには、フィールドと値のペアが含まれています。フィールドはインデックスキーで、値はそのフィールドのインデックスのタイプを表します。フィールドの昇順インデックスの場合は 1 の値を指定し、降順インデックスの場合は -1 の値を指定します。.. include:: /includes/indexes/wildcard-use-wc-methods.rst

options

ドキュメント

Optional. A document that contains a set of options that controls the creation of the indexes. See Options for details.

commitQuorum

整数または文字列

任意。データを保持する投票レプリカセット ノードの最小数（コミットクォーラム）で、プライマリが indexes を準備完了とマークする前に、インデックス構築の成功を報告する必要があるもの（プライマリを含む）を指します。「投票」ノードとは、members[n].votes が 0 より大きい任意のレプリカセット ノードです。

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

• "votingMembers" - データを保持するすべての投票レプリカセット ノード（デフォルト）。

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

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

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

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

collation

ドキュメント

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

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

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

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

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

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

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

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

weights

ドキュメント

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

MongoDB 5.0 以降、重みオプションはテキスト インデックスにのみ使用できます。

default_language

string

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

language_override

string

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

textIndexVersion

integer

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

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

2dsphereIndexVersion

integer

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

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

bits

integer

任意。2d インデックスの場合、保存された位置データのジオハッシュ値の精度の数。

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

min

数値

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

max

数値

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

wildcardProjection

ドキュメント

任意。特定のフィールドパスを ワイルドカード インデックス に含めたり除外したりできるようにします。

このオプションは、すべてのドキュメント フィールドにワイルドカード インデックスを作成する場合にのみ有効です。特定のフィールド パスとそのサブフィールドにワイルドカード インデックスを作成する場合には、wildcardProjection オプションは指定できません。

wildcardProjection 次のような仕様で動作します。

{ "$**": 1 }
{ "userID":, "$**": 1 }

ただし、ワイルドカード フィールドと通常の（ワイルドカード以外の）フィールドに同じフィールドを含むインデックスを定義することはできません。 インデックスを正しく定義するには、wildcardProjection を使用して重複するフィールドをワイルドカード パターンから除外します。

wildcardProjection は次のような仕様では動作しません。

 ``{ "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 フィールドを含めることもできます。これは、このルールの唯一の例外です。

Options specified to db.collection.createIndexes() apply to all of the index specifications included in the key pattern array. Specify wildcardProjection only if you are creating a single wildcard index using db.collection.createIndexes().