MongoDB\Model\IndexInfo::getKey()

Definição

MongoDB\Model\IndexInfo::getKey()

Retorne a especificação do índice (ou seja, campo(s) indexado(s) e ordem). Isto se correlaciona com o parâmetro $key para MongoDB\Collection::createIndex().

function getKey(): array

Valores de retorno

A especificação do índice como um array associativo.

Exemplos

<?php
$info = new IndexInfo([
    'key' => ['x' => 1],
]);
var_dump($info->getKey());

A saída seria então semelhante a:

array(1) {
  ["x"]=>
  int(1)
}

Veja também

• MongoDB\Collection::createIndex()

• Referência do comando listIndexes no manual MongoDB