- Reference >
- MongoDB\Collection Class >
- MongoDB\Collection::listIndexes()
MongoDB\Collection::listIndexes()
On this page
Definition
-
MongoDB\Collection::listIndexes
Returns information for all indexes for this collection.
This method has the following parameters:
Parameter Type Description $options
array Optional. An array specifying the desired options. The
$options
parameter supports the following options:Option Type Description comment
mixed Optional. Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs.
This is not supported for server versions prior to 4.4 and will result in an exception at execution time if used.
New in version 1.13.
maxTimeMS
integer Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point. session
MongoDB\Driver\Session Optional. Client session to associate with the operation.
New in version 1.3.
Return Values
A traversable MongoDB\Model\IndexInfoIterator
, which contains a
MongoDB\Model\IndexInfo
object for each index for the collection.
Errors/Exceptions
MongoDB\Exception\InvalidArgumentException
for errors related to
the parsing of parameters or options.
MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).
Example
The following example lists all of the indexes for the restaurants
collection in the test
database:
The output would then resemble:
See Also
- Indexes
- listIndexes command reference in the MongoDB manual
- Index documentation in the MongoDB manual
- Enumerating Collections specification