MongoDB\Collection::listIndexes()

Definición

MongoDB\Collection::listIndexes()

Devuelve información para todos los índices de esta colección.

function listIndexes(array $options = []): Iterator

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del perfilador de bases de datos, la salida actualOp() y registros. Esta opción está disponible desde MongoDB 4.4 y, si se especifica para una versión de servidor anterior, dará lugar a una excepción en tiempo de ejecución. Novedad 1.13 en la versión.:
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para las operaciones de procesamiento en el cursor. MongoDB aborta la operación en el siguiente punto de interrupción..
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación. Novedad 1.3 en la versión.:

Return Values

Una instancia Iterator, que proporciona un objeto MongoDB\Model\IndexInfo para cada índice de la colección.

Errores/Excepciones

MongoDB\Exception\InvalidArgumentException por errores relacionados con el análisis de parámetros u opciones.

MongoDB\Driver\Exception\RuntimeException para otros errores a nivel de extensión (por ejemplo, " errores de conexión).

Ejemplo

El siguiente ejemplo muestra todos los índices de la colección restaurants en la base de datos test:

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

La vista de salida se ilustraría como sigue:

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

Ver también

• Índices para la optimización de query

• Referencia del comando listIndexes en el manual de MongoDB

• Documentación del índice en el manual de MongoDB

• Especificación de Gestión de índices