listIndexes
¶返回有关指定集合上的索引的信息。具体地说,该命令返回一个文档,该文档包含用于创建指向索引信息的游标的信息。索引信息包括用于创建索引的键和选项。该mongo
外壳提供了
db.collection.getIndexes()
帮助。
该命令具有以下形式:
领域 | 类型 | 描述 |
---|---|---|
listIndexes |
串 | 集合的名称。 |
要listIndexes
在实施访问控制时运行,用户必须具有的特权listIndexes
。内置角色
read
提供了listIndexes
为数据库中的集合运行所需的特权
。
从MongoDB 4.2开始,如果发出listIndexes
断开连接的客户端在操作完成之前断开连接,则MongoDB将标记listIndexes
为终止(即killOp
在操作上)。
listIndexes.
cursor
¶包含信息的文档,通过该信息可创建用于索引信息的游标。游标信息包括游标ID,命令的完整名称空间以及第一批结果。索引信息包括用于创建索引的键和选项。有关键和索引选项的信息,请参见
db.collection.createIndex()
。
listIndexes.
ok
¶命令的返回值。值1
表示成功。