MongoCollection::getIndexInfo

Returns information about indexes on this collection

&reftitle.description; public `array` `MongoCollection::getIndexInfo`
&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

This function returns an array in which each element describes an index. Elements will contain the values `name` for the name of the index, `ns` for the namespace (a combination of the database and collection name), and `key` for a list of all fields in the index and their ordering. Additional values may be present for special indexes, such as `unique` or `sparse`.

&reftitle.examples;

### `MongoCollection::getIndexInfo` example

    <?php

    $m = new MongoClient();
    $c = $m->selectCollection('test', 'venues');
    var_dump($c->getIndexInfo());

    ?>

&example.outputs.similar;

    array(
      0 => array(
        "v" => 1,
        "key" => array(
          "_id" => 1,
        ),
        "ns" => "test.venues",
        "name" => "_id_",
      ),
      1 => array(
        "v" => 1,
        "key" => array(
          "name" => 1,
        ),
        "unique" : true,
        "ns" => "test.venues",
        "name" => "name_1",
      ),
      2 => array(
        "v" => 1,
        "key" => array(
          "type" => 1,
          "createdAt" => -1,
        ),
        "ns" => "test.venues",
        "name" => "type_1_createdAt_-1",
      ),
      3 => array(
        "v" => 1,
        "key" => array(
          "location" => "2d",
        ),
        "ns" => "test.venues",
        "name" => "location_2d",
      ),
    )

&reftitle.seealso;

MongoDB core docs on vanilla indexes and geospatial indexes.