MongoDB\Client::listDatabaseNames()

1.7版本新增。

定义

MongoDB\Client::listDatabaseNames()

返回服务器上所有数据库的名称。

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

$options : array

指定所需选项的数组。

名称	类型	说明
authorizedDatabases	布尔	一个标志，用于确定启用访问权限控制时根据用户权限返回哪些数据库。要学习；了解更多信息，请参阅MongoDB Server手册中的listDatabases 命令参考。 1.7版本新增。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13版本新增。
筛选器	数组\|对象	用于筛选数据库列表的查询表达式。您可以为数据库字段指定查询表达式（例如 `name` 、 `sizeOnDisk` 、 `empty` ）。 1.3版本新增。
maxTimeMS	整型	The cumulative time limit in milliseconds for processing operations on the cursor. MongoDB aborts the operation at the earliest following interrupt point.
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。 1.3版本新增。

迭代器，提供服务器上每个数据库的名称。

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

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

MongoDB\ 驱动程序\Exception\RuntimeException 用于扩展级别的其他错误（例如连接错误）。

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

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

而输出将类似如下所示：

string(5) "local"
string(4) "test"