インデックスの管理

既存のインデックスを表示

MongoDB Shell

Compass

次のセクションでは、コレクションまたはデータベース全体の既存のインデックスを表示する方法について説明します。

コレクションのすべてのインデックスの一覧表示

コレクションのすべてのインデックスのリストを返すには、db.collection.getIndexes() メソッドまたは、ドライバーの同様のメソッドを使用します。

例えば、 peopleコレクションのすべてのインデックスを表示するには、次のコマンドを実行します。

db.people.getIndexes()

データベースのすべてのインデックスの一覧表示

データベース内のすべてのコレクション インデックスを一覧表示するには、 mongoshで次のコマンドを実行します。

db.getCollectionNames().forEach(function(collection) {
    indexes = db[collection].getIndexes();
    print("Indexes for " + collection + ":");
    printjson(indexes);
});

特定の種類のインデックスの一覧表示

すべてのデータベース内のすべてのコレクションの特定のタイプ（ハッシュやテキストなど）のすべてのインデックスを一覧表示するには、 mongoshで次のコマンドを実行します。

// The following finds all hashed indexes
db.adminCommand("listDatabases").databases.forEach(function(d){
    let mdb = db.getSiblingDB(d.name);
    mdb.getCollectionInfos({ type: "collection" }).forEach(function(c){
      let currentCollection = mdb.getCollection(c.name);
      currentCollection.getIndexes().forEach(function(idx){
        let idxValues = Object.values(Object.assign({}, idx.key));
        if (idxValues.includes("hashed")) {
          print("Hashed index: " + idx.name + " on " + d.name + "." + c.name);
          printjson(idx);
        };
      });
    });
});

MongoDB Compass のコレクションにあるすべてのインデックスのリストを表示するには、左側のペインで対象のコレクションをクリックし、 Indexesタブを選択します。

このタブに表示される情報の詳細については、 Compass のドキュメント を参照してください。

インデックスを削除する

既存のインデックスを削除する方法については、「インデックスの削除」を参照してください。

MongoDB Compass でインデックスを削除する方法については、「 Compass でのインデックスの管理 」を参照してください。

インデックスを変更する

db.siteAnalytics.createIndex( { "url": 1 } )

url_1

db.siteAnalytics.createIndex( { "url": 1, "dummyField": 1 } )

url_1_dummyField_1

db.siteAnalytics.dropIndex( { "url_1" } )

{ nIndexesWas: 3, ok: 1 }

db.siteAnalytics.createIndex( { "url": 1 }, { "unique": true } )

url_1

db.siteAnalytics.dropIndex( { "url_1_dummyField_1" } )

{ nIndexesWas: 3, ok: 1 }

db.siteAnalytics.getIndexes()

[
  { v: 2, key: { _id: 1 }, name: '_id_' },
  { v: 2, key: { url: 1 }, name: 'url_1', unique: true }
]

シャード間で一貫性のないインデックスを見つける

コレクションのチャンクを含む各シャードにまったく同じインデックス（インデックスオプションを含む）がない場合、シャーディングされたコレクションのインデックスには一貫性がありません。通常の操作では一貫性のないインデックスは発生しないはずですが、次のような一貫性のないインデックスが発生する可能性があります。

• ユーザーが unique キー制約を使用してインデックスを作成していて、1 つのシャードに重複ドキュメントを含むチャンクが含まれている場合。このような場合、インデックスの作成操作は、重複のないシャードでは成功するものの、重複のあるシャードでは成功しない可能性があります。

• ユーザーが複数のシャードにわたってインデックスをローリング処理で作成している（複数のシャードにわたって手作業でインデックスを 1 つずつ構築している）時、関連付けられたシャードのインデックス作成に失敗した場合、または異なる仕様で誤ったインデックスを構築した場合。

コンフィギュレーションサーバーのプライマリにより、デフォルトでは、シャーディングされたコレクションのシャード間でのインデックスの不整合がチェックされます。コマンドserverStatusがコンフィギュレーションサーバーのプライマリで実行されると、フィールドshardedIndexConsistencyが返され、インデックスの不整合があるシャーディングされたコレクションの数を報告します。

shardedIndexConsistency でインデックスの不一致が報告された場合は、矛盾が見つかるまで、シャーディングされたコレクションに対して次のパイプラインを実行できます。

1. 以下の集計パイプラインを定義する。

   const pipeline = [
       // Get indexes and the shards that they belong to.
       {$indexStats: {}},
       // Attach a list of all shards which reported indexes to each document from $indexStats.
       {$group: {_id: null, indexDoc: {$push: "$$ROOT"}, allShards: {$addToSet: "$shard"}}},
       // Unwind the generated array back into an array of index documents.
       {$unwind: "$indexDoc"},
       // Group by index name.
       {
           $group: {
               "_id": "$indexDoc.name",
               "shards": {$push: "$indexDoc.shard"},
               // Convert each index specification into an array of its properties
               // that can be compared using set operators.
               "specs": {$push: {$objectToArray: {$ifNull: ["$indexDoc.spec", {}]}}},
               "allShards": {$first: "$allShards"}
           }
       },
       // Compute which indexes are not present on all targeted shards and
       // which index specification properties aren't the same across all shards.
       {
           $project: {
               missingFromShards: {$setDifference: ["$allShards", "$shards"]},
               inconsistentProperties: {
                    $setDifference: [
                        {$reduce: {
                            input: "$specs",
                            initialValue: {$arrayElemAt: ["$specs", 0]},
                            in: {$setUnion: ["$$value", "$$this"]}}},
                        {$reduce: {
                            input: "$specs",
                            initialValue: {$arrayElemAt: ["$specs", 0]},
                            in: {$setIntersection: ["$$value", "$$this"]}}}
                    ]
                }
           }
       },
       // Only return output that indicates an index was inconsistent, i.e. either a shard was missing
       // an index or a property on at least one shard was not the same on all others.
       {
           $match: {
               $expr:
                   {$or: [
                       {$gt: [{$size: "$missingFromShards"}, 0]},
                       {$gt: [{$size: "$inconsistentProperties"}, 0]},
                   ]
               }
           }
       },
       // Output relevant fields.
       {$project: {_id: 0, indexName: "$$ROOT._id", inconsistentProperties: 1, missingFromShards: 1}}
   ];

2. シャーディングされたコレクションの集計パイプラインを実行してテストします。たとえば、シャーディングされたコレクション test.reviews の関連するシャード全体でインデックスが一貫していないかどうかをテストするには次のようにします。

   db.getSiblingDB("test").reviews.aggregate(pipeline)

   コレクションに一貫性のないインデックスがある場合、そのコレクションの集計は、一貫性のないインデックスに関する詳細を返します。

   { "missingFromShards" : [ "shardB" ], "inconsistentProperties" : [ ], "indexName" : "page_1_score_1" }
   { "missingFromShards" : [ ], "inconsistentProperties" : [ { "k" : "expireAfterSeconds", "v" : 60 }, { "k" : "expireAfterSeconds", "v" : 600 } ], "indexName" : "reviewDt_1" }

   返されたドキュメントは、シャーディングされたコレクションtest.reviewsに 2つの不整合があることを示しています。

   1. page_1_score_1 という名前のインデックスが shardBのコレクションにありません。

   2. reviewDt_1 という名前のインデックスには、コレクションのシャード間で一貫性のないプロパティがあります。特に expireAfterSeconds プロパティが異なります。

特定のシャードのコレクションからインデックスが欠落しているという不整合を解決するには、

次のいずれかを実行できます。

• 影響を受けたシャードでコレクションのローリングインデックス構築を実行します。

  -あるいは-

• インデックス構築db.collection.createIndex()をインスタンスから mongos発行します。この操作では、インデックスがないシャードにのみコレクションのインデックスが構築されます。

シャード間でインデックス プロパティが異なる箇所を解決するには、

影響を受けるシャード上のコレクションから誤ったインデックスを削除し、インデックスを再構築します。インデックスを再構築するには、次のいずれかを実行します。

• 影響を受けたシャードでコレクションのローリングインデックス構築を実行します。

  -あるいは-

• インデックス構築db.collection.createIndex()をインスタンスから mongos発行します。この操作では、インデックスがないシャードにのみコレクションのインデックスが構築されます。

あるいは、expireAfterSeconds プロパティに不整合がある場合は、インデックスを削除して再構築する代わりに collMod コマンドを実行して秒数をアップデートすることもできます。