带驱动程序的 MongoDB
定义
db.collection.dropIndex(index)从集合中删除或移除指定索引。
注意
不能删除
_id字段上的默认索引。不能指定
db.collection.dropIndex("*")删除所有非_id索引。请改用db.collection.dropIndexes()。
要获取
db.collection.dropIndex()方法的索引名称或索引规范文档,请使用db.collection.getIndexes()方法。
参数
db.collection.dropIndex()方法采用以下参数:
Parameter | 类型 | 说明 |
|---|---|---|
| 字符串或文档 | 必需。指定要删除的索引。可以通过索引名称或索引规范文档来指定索引。 要删除文本索引,请指定该索引的名称。 您无法指定 如果为 |
兼容性
此方法可用于以下环境中托管的部署:
- MongoDB Atlas:用于云中 MongoDB 部署的完全托管服务
注意
所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息,请参阅不支持的命令。
MongoDB Enterprise:基于订阅、自我管理的 MongoDB 版本
MongoDB Community:源代码可用、免费使用且可自行管理的 MongoDB 版本
行为
从MongoDB 8.3 开始,db.collection.dropIndex() 是幂等的。如果指定的索引不存在,则 db.collection.dropIndex() 将忽略不存在的索引并成功完成,而不是返回 IndexNotFound 错误。在早期版本中,如果指定的索引不存在,则 db.collection.dropIndex() 会返回 IndexNotFound 错误。
即使正在构建另一个索引,也可以使用 db.collection.dropIndex() 删除同一集合上的现有索引。在早期版本中,在进行中的索引构建期间尝试删除其他索引会导致 BackgroundOperationInProgressForNamespace 错误。
资源锁定
db.collection.dropIndex() 在操作期间获得对指定集合的独占锁。对集合的所有后续操作都必须等到 db.collection.dropIndex() 释放该锁为止。
停止进行中的索引构建
如果为 db.collection.dropIndex() 指定的索引仍在构建中,db.collection.dropIndex() 会尝试停止正在进行的构建。停止索引构建与删除已构建的索引效果相同。
对于副本集,请在主节点上运行 db.collection.dropIndex()。主节点停止索引构建并创建关联的“abortIndexBuild”oplog 条目。复制“abortIndexBuild”oplog 条目的从节点会停止正在进行的索引构建并放弃构建作业。有关索引构建过程的详细文档,请参阅索引构建流程。
使用 currentOp 确定与 createIndexes 或 db.collection.createIndexes() 操作相关的索引构建。有关示例,请参阅主动索引操作。
Hidden Indexes
MongoDB 提供对查询规划器隐藏或取消隐藏索引的功能。通过向规划器隐藏索引,您可以评估在不实际删除索引的情况下删除索引的潜在影响。
如果经过评估后,用户决定删除该索引,则您可以删除隐藏索引;即不需要先取消隐藏才能删除。
如有不利影响,用户可以取消隐藏索引,而不必重新创建已删除的索引。由于索引在隐藏期间得到完全维护,因此一旦取消隐藏,索引就立即可用。
有关隐藏索引的更多信息,请参阅隐藏索引。
例子
在 pets集合中,对 cat字段创建降序索引:
db.pets.createIndex( { cat: -1 }, { name: "catIdx" } )
要查看 pets 集合中的索引,运行 getIndexes() 方法:
db.pets.getIndexes()
[ { v: 2, key: { _id: 1 }, name: '_id_' }, { v: 2, key: { cat: -1 }, name: 'catIdx' } ]
字段cat 上的单字段索引的用户指定名称为 catIdx,索引规范文档为 { "cat" : -1 }。
要删除索引 catIdx,您可以使用索引名称:
db.pets.dropIndex( "catIdx" )
或者,也可以使用索引规范文档 { "cat" : -1 }:
db.pets.dropIndex( { "cat" : -1 } )
dropIndex 命令返回运行命令之前集合中的索引数,并指示命令是否成功:
{ nIndexesWas: 2, ok: 1 }
要确认索引已删除,请再次运行getIndexes() 方法:
db.pets.getIndexes()
[ { v: 2, key: { _id: 1 }, name: '_id_' } ]