listIndexes

在本页面

• Definition

• Required Access

• Output

3.0.0 版中的新功能。

Definition

• listIndexes
  • 返回有关指定集合上的索引的信息。具体地说，该命令返回一个文档，该文档包含用于创建指向索引信息的游标的信息。索引信息包括用于创建索引的键和选项。 mongo shell 提供db.collection.getIndexes()帮助器。

该命令具有以下形式：

{ "listIndexes": "<collection-name>" }

Field	Type	Description
listIndexes	string	集合的名称。

Required Access

执行命令的用户需要system.indexes集合具有find特权或listIndexes特权操作。 read built-in role至少提供必要的权限。

Output

• listIndexes. cursor

  • 包含信息的文档，通过该信息可创建用于索引信息的游标。游标信息包括游标 ID，命令的完整名称空间以及第一批结果。索引信息包括用于创建索引的键和选项。有关键和索引选项的信息，请参见db.collection.createIndex()。

• listIndexes. ok

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