Docs 菜单
Docs 主页
/ / /
PHP 库手册
/ /

MongoDB\Client::listDatabases()

MongoDB\Client::listDatabases()

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

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

指定所需选项的数组。

名称
类型
说明

authorizedDatabases

布尔

一个标志,用于确定启用访问权限控制时根据用户权限返回哪些数据库。要学习;了解更多信息,请参阅MongoDB Server手册中的 listDatabases 命令参考。

版本 1.7 中的新增内容

comment

混合

使用户可以指定任意注释来帮助通过数据库分析器currentOp 输出和日志来跟踪操作。

要使用此选项,您必须连接到MongoDB 6.0 或更高版本。如果您连接到早期版本,服务器将在执行时返回异常。

1.13 版本中的新增功能

筛选器

数组|对象

用于筛选数据库列表的查询表达式。

您可以为数据库字段指定查询表达式(例如 namesizeOnDiskempty )。

1.3 版本中的新增功能

maxTimeMS

整型

处理游标操作的累计时间限制(以毫秒为单位)。MongoDB 最早会在中断点之后中止操作。

会话

与操作相关联的客户端会话。

1.3 版本中的新增功能

一个迭代器实例,为服务器上的每个数据库提供一个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)
}

后退

listDatabaseNames()

在此页面上