MongoDB\Database::listCollections()

Definición

MongoDB\Database::listCollections()

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

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

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
authorizedCollections	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 la documentación del comando listCollections. 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 la base de datos, la salida decurrentOp y los 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. Nuevo en la versión 1.13.
filtro	arreglo|objeto	Una expresión de query 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 acumulativo en milisegundos para procesar operaciones en el cursor. MongoDB aborta la operación en el primer punto de interrupción.
sesión	MongoDB\Driver\Session	Sesión de cliente para asociar con la operación. Nuevo en la versión 1.3.

Return Values

Una instancia de Iterator, que proporciona un objeto MongoDB\Model\CollectionInfo 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);
}

La vista de salida se ilustraría como sigue:

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);
}

La vista de salida se ilustraría como sigue:

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