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

照合とインデックスの使用

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

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

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

同じキーに対して、異なる照合を持つ複数のインデックスを作成できます。同じキー パターンで照合が異なるインデックスを作成するには、ユニークインデックス名を設定する必要があります。

string の比較にインデックスを使用するには、操作で同じ照合も指定する必要があります。操作でインデックスと異なる照合が指定されている場合、インデックスはインデックス フィールドで string の比較をサポートできません。

次のコードを使用して、sample_mflixデータベースの moviesコレクションに、string 比較用の照合ロケール"fr" を持つインデックスを作成します。

db.movies.createIndex( { title: 1 }, { collation: { locale: "fr" } } )

インデックスと同じ照合を指定する次のクエリでは、インデックスを使用できます。

db.movies.find( 
    { title: "Les Misèrables" },
    { title: 1, year: 1 }
).collation( { locale: "fr" } )

ただし、デフォルトで「シンプル」なバイナリー コレータを使用する次の クエリ操作、インデックスを使用できず、COLLSCAN が必要です。

db.movies.find( { title: "Les Misèrables" }, { title: 1 , year: 1 } )

インデックス プレフィックスキーが文字列、配列、および埋め込みドキュメントではない複合インデックスの場合でも、異なる照合を指定する操作では、インデックスを使用してインデックス プレフィックスキーの比較をサポートできます。

例、次のコードを使用して、sample_mflixデータベースの moviesコレクションに数値フィールド year と metacritic と stringフィールドtitle を指定する複合インデックスを作成できます。このインデックスでは、string 比較用の照合ロケール"fr" も指定します。

db.movies.createIndex(
    { year: 1, metacritic: 1, title: 1 },
    { collation: { locale: "fr" } }
)

文字列の比較に "simple" バイナリ照合を使用する次の操作では、インデックスを使用できます。

db.movies.find( 
    { year: 2012 }, 
    { title: 1, year: 1, metacritic: 1 } 
).sort( { title: 1 } )

db.movies.find( 
    { year: 2012, metacritic: { $gt: Decimal128( "50" ) } },
    { title: 1, year: 1, metacritic: 1 }
).sort( { title: 1 } )

次の操作では、"simple" バイナリ照合を使用してインデックス付きの title フィールドで文字列を比較しますが、クエリの year: 2012 部分の実行についてはインデックスが使用できます。

db.movies.find( { year: 2012, title: "Les Misèrables" }, { year: 1, title: 1 } )

インデックスでインデックス が使用されているかどうかを確認するには、 explain() オプションを指定してクエリを実行します。

照合非対応および非表示オプション

照合オプションは除き、1 つのインデックスオプションセットを使用してインデックスを作成し、その後別のインデックスオプションを使用して同じインデックスを再作成しようとすると、MongoDB はオプションを変更せず、インデックスを再作成しません。

非表示オプションはインデックスを削除して再度作成することなく変更できます。詳細は、「非表示オプション」を参照してください。

その他のインデックス オプションを変更するには、新しいオプションで を実行する前に、db.collection.dropIndex() db.collection.createIndex()で既存のインデックスを削除します。

照合オプション

同じキーに対して、異なる照合を持つ複数のインデックスを作成できます。同じキー パターンで照合が異なるインデックスを作成するには、ユニークインデックス名を設定する必要があります。

非表示オプション

既存のインデックスを非表示または再表示するには、次のmongoshメソッドを使用できます。

• db.collection.hideIndex()

• db.collection.unhideIndex()

たとえば、

• インデックスの hidden オプションを true に変更するには、db.collection.hideIndex() メソッドを使用します。

  db.movies.hideIndex( { title: 1 } )

• インデックスの hidden オプションを false に変更するには、db.collection.unhideIndex() メソッドを使用します。

  db.movies.unhideIndex( { title: 1 } )

単一フィールドパスでのワイルドカード インデックスの作成

次の操作を実行すると、awards フィールドでワイルドカード インデックスが作成されます。

db.movies.createIndex( { "awards.$**": 1 } )

このワイルドカードを使用すると、 MongoDB はawards のすべてのスカラー値をインデックス化します。フィールドがネストされたドキュメントまたは配列の場合、ワイルドカードはドキュメントまたは配列に再帰し、ドキュメントまたは配列内のすべてのスカラー フィールドにインデックスを作成します。

ワイルドカード インデックスは、awards またはそのネストされたフィールドに対する任意の単一フィールド クエリをサポート可能です。

db.movies.find( { "awards.wins": { $gt: 1 } }, { title: 1 } )

db.movies.find( { "awards.nominations": { $gt: 5 } }, { title: 1 } )

すべてのフィールドパスでのワイルドカード インデックスの作成

次の操作を実行すると、すべてのスカラー フィールド（_id フィールドを除く）にワイルドカード インデックスが作成されます。

db.movies.createIndex( { "$**": 1 } )

このワイルドカード を使用すると、 MongoDB はコレクション内の核ドキュメントのすべてのスカラー フィールドにインデックスを作成します。特定のフィールドがネストされたドキュメントまたは配列の場合、ワイルドカードはドキュメントまたは配列に再帰し、ドキュメントまたは配列内のすべてのスカラー フィールドにインデックスを作成します。

作成されたインデックスは、コレクションのドキュメント内の任意のフィールドに対するクエリをサポートできます。

db.movies.find( { runtime: { $gt: 300 } }, { title: 1 } )

db.movies.find( { "awards.nominations": { $gt: 5 } }, { title: 1 } )

ワイルドカード インデックス カバレッジへの特定フィールドの含有

次の操作ではワイルドカード インデックスを作成し、wildcardProjection オプションを使用して tomatoes.viewer および tomatoes.critic フィールドのスカラー値のみをインデックスに含めます。

db.movies.createIndex( 
    { "$**": 1 },
    {
      "wildcardProjection": {
          "tomatoes.viewer": 1,
          "tomatoes.critic": 1
      }
    }
)

パターン "$**" にはドキュメント内のすべてのフィールドが含まれます。指定したフィールドでインデックスを制限するには、wildcardProjection フィールドを使用します。wildcardProjection の完全なドキュメントについては、「wildcard インデックスのオプション」を参照してください。

フィールドがネストされたドキュメントまたは配列の場合、ワイルドカード インデックスはそのフィールドを再帰処理して、ドキュメントまたは配列内のすべてのスカラー フィールドにインデックスを作成します。

ワイルドカード インデックスは、wildcardProjection に含まれる任意のスカラーフィールドに対するクエリをサポートします。

db.movies.find( { "tomatoes.viewer.rating": { $gt: 4 } }, { title: 1 } )

ワイルドカード インデックス カバレッジからの特定フィールドの除外

この例では、ワイルドカード インデックスと wildcardProjection ドキュメントを使用して、コレクション内の各ドキュメントのスカラー フィールドにインデックスを作成します。

ワイルドカード インデックスでは、tomatoes.viewer フィールドと tomatoes.critic フィールドは除外されます。

db.movies.createIndex( 
    { "$**": 1 },
    {
      "wildcardProjection": {
          "tomatoes.viewer": 0,
          "tomatoes.critic": 0
      }
    }
)

ワイルドカード パターン "$**" にはドキュメント内のすべてのフィールドが含まれます。ただし、wildcardProjection フィールドは指定されたフィールドをインデックスから除外します。

wildcardProjection の完全なドキュメントについては、「wildcard インデックスのオプション」を参照してください。

フィールドがネストされたドキュメントまたは配列の場合、ワイルドカードはドキュメントまたは配列に再帰し、ドキュメントまたは配列内のすべてのスカラー フィールドにインデックスを作成します。

インデックスは、wildcardProjection によって除外されるものを除くすべてのスカラー フィールドに対するクエリをサポートできます。

db.movies.find( { "tomatoes.viewer.rating": { $gt: 3 } }, { title: 1 } )