MongoDB\Client::listDatabases()
定义
参数
$options
: array指定所需选项的数组。
名称类型说明authorizedDatabases
布尔
comment
混合
筛选器
数组|对象
用于筛选数据库列表的查询表达式。
您可以为数据库字段指定查询表达式(例如
name
、sizeOnDisk
、empty
)。1.3 版本中的新增功能。
maxTimeMS
整型
处理游标操作的累计时间限制(以毫秒为单位)。MongoDB 最早会在中断点之后中止操作。
会话
与操作相关联的客户端会话。
1.3 版本中的新增功能。
Return Values
可遍历的 MongoDB\Model\DatabaseInfoIterator
,其中包含服务器上每个数据库的MongoDB\Model\DatabaseInfo
对象。
错误/异常
MongoDB\Exception\UnexpectedValueException
,如果来自服务器的命令响应格式错误。
MongoDB\Exception\InvalidArgumentException
用于与参数或选项解析相关的错误。
MongoDB\ 驱动程序\Exception\RuntimeException 对于扩展级别的其他错误(例如连接错误)。
例子
以下示例列出了服务器上的所有数据库:
$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 手册中的listDatabases命令参考
枚举数据库 规范