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

Uma array especificando as opções desejadas.

Nome	Tipo	Descrição
comment	misto	Permite ao usuário especificar um comentário arbitrário para ajudar a rastrear a operação por meio do profiler de banco de dados, da saída currentOp e dos registros. 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. Novidades na versão 1.13.
maxTimeMS	inteiro	O limite de tempo cumulativo em milésimos de segundo para operações de processamento no cursor. O MongoDB aborta a operação o mais cedo possível após o ponto de interrupção.
session	MongoDB\Driver\Session	Sessão do cliente a ser associada à operação. Novidades na versão 1.3.

Return Values

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 da extensão (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 para otimização de queries

• Referência do comando listIndexes no manual MongoDB

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

• Especificação de Enumeração de Coleções