listIndexes

定义

listIndexes

返回有关指定集合上索引的信息。返回的索引信息包括用于创建索引的键和选项，以及隐藏的索引。您可以可选地设置第一批结果的批大小。

提示

在mongosh中，此命令也可以通过db.collection.getIndexes()辅助方法运行.

辅助方法对mongosh用户来说很方便，但它们可能不会返回与数据库命令相同级别的信息。在不需要便利性或需要额外的返回字段的情况下，请使用数据库命令。

兼容性

此命令可在以下环境中的部署中使用

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

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

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

语法

该命令有以下语法

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

命令字段

命令包含以下字段

必需的访问权限

如果启用了访问控制，内置的 read 角色提供了运行数据库中集合的 listIndexes 所需的权限。

行为

输出

listIndexes.cursor

根据您光标指定的批次大小返回的结果集。每个批次输出的文档包含以下字段

字段	类型	描述
id	整数	一个64位整数。如果为零，则没有更多的信息批次。如果非零，则为光标ID，可在getMore命令中使用以获取下一批次索引信息。
ns	字符串	以下格式的数据库和集合名称：<database-name>.<collection-name>
firstBatch	document	索引信息包括用于创建索引的键和选项。如果值为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
}