MongoDB\Database::listCollections()

Definición

MongoDB\Database::listCollections()

Devuelve información de todas las colecciones en esta base de datos.

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

Parámetros

$options : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
Colecciones autorizadas	booleano	Un indicador que determina qué colecciones se devuelven según los privilegios del usuario cuando el control de acceso está habilitado. Para obtener más información, consulte Documentación del comandolistCollections. Nuevo en la versión 1.12.
comment	mixto	Permite a los usuarios especificar un comentario arbitrario para ayudar a rastrear la operación a través del generador de perfiles de base de datos, la salidacurrentOp y los registros. Esta opción está disponible desde MongoDB 4.4 y generará una excepción en el momento de ejecución si se especifica para una versión de servidor anterior. Novedades en la versión 1.13.
filtro	matriz|objeto	Una expresión de consulta para filtrar la lista de colecciones. Puedes especificar una expresión de query para los campos de la colección (por ejemplo, name, options).
maxTimeMS	entero	El límite de tiempo acumulado en milisegundos para procesar operaciones en el cursor. MongoDB cancela la operación en el punto de interrupción posterior más cercano.
sesión	MongoDB\Controlador\Sesión	Sesión de cliente para asociar a la operación. Nuevo en la versión 1.3.

Return Values

Una instancia de Iterador, que proporciona una MongoDB\Model\CollectionInfo objeto para cada colección en la base de datos.

Ejemplo

El siguiente ejemplo enumera todas las colecciones en la base de datos test:

<?php
$database = (new MongoDB\Client)->test;
foreach ($database->listCollections() as $collectionInfo) {
    var_dump($collectionInfo);
}

El resultado sería entonces similar a lo siguiente:

object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(11) "restaurants"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(5) "users"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(6) "restos"
  ["options"]=>
  array(0) {
  }
}

El siguiente ejemplo enumera todas las colecciones cuyo nombre comienza con "rest" en la base de datos test:

<?php
$database = (new MongoDB\Client)->test;
$collections = $database->listCollections([
    'filter' => [
        'name' => new MongoDB\BSON\Regex('^rest.*'),
    ],
]);
foreach ($collections as $collectionInfo) {
    var_dump($collectionInfo);
}

El resultado sería entonces similar a lo siguiente:

object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(11) "restaurants"
  ["options"]=>
  array(0) {
  }
}
object(MongoDB\Model\CollectionInfo)#3 (2) {
  ["name"]=>
  string(6) "restos"
  ["options"]=>
  array(0) {
  }
}

Ver también

• MongoDB\Database::listCollectionNames()

• Referencia del comandolistCollections en el manual de MongoDB

• Especificaciónde enumeración de colecciones