MongoDB\Collection::listIndexes()

On this page

Definition
Return Values
Errors/Exceptions
Example
See Also

Definition

MongoDB\Collection::listIndexes

Returns information for all indexes for this collection.

function listIndexes(array $options = []): MongoDB\Model\IndexInfoIterator

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

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.

Sessions are not supported for server versions prior to 3.6.

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:

copy

<?php

$collection = (new MongoDB\Client)->test->restaurants;

foreach ($collection->listIndexes() as $index) {
   var_dump($index);
}

The output would then resemble:

object(MongoDB\Model\IndexInfo)#8 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["_id"]=>
    int(1)
  }
  ["name"]=>
  string(4) "_id_"
  ["ns"]=>
  string(16) "test.restaurants"
}
object(MongoDB\Model\IndexInfo)#12 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["cuisine"]=>
    float(-1)
  }
  ["name"]=>
  string(10) "cuisine_-1"
  ["ns"]=>
  string(16) "test.restaurants"
}
object(MongoDB\Model\IndexInfo)#8 (4) {
  ["v"]=>
  int(1)
  ["key"]=>
  array(1) {
    ["borough"]=>
    float(1)
  }
  ["name"]=>
  string(9) "borough_1"
  ["ns"]=>
  string(16) "test.restaurants"
}

MongoDB\Collection::listIndexes()

Definition

Return Values

Errors/Exceptions

Example

See Also