Navigation
This is an upcoming (i.e. in progress) version of the manual.

listIndexes

Definition

listIndexes

Returns information about the indexes on the specified collection. Specifically, the command returns a document that contains information with which to create a cursor to the index information. Index information includes the keys and options used to create the index. The mongo shell provides the db.collection.getIndexes() helper.

The command has the following form:

{ "listIndexes": "<collection-name>" }
Field Type Description
listIndexes string The name of the collection.

Required Access

To run listIndexes when access control is enforced, users must have privileges to listIndexes. The built-in role read provides the required privileges to run listIndexes for the collections in a database.

Behavior

Client Disconnection

Starting in MongoDB 4.2, if the client that issued the listIndexes disconnects before the operation completes, MongoDB marks the listIndexes for termination (i.e. killOp on the operation).

Output

listIndexes.cursor

A document that contains information with which to create a cursor to index information. The cursor information includes the cursor id, the full namespace for the command, as well as the first batch of results. Index information includes the keys and options used to create the index. For information on the keys and index options, see db.collection.createIndex().

listIndexes.ok

The return value for the command. A value of 1 indicates success.

←   listDatabases logRotate  →