MongoDB\Client::listDatabases()

定义

MongoDB\Client::listDatabases()

返回服务器上所有数据库的信息。

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

参数

$options : array

指定所需选项的数组。

名称	类型	描述
authorizedDatabases	boolean	一个标志，用于确定在启用访问控制时根据用户权限返回哪些数据库。有关更多信息，请参阅listDatabases 命令文档. 对于版本小于 4.0.5 的服务器，此选项被忽略。 新增在版本1.7.
注释	混合	允许用户指定一个任意注释，以帮助通过 数据库分析器、当前操作 输出和 日志 跟踪操作。 此选项从 MongoDB 4.4 版本开始提供，如果指定了旧服务器版本，则在执行时将引发异常。 新增在版本1.13.
过滤器	数组|对象	一个查询表达式，用于筛选数据库列表。 您可以指定数据库字段的查询表达式（例如 name、sizeOnDisk、empty）。 新增在版本1.3.
maxTimeMS	整数	对游标上处理操作的累积时间限制（以毫秒为单位）。MongoDB 会在最早的下一个 中断点 处终止操作。
会话	MongoDB\Driver\Session	与操作关联的客户端会话。 新增在版本1.3.

返回值

可遍历的MongoDB\Model\DatabaseInfoIterator，其中包含每个服务器数据库的 MongoDB\Model\DatabaseInfo 对象。

错误/异常

如果服务器返回的命令响应格式不正确，则抛出 MongoDB\Exception\UnexpectedValueException。

对于与参数或选项解析相关的错误，抛出 MongoDB\Exception\InvalidArgumentException。

对于扩展级别的其他错误（例如连接错误），抛出 MongoDB\Driver\Exception\RuntimeException。

示例

以下示例列出服务器上的所有数据库

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

输出将类似于

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

另请参阅

• MongoDB\Client::listDatabaseNames()

• listDatabases 命令参考，请参阅 MongoDB 手册

• 数据库枚举 规范