listCollections

定义

listCollections

Retrieves information, including the names and creation options, for the collections and views in a database.

The listCollections command returns a document that contains an unsorted list of all collections and views in the database. You can use the returned document to create a cursor on the collection.

mongosh provides the db.getCollectionInfos() and the db.getCollectionNames() helper methods.

兼容性

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

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

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

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

语法

该命令具有以下语法：

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

命令字段

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

行为

必需的访问权限

The listCollections command requires the listCollections action when access control is enforced. Users must have privileges that grant the listCollections action on the database to run listCollections.

For example, the following command grants the privilege to run db.getCollectionInfos() against the test database:

{ 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
   }
)

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

输出

listCollections.cursor

A document that contains information with which to create a cursor to documents that contain collection names and options. The cursor information includes the cursor id, the full namespace for the command, as well as the first batch of results. Each document in the batch output contains the following fields:

字段	类型	说明
name	字符串	集合的名称。
type	字符串	Type of data store. Returns collection for collections, view for views, and timeseries for 时间序列集合.
选项	文档	Collection options. These options correspond directly to the options available in db.createCollection(). For the descriptions on the options, see db.createCollection().
info	文档	Lists the following fields related to the collection: readOnly boolean. If true the data store is read only. uuid UUID. Once established, the collection UUID does not change. The collection UUID remains the same across replica set members and shards in a sharded cluster.
idIndex	文档	Provides information on the _id index for the collection.

listCollections.ok

The return value for the command. A value of 1 indicates success.

例子

show collections

motorhead
ramones
taylorSwift

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
}

了解详情

For collection options:

• db.createCollection()

• create

For collection information:

• db.getCollectionInfos()

• mongosh built-in commands