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

定義

db.collection.getIndexes()

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

You must call db.collection.getIndexes() on a collection. For example:

db.collection.getIndexes()

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

互換性

このメソッドは、次の環境でホストされている配置で使用できます。

• MongoDB Atlas: The fully managed service for MongoDB deployments in the cloud

• MongoDB Enterprise: サブスクリプションベースの自己管理型 MongoDB バージョン

• MongoDB Community: ソースが利用可能で、無料で使用できる自己管理型の MongoDB のバージョン

動作

必要なアクセス権

To run db.collection.getIndexes() when access control is enforced, users must have privileges to listIndexes on the collection.

The built-in role read provides the required privileges to run db.collection.getIndexes() for the collections in a database.

出力

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() を参照してください。