MongoDB\Database::listCollectionNames()

定义

MongoDB\Database::listCollectionNames()

返回此数据库中所有collection的名称。

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

参数

$options : array

指定所需选项的数组。

名称	类型	说明
authorizedCollections	布尔	一个标志，用于确定启用访问控制时根据用户权限返回哪些集合。 有关更多信息，请参阅 listCollections命令文档。 对于 4.0 以下的服务器，此选项将被忽略。 1.12 版本中的新增功能。
comment	混合	使用户可以指定任意注释来帮助通过数据库分析器、currentOp 输出和日志来跟踪操作。 自 MongoDB 4.4 起此选项可用，如果为旧服务器版本指定，则会在执行时导致异常。 1.13 版本中的新增功能。
筛选器	数组|对象	用于过滤集合列表的查询表达式。 您可以为collection字段指定查询表达式（例如 name 、 options ）。
maxTimeMS	整型	处理游标操作的累计时间限制（以毫秒为单位）。MongoDB 最早会在中断点之后中止操作。
会话	MongoDB\Driver\Session	与操作相关联的客户端会话。

Return Values

迭代器 ，提供数据库中每个集合的名称。

例子

以下示例列出了test数据库中的所有collection：

<?php
$database = (new MongoDB\Client)->test;
foreach ($database->listCollectionNames() as $collectionName) {
    var_dump($collectionName);
}

而输出将类似如下所示：

string(11) "restaurants"
string(5) "users"
string(6) "restos"

以下示例列出了test数据库中名称以"rest"开头的所有collection：

<?php
$database = (new MongoDB\Client)->test;
$collections = $database->listCollectionNames([
    'filter' => [
        'name' => new MongoDB\BSON\Regex('^rest.*'),
    ],
]);
foreach ($collections as $collectionName) {
    var_dump($collectionName);
}

而输出将类似如下所示：

string(11) "restaurants"
string(6) "restos"

另请参阅

• MongoDB\Database::listCollections()

• MongoDB 手册中的listCollections命令参考

• 枚举集合 规范