On this page
listCollections
在本页面
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标志。
Note
MongoDB 3.0 忽略usePowerOf2Sizes标志。有关更多信息,请参见collMod和db.createCollection()。
有关选项的说明,请参见db.createCollection()。
| info | Document |列出与集合相关的以下字段:
readOnlyboolean
。如果true
,则数据存储区为只读。
uuid
UUID。构建后,集合 UUID 不会更改。分片群集中的副本集成员和分片之间的集合 UUID 保持不变。
3.6 版中的新功能。
| idIndex | Document |提供有关集合的_id
索引的信息。
listCollections.
ok
- 命令的返回值。值
1
表示成功。
- 命令的返回值。值
Required Access
执行命令的用户需要system.namespaces集合具有find特权或listCollections特权操作。 read built-in role至少提供必要的权限。
Example
列出所有收藏
下面的示例使用db.getCollectionInfos()帮助程序返回records
数据库中所有集合的信息:
use records
db.getCollectionInfos();
See also