db.collection.getIndexes()

定義

db.collection.getIndexes()

重要

mongosh メソッド

このページでは、mongosh メソッドについて説明します。ただし、データベースコマンドや Node.js などの言語固有のドライバーのドキュメントには該当しません。

データベースコマンドについては、 listIndexesコマンドを参照してください。

MongoDB API ドライバーについては、各言語の MongoDB ドライバー ドキュメントを参照してください。

コレクションの既存のインデックス（隠しインデックスを含む）を識別して説明するドキュメントのリストを含む配列を返します。

コレクションでdb.collection.getIndexes()を呼び出す必要があります。 例:

db.collection.getIndexes()

collection を、インデックス情報を返すコレクションの名前に変更します。

動作

必要なアクセス権

アクセス制御の強制時に db.collection.getIndexes() を実行するには、コレクションで listIndexes 特権の所有者である必要があります。

組み込みロールreadには、データベース内のコレクションに対してdb.collection.getIndexes()を実行するために必要な特権が付与されます。

出力

db.collection.getIndexes() コレクションのインデックス情報を保持するドキュメントの配列を返します。以下に例を挙げます。

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "status" : 1
      },
      "name" : "status_1"
   },
   {
      "v" : 2,
      "key" : {
         "points" : 1
      },
      "name" : "points_1"
   }
]

インデックス情報には、インデックスの作成に使用されるキーとオプションが含まれます。 インデックス オプションhiddenは、値がtrueの場合にのみ使用できます。

キーとインデックスのオプションの詳細については、db.collection.createIndex() を参照してください。