• Reference >
• MongoDB\Client Class >
• MongoDB\Client::listDatabases()

MongoDB\Client::listDatabases()

Definition

MongoDB\Client::listDatabases

Returns information for all databases on the server.

copy

function listDatabases(array $options = []): MongoDB\Model\DatabaseInfoIterator

This method has the following parameters:

Parameter	Type	Description
$options	array	Optional. An array specifying the desired options.

The $options parameter supports the following options:

Option	Type	Description
authorizedDatabases	boolean	Optional. A flag that determines which databases are returned based on the user privileges when access control is enabled. For more information, see the listDatabases command documentation. For servers < 4.0.5, this option is ignored. New in version 1.7.
comment	mixed	Optional. Enables users to specify an arbitrary comment to help trace the operation through the database profiler, currentOp output, and logs. This is not supported for server versions prior to 4.4 and will result in an exception at execution time if used. New in version 1.13.
filter	array|object	Optional. A query expression to filter the list of databases. You can specify a query expression for database fields (e.g. name, sizeOnDisk, empty). New in version 1.3.
maxTimeMS	integer	Optional. The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
session	MongoDB\Driver\Session	Optional. Client session to associate with the operation. New in version 1.3.

Return Values

A traversable MongoDB\Model\DatabaseInfoIterator, which contains a MongoDB\Model\DatabaseInfo object for each database on the server.

Errors/Exceptions

MongoDB\Exception\UnexpectedValueException if the command response from the server was malformed.

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).

Example

The following example lists all databases on the server:

copy

<?php

$client = new MongoDB\Client;

foreach ($client->listDatabases() as $databaseInfo) {
    var_dump($databaseInfo);
}

The output would then resemble:

copy

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

See Also

• MongoDB\Client::listDatabaseNames()
• listDatabases command reference in the MongoDB manual
• Enumerating Databases specification

←   MongoDB\Client::listDatabaseNames() MongoDB\Client::selectCollection()  →

© MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.