listCollections（数据库命令）

定义

listCollections

检索数据库中集合和视图的信息，包括名称和创建选项。

listCollections 命令返回一个文档，其中包含数据库中所有集合和视图的未排序列表。您可以使用返回的文档在集合上创建游标。

mongosh provides the db.getCollectionInfos() and the db.getCollectionNames() helper methods, as well as the show collections command.

兼容性

此命令可用于以下环境中托管的部署：

• MongoDB Atlas：用于云中 MongoDB 部署的完全托管服务

• MongoDB Enterprise：基于订阅、自我管理的 MongoDB 版本

• MongoDB Community：源代码可用、免费使用且可自行管理的 MongoDB 版本

语法

该命令具有以下语法：

db.runCommand(
   {
     listCollections: 1,
     filter: <document>,
     nameOnly: <boolean>,
     authorizedCollections: <boolean>,
     comment: <any>
   }
)

命令字段

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

行为

必需的访问权限

The listCollections command and its wrapper db.getCollectionInfos() require the listCollections action when access control is enforced. Users must have privileges that grant the listCollections action on the database to run listCollections.

例如，以下命令授予对 test 数据库运行 db.getCollectionInfos() 的特权：

{ resource: { db: "test", collection: "" }, actions: [ "listCollections" ] }

内置角色 read 提供为特定数据库运行 listCollections 的特权。

当 authorizedCollections 和 nameOnly 都设置为 true 时，没有所需的 read 特权的用户可以运行 listCollections。在这种情况下，该命令将返回用户对其拥有特权的集合的名称和类型。

例如，假设某个用户具有授予以下 find 特权的角色：

{ resource: { db: "sales", collection: "currentQuarter" }, actions: [ "find" ] }

如果 authorizedCollections 和 nameOnly 都设置为 true，则用户可以运行listCollections。

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true,
       nameOnly: true
   }
)

该操作将返回 currentQuarter 集合的名称和类型。

但是，如果用户没有所需访问授权，以下操作会返回错误：

db.runCommand(
   {
       listCollections: 1.0,
       authorizedCollections: true
   }
)
db.runCommand(
   {
       listCollections: 1.0,
       nameOnly: true
   }
)

输出

listCollections.cursor

一个文档，其中包含创建游标包含集合名称和选项的文档的游标所需的信息。游标信息包括游标id、命令的完整命名空间和第一批批处理结果。批处理输出中的每个文档都包含以下字段：

字段	类型	说明
名称	字符串	集合的名称。
类型	字符串	Type of data store. Returns collection for collections, view for views, and timeseries for time series collection.
选项	文档	集合选项。 这些选项与 db.createCollection() 中的选项直接对应。有关选项的说明，请参阅 db.createCollection()。
信息	文档	列出与集合相关的以下字段： 只读 boolean。如果为 true，则数据存储为只读。 uuid UUID。建立后，集合 UUID 就不会更改。集合 UUID 在分片集群的副本集成员和分片中保持不变。
idIndex	文档	提供有关集合的 _id 索引信息。

listCollections.ok

命令的返回值。值为 1 表示成功。

如果不需要原始命令响应，请使用 db.getCollectionInfos() 或 db.getCollectionNames() 辅助程序。

例子

db.runCommand(
   {
      listCollections: 1.0,
      nameOnly: true
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      { name: 'motorhead', type: 'collection' },
      { name: 'taylorSwift', type: 'collection' },
      { name: 'ramones', type: 'collection' }
    ]
  },
  ok: 1
}

db.runCommand(
   {
      listCollections: 1.0
   }
)

{
  cursor: {
    id: Long("0"),
    ns: 'music.$cmd.listCollections',
    firstBatch: [
      {
        name: 'motorhead',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("09ef1858-2831-47d2-a3a7-9a29a9cfeb94")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'taylorSwift',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("6c46c8b9-4999-4213-bcef-9a36b0cff228")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      },
      {
        name: 'ramones',
        type: 'collection',
        options: {},
        info: {
          readOnly: false,
          uuid: new UUID("7e1925ba-f2f9-4e42-90e4-8cafd434a6c4")
        },
        idIndex: { v: 2, key: { _id: 1 }, name: '_id_' }
      }
    ]
  },
  ok: 1
}

了解详情

对于集合选项：

• db.createCollection()

• create

有关集合信息：

• db.getCollectionInfos()

• mongosh 内置命令