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 : matriz

Una matriz que especifica las opciones deseadas.

Nombre	Tipo	Descripción
bases de datos autorizadas	booleano	Un indicador que determina qué bases de datos se devuelven según los privilegios del usuario cuando el control de acceso está habilitado. Para obtener más información, consulte Referencia delcomando listDatabases en el manual del servidor MongoDB. Nuevo 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 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 bases de datos. Puede especificar una expresión de consulta para los campos de la base de datos (por ejemplo, name, sizeOnDisk, empty). Nuevo en la versión 1.3.
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\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 para errores relacionados con el análisis de parámetros u opciones.

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

Ejemplo

El siguiente ejemplo enumera todas las bases de datos del servidor:

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

El resultado sería entonces similar a lo siguiente:

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()

• Referencia del comandolistDatabases en el manual de MongoDB

• Especificación debases de datos de enumeración