listCollections

在本页面

• Definition

• Behavior

• Output

• Required Access

• Example

3.0.0 版中的新功能。

Definition

• listCollections
  • 检索有关数据库中集合和views的信息，即名称和选项。具体来说，该命令返回一个文档，该文档包含用于创建光标到收集信息的信息。 mongo Shell 提供db.getCollectionInfos()和db.getCollectionNames()帮助器方法。

该命令具有以下形式：

{ listCollections: 1, filter: <document> }

listCollections命令可以采用以下可选字段：

Field	Type	Description
filter	document	可选的。查询表达式以过滤集合列表。

您可以在listCollections上的fields returned上指定查询表达式。

Behavior

使用过滤器限制listCollections的结果。您可以在listCollections结果集中的任何fields returned上指定filter。

Output

• listCollections. cursor
  • 一个文档，该文档包含用于创建包含集合名称和选项的文档的游标的信息。游标信息包括游标 ID，命令的完整名称空间以及第一批结果。批处理输出中的每个文档都包含以下字段：

Field	Type	Description
name	String	集合的名称。
type	String	数据存储的类型。对于collections返回collection，对于views返回view。
options	Document	Collection options.

这些选项直接与db.createCollection()中可用的选项相对应，但"options.flags"除外。 "options.flags"对应于db.createCollection()方法中的usePowerOf2Sizes和noPadding选项：
0对应于设置为false的usePowerOf2Sizes标志和设置为false的noPadding标志。
1对应于设置为true的usePowerOf2Sizes标志和设置为false的noPadding标志。
2对应于设置为false的usePowerOf2Sizes标志和设置为true的noPadding标志。
3对应于设置为true的usePowerOf2Sizes标志和设置为true的noPadding标志。

• listCollections. ok
  • 命令的返回值。值1表示成功。

Required Access

执行命令的用户需要system.namespaces集合具有find特权或listCollections特权操作。 read built-in role至少提供必要的权限。

Example

列出所有收藏

下面的示例使用db.getCollectionInfos()帮助程序返回records数据库中所有集合的信息：

use records
db.getCollectionInfos();