MongoDB\Client::listDatabases()

Definición

MongoDB\Client::listDatabases()

Devuelve información de todas las bases de datos del servidor.

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

Parámetros

$options : arreglo

Un arreglo que especifica las opciones deseadas.

Nombre	Tipo	Descripción
dataBasesAutorized	booleano	Una bandera que determina qué bases de datos se devuelven en función de los privilegios del usuario cuando el control de acceso está habilitado. Para obtener más información, consulta el comando listDatabases referencia en el manual del servidor MongoDB. Novedad en la versión 1.7.
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 bases de datos. Es posible especificar una expresión de query para campos de base de datos (p. ej. name, sizeOnDisk, empty). Nueva en la versión 1.3.
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

Una instancia de Iterator, que proporciona un MongoDB\Model\DatabaseInfo objeto para cada base de datos en el servidor.

Errores/Excepciones

MongoDB\Exception\UnexpectedValueException si la respuesta del comando del servidor era incorrecta.

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 enumera todas las bases de datos en el servidor:

<?php
$client = new MongoDB\Client;
foreach ($client->listDatabases() as $databaseInfo) {
    var_dump($databaseInfo);
}

La vista de salida se ilustraría como sigue:

object(MongoDB\Model\DatabaseInfo)#4 (3) {
  ["name"]=>
  string(5) "local"
  ["sizeOnDisk"]=>
  float(65536)
  ["empty"]=>
  bool(false)
}
object(MongoDB\Model\DatabaseInfo)#7 (3) {
  ["name"]=>
  string(4) "test"
  ["sizeOnDisk"]=>
  float(32768)
  ["empty"]=>
  bool(false)
}

Ver también

• MongoDB\Client::listDatabaseNames()

• listDatabases referencia de comando en el manual de MongoDB

• Enumerando bases de datos especificación