MongoDB\Client::listDatabases()

定义

MongoDB\Client::listDatabases()

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

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

参数

$options : array

指定所需选项的数组。

名称	类型	说明
authorizedDatabases	布尔	一个标志，用于确定启用访问控制时根据用户权限返回哪些数据库。 有关更多信息，请参阅 listDatabases 命令文档。 对于 4.0.5 以下的服务器，此选项将被忽略。 版本 1.7 中的新增内容。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13 版本中的新增功能。
筛选器	数组|对象	用于筛选数据库列表的查询表达式。 您可以为数据库字段指定查询表达式（例如 name 、 sizeOnDisk 、 empty ）。 1.3 版本中的新增功能。
maxTimeMS	整型	处理游标操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。 1.3 版本中的新增功能。

Return Values

一个迭代器实例，为服务器上的每个数据库提供一个MongoDB\Model\DatabaseInfo对象。

错误/异常

MongoDB\Exception\UnexpectedValueException ，如果来自服务器的命令响应格式错误。

MongoDB\Exception\InvalidArgumentException 用于与参数或选项解析相关的错误。

MongoDB\ 驱动程序\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()

• MongoDB 手册中的listDatabases命令参考

• 枚举数据库 规范