MongoDB\Client::listDatabaseNames()
版本 1.7 中的新增内容。
定义
参数
$options
: array指定所需选项的数组。
名称类型说明authorizedDatabases布尔一个标志,用于确定启用访问控制时根据用户权限返回哪些数据库。有关更多信息,请参阅 listDatabases 命令文档。
对于 4.0.5 以下的服务器,此选项将被忽略。
版本 1.7 中的新增内容。
注释混合筛选器数组|对象用于筛选数据库列表的查询表达式。
您可以为数据库字段指定查询表达式(例如
name
、sizeOnDisk
、empty
)。1.3 版本中的新增功能。
maxTimeMS整型对游标进行处理操作的累积时间限制(以毫秒为单位)。 MongoDB 最早会在中断点之后中止操作。
会议与操作相关联的客户端会话。
1.3 版本中的新增功能。
返回值
迭代器 ,提供服务器上每个数据库的名称。
错误/异常
MongoDB\Exception\UnexpectedValueException
,如果来自服务器的命令响应格式错误。
MongoDB\Exception\InvalidArgumentException
用于与参数或选项解析相关的错误。
MongoDB\Driver\Exception\RuntimeException 驱动程序级别的其他错误(例如连接错误)。
例子
以下示例列出了服务器上的所有数据库:
$client = new MongoDB\Client; foreach ($client->listDatabaseNames() as $databaseName) { var_dump($databaseName); }
而输出将类似如下所示:
string(5) "local" string(4) "test"
另请参阅
MongoDB 手册中的listDatabases命令参考
枚举数据库 规范