db.collection.getIndexes()

定义

db.collection.getIndexes()

重要

mongosh 方法

本页面提供 mongosh 方法的相关信息。这不是数据库命令或特定语言驱动程序（例如 Node.js）的相关文档。

有关数据库命令，请参阅 listIndexes 命令。

如需了解 MongoDB API 驱动程序，请参阅特定语言的 MongoDB 驱动程序文档。

返回一个包含文档列表的数组，这些文档会对集合上现有的索引进行标识和描述，包括隐藏的索引。

必须在集合上调用 db.collection.getIndexes()。例如：

db.collection.getIndexes()

将 collection 更改为要返回索引信息的集合的名称。

兼容性

此方法可用于以下环境中托管的部署：

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

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

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

行为

必需的访问权限

要在强制执行访问权限控制时运行db.collection.getIndexes() ，用户必须具有对集合执行listIndexes的特权。

内置角色 read 提供了为数据库中的集合运行 db.collection.getIndexes() 所需的特权。

输出

db.collection.getIndexes() 会返回保存该集合索引信息的文档的数组。例如：

[
   {
      "v" : 2,
      "key" : {
         "_id" : 1
      },
      "name" : "_id_"
   },
   {
      "v" : 2,
      "key" : {
         "status" : 1
      },
      "name" : "status_1"
   },
   {
      "v" : 2,
      "key" : {
         "points" : 1
      },
      "name" : "points_1"
   }
]

索引信息包括用于创建索引的键和选项。仅当值为 true 时，索引选项 hidden 才可用。

有关键和索引选项的信息，请参阅db.collection.createIndex()。