MongoDB\Database::listCollections()

Definición

MongoDB\Database::listCollections()

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

function listCollections(array $options = []): MongoDB\Model\CollectionInfoIterator

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
authorizedCollections	booleano	Una bandera que determina qué colecciones se devuelven según los privilegios de usuario cuando el control de acceso está habilitado. Para más información, consulta el Documentación del comando listCollections. Novedad 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 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. Novedades 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 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. Nueva en la versión 1.3.

Return Values

A traversable MongoDB\Model\CollectionInfoIterator, que contiene 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 comando listCollections en el manual de MongoDB

• Especificación Enumerando Colecciones