MongoDB\Model\CollectionInfo::getIdIndex()

Definição

MongoDB\Model\CollectionInfo::getIdIndex()

Retorna informações sobre o índice de campo _id .

function getIdIndex(): array

Return Values

Uma array contendo informações sobre o índice _id . Corresponde ao campo idIndex retornado na resposta do comando listCollections .

Exemplos

<?php
$db = (new MongoDB\Client)->test;
$db->createCollection('myCollection');
// Retrieves the _id index information
foreach ($db->listCollections(['filter' => ['name' => 'myCollection']]) as $info) {
   var_dump($info->getIdIndex());
}

A saída seria então semelhante a:

array(3) {
   'v' =>
   int(2)
   'key' =>
   array(1) {
      '_id' =>
      int(1)
   }
   'name' =>
   string(4) "_id_"
}

Veja também

• MongoDB\Database::createCollection()

• referência do comando listCollections no manual do MongoDB