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

ドキュメント

フィールドと値のペアを含むドキュメント。フィールドはインデックス キーで、値はそのフィールドのインデックスのタイプを表します。

フィールドに昇順インデックスを作成する場合、1 の値を指定します。降順インデックスを作成する場合は、-1 の値を指定します。

アスタリスク（*）は有効なインデックス名ではありません。

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

• text

• 地理空間

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

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

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

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

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

ドキュメント

任意。 インデックスの作成を制御する一連のオプションを含むドキュメント。 詳細については、「 オプション 」を参照してください。

整数または文字列

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

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

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

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

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

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

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

ドキュメント

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

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

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

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

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

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

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

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

ドキュメント

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

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

string

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

string

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

integer

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

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

integer

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

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

integer

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

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

数値

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

数値

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

ドキュメント

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

このオプションは、すべてのドキュメント フィールドにワイルドカード インデックスを作成する場合にのみ有効です。特定のフィールドパスとそのサブフィールドにワイルドカード インデックスを作成する場合には、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 の場合は、ワイルドカード インデックスからフィールドが除外されます。