MongoDB\Client::listDatabaseNames()

本页内容

新功能在版本中1.7.

定义

MongoDB\Client::listDatabaseNames()

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

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

$options : array

指定所需选项的数组。

名称	类型	描述
authorizedDatabases	boolean	一个标志，用于确定在启用访问控制时根据用户权限返回哪些数据库。有关更多信息，请参阅listDatabases命令文档. 对于版本小于4.0.5的服务器，此选项被忽略。新功能在版本中1.7.
comment	mixed	允许用户指定一个任意的注释来帮助通过数据库分析器、当前操作输出和日志来跟踪操作。此选项自MongoDB 4.4起可用，如果用于较旧的服务器版本，将在执行时引发异常。新功能在版本中1.13.
filter	array\|object	用于过滤数据库列表的查询表达式。您可以指定数据库字段的查询表达式（例如`name`、`sizeOnDisk`、`empty`）。新功能在版本中1.3.
maxTimeMS	integer	处理游标操作的总时间限制（以毫秒为单位）。MongoDB在最早的后续中断点处终止操作。
session	MongoDB\Driver\Session	要关联到操作的客户端会话。新功能在版本中1.3.

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

MongoDB\Exception\UnexpectedValueException 如果服务器的命令响应格式不正确。

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

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

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

输出将类似于

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

getWriteConcern()

listDatabases()