db.collection.getIndexes()

On this page

Definition

Behavior
Required Access
Output

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

Atlas Search Indexes

getIndexes() does not return information on Atlas Search indexes. For information on Atlas Search indexes, use $listSearchIndexes.

Client Disconnection

Starting in MongoDB 4.2, if the client that issued db.collection.getIndexes() disconnects before the operation completes, MongoDB marks db.collection.getIndexes() for termination using killOp.

Replica Set Member State Restriction

To run on a replica set member, listIndexes operations require the member to be in PRIMARY or SECONDARY state. If the member is in another state, such as STARTUP2, the operation errors.

Wildcard Indexes

Starting in MongoDB 6.3, 6.0.5, and 5.0.16, the wildcardProjection field stores the index projection in its submitted form. Earlier versions of the server may have stored the projection in a normalized form.

The server uses the index the same way, but you may notice a difference in the output of the listIndexes and db.collection.getIndexes() commands.

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().

Back

db.collection.findOneAndUpdate

db.collection.getShardDistribution