listIndexes（数据库命令）

定义

listIndexes

返回指定集合上的索引信息，包括隐藏索引和当前正在构建的索引。返回的索引信息包括用于创建索引的键和选项。 您可以选择设立第批处理结果的批处理大小。

提示

In mongosh, this command can also be run through the db.collection.getIndexes() helper method.

Helper methods are convenient for mongosh users, but they may not return the same level of information as database commands. In cases where the convenience is not needed or the additional return fields are required, use the database command.

兼容性

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

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

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

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

语法

该命令具有以下语法：

db.runCommand (
   {
      listIndexes: "<collection-name>",
      cursor: { batchSize: <int> },
      comment: <any>
   }
)

命令字段

该命令接受以下字段：

必需的访问权限

If access control is enforced, the built-in read role provides the required privileges to run listIndexes for the collections in a database.

行为

输出

listIndexes.cursor

中游标指定的批处理大小返回结果集。批处理输出中的每个文档都包含以下字段：

字段	类型	说明
id	整型	：64位整型。如果为零，则不再有批量信息。如果非零，则为游标 ID，可在 getMore 命令中使用以获取下一批索引信息。
ns	字符串	数据库和集合名称采用以下格式： <database-name>.<collection-name>
firstBatch	文档	索引信息包括用于创建索引的键和选项。仅当值为 true 时，隐藏的索引选项才会显示。 根据需要使用 getMore 检索其他结果。

listIndexes.ok

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

示例

1
db.runCommand (
2
  {
3
     listIndexes: "contacts"
4
  }
5
)

1
{
2
   cursor: {
3
      id: Long("0"),
4
      ns: 'test.contacts',
5
      firstBatch: [
6
         { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' },
7
         { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' }
8
      ]
9
   },
10
   ok: 1
11
}

1
db.runCommand (
2
   {
3
      listIndexes: "contacts", cursor: { batchSize: 1 }
4
   }
5
)

1
{
2
   cursor: {
3
     id: Long("4809221676960028307"),
4
     ns: 'test.contacts',
5
    firstBatch: [ { v: 2, key: { _id: 1 }, name: '_id_', ns: 'test.contacts' } ]
6
  },
7
  ok: 1
8
}

1
db.runCommand(
2
   {
3
      getMore: Long("4809221676960028307"), collection: "contacts"
4
   }
5
)

1
{
2
   cursor: {
3
    nextBatch: [ { v: 2, key: { a: 1 }, name: 'a_1', ns: 'test.contacts' } ],
4
    id: Long("0"),
5
    ns: 'test.contacts'
6
  },
7
  ok: 1
8
}