db.collection.getIndexes()

Definition

db.collection.getIndexes()

Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.

For the database command, see the listIndexes command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

Returns an array that holds a list of documents that identify and describe the existing indexes on the collection, including hidden indexes.

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

db.collection.getIndexes()

Change collection to the name of the collection for which to return index information.

Behavior

Required Access

To run db.collection.getIndexes() when access control is enforced, usesrs 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.

Output

db.collection.getIndexes() returns an array of documents that hold index information for the collection. For example:

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

Index information includes the keys and options used to create the index. The index option hidden is only available if the value is true.

For information on the keys and index options, see db.collection.createIndex().