MongoDB\Model\CollectionInfo::getIdIndex()

Definition

MongoDB\Model\CollectionInfo::getIdIndex()

Returns information about the _id field index.

function getIdIndex(): array

Return Values

An array containing information on the _id index. This corresponds to the idIndex field returned in the listCollections command reply.

Examples

<?php
$info = new CollectionInfo([
  'type' => 'view',
  'name' => 'foo',
  'idIndex' => [
     'v' => 2,
     'key' => ['_id' => 1],
     'name' => '_id',
     'ns' => 'test.foo',
  ],
]);
var_dump($info->getIdIndex());

The output would then resemble:

array(4) {
  ["v"]=>
  int(2)
  ["key"]=>
  array(1) {
    ["_id"]=>
    int(1)
  }
  ["name"]=>
  string(3) "_id"
  ["ns"]=>
  string(8) "test.foo"
}

See Also

• MongoDB\Database::createCollection()

• listCollections command reference in the MongoDB manual