MongoDB\Collection::listIndexes()

Definição

MongoDB\Collection::listIndexes()

Retorna informações de todos os índices dessa collection.

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

Parâmetros

$options : array

Um array especificando as opções desejadas.

Nome	Tipo	Descrição
comentário	misto	Permite que os usuários especifiquem um comentário arbitrário para ajudar a rastrear a operação por meio do analisador de banco dedados , saídacurrentOp e logs. Esta opção está disponível desde o MongoDB 4.4 e resultará em uma exceção no momento da execução se for especificada para uma versão mais antiga do servidor. Novidade na versão 1.13.
maxTimeMS	inteiro	O limite de tempo cumulativo em milissegundos para operações de processamento no cursor. O MongoDB cancela a operação no primeiro ponto de interrupção seguinte.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidade na versão 1.3.

Valores de retorno

Um MongoDB\Model\IndexInfoIterator atravessável, que contém um objeto MongoDB\Model\IndexInfo para cada índice da collection.

Erros/exceções

MongoDB\Exception\InvalidArgumentException para erros relacionados à análise de parâmetros ou opções.

MongoDB\Driver\Exception\RuntimeException para outros erros no nível do driver (por exemplo, erros de conexão).

Exemplo

O exemplo a seguir lista todos os índices para a collection restaurants no reconhecimento de data center test :

<?php
$collection = (new MongoDB\Client)->test->restaurants;
foreach ($collection->listIndexes() as $index) {
   var_dump($index);
}

A saída seria então semelhante a:

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"
}

Veja também

• Índices

• Referência do comando listIndexes no manual MongoDB

• Documentação do índice no manual do MongoDB

• Enumerando coleções especificação