Make the MongoDB docs better! We value your opinion. Share your feedback for a chance to win $100.
Click here >
Docs 菜单
Docs 主页
/
开发中
/
mongosh 方法
Docs 主页
/
开发中
/
mongosh 方法
Docs 主页
/
开发中
/
mongosh 方法

db. 集合.deleteOne()（mongosh方法）

带驱动程序的 MongoDB

本页面提供 mongosh 方法的相关信息。要查看 MongoDB 驱动程序中的等效方法，请参阅编程语言的相应页面：

C#Java SyncNode.jsPyMongoC++GoJava RSKotlin CoroutineKotlin SyncPHPMongoidRustScala

定义

db.collection.deleteOne()

从集合中删除单个文档。

返回：文档包含以下内容：

  • 如果操作使用 写关注来运行，则布尔值 acknowledged 为 true；如果已禁用写关注，则为 false

  • deletedCount 包含已删除文档的数量

兼容性

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

注意

所有 MongoDB Atlas 集群都支持此命令。有关 Atlas 对所有命令的支持的信息，请参阅不支持的命令。

语法

deleteOne() 方法采用以下形式：

db.collection.deleteOne(
    <filter>,
    {
      writeConcern: <document>,
      collation: <document>,
      hint: <document|string>,
      maxTimeMS: <int>,
      let: <document>
    }
)

deleteOne() 方法使用以下参数：

Parameter
类型
说明

筛选器

文档

使用查询谓词指定删除条件。

指定空文档 { } 以删除集合中返回的第一个文档。

writeConcern

文档

可选。表达写关注的文档。省略以使用默认写关注。

如果是在事务中运行，则请勿显式设置此操作的写关注。要将写关注与事务一起使用，请参阅事务和写关注。

排序规则

文档

可选。

指定用于操作的排序规则。

排序规则允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号规则。

排序规则选项的语法如下：

collation: {
    locale: <string>,
    caseLevel: <boolean>,
    caseFirst: <string>,
    strength: <int>,
    numericOrdering: <boolean>,
    alternate: <string>,
    maxVariable: <string>,
    backwards: <boolean>
 }

指定排序规则时，locale 字段为必填字段；所有其他排序规则字段均为可选字段。有关字段的说明，请参阅排序规则文档。

如果未指定排序规则，但集合具有默认排序规则（请参阅 db.createCollection()），则操作将使用为集合指定的排序规则。

如果没有为收集或操作指定排序规则，MongoDB 将使用先前版本中使用的简单二进制比较来进行字符串比较。

您不能为一个操作指定多个排序规则。例如，您不能为每个字段指定不同的排序规则，或者如果执行带排序的查找，则不能使用一种排序规则进行查找而另一种排序规则进行排序。

提示

文档

可选。 指定用于支持查询谓词的索引的文档或字符串。

该选项可以采用索引规范文档或索引名称字符串。

如果指定不存在的索引，则操作出错。

有关示例，请参阅为删除操作指定 hint。

maxTimeMS

整型

可选。指定删除操作在超时之前运行的时间限制（以毫秒为单位）。

let

文档

可选。

指定包含变量列表的文档。这样可以将变量与查询文本分开，从而提高命令的可读性。

文档语法为：

{
  <variable_name_1>: <expression_1>,
  ...,
  <variable_name_n>: <expression_n>
}

变量设置为表达式返回的值，并且之后不能再进行更改。

要访问命令中的变量值，请使用双美元符号前缀 ($$) 以及 $$<variable_name> 形式的变量名称。例如：$$targetTotal。

要使用变量筛选结果，您必须在 $expr 操作符中访问该变量。

有关使用 let 和变量的完整示例，请参阅使用 let 变量进行更新。

行为

删除命令

db.collection.deleteOne() 会删除与过滤器匹配的第一个文档。使用作为唯一索引一部分的字段（例如 _id）进行精确删除。

分片集合

要在分片集合上使用 db.collection.deleteOne()：

  • 如果仅针对一个分片，则可以在查询规范中使用部分分片键。

  • 您不需要在查询规范中提供分片键或 _id字段，因为 deleteOne() 本质上使用 1 的限制。

事务

db.collection.deleteOne() 可以在分布式事务中使用。

如果是在事务中运行，则请勿显式设置此操作的写关注。要将写关注与事务一起使用，请参阅事务和写关注。

重要

在大多数情况下，与单文档写入操作相比，分布式事务会产生更高的性能成本，并且分布式事务的可用性不应取代有效的模式设计。在许多情况下，非规范化数据模型（嵌入式文档和数组）仍然是数据和使用案例的最佳选择。换言之，对于许多场景，适当的数据建模将最大限度地减少对分布式事务的需求。

有关其他事务使用注意事项（如运行时间限制和 oplog 大小限制），另请参阅生产注意事项。

Oplog 条目

如果 db.collection.deleteOne() 操作成功删除文档，则该操作会为 oplog （操作日志）添加一个条目。如果操作失败或未找到要删除的文档，则该操作不会为 oplog 添加条目。

示例

本页上的示例使用 sample_mflix示例数据集 中的数据。有关如何将此数据集加载到自管理MongoDB 部署中的详细信息，请参阅加载示例数据集。如果对示例数据库进行了任何修改，则可能需要删除并重新创建数据库才能运行本页上的示例。

删除单个文档

以下操作会删除 year 早于 1910 的第一个文档：

db.movies.deleteOne( { year: { $lt: 1910 } } )
{ acknowledged: true, deletedCount: 1 }

具有超时和查询变量的 deleteOne()

以下操作删除 year 早于 cutoffYear 变量的第一个文档，并设置 3 秒的时间限制：

db.movies.deleteOne(
   { $expr: { $lt: ["$year", "$$cutoffYear"] } },
   {
      let: { cutoffYear: 1910 },
      maxTimeMS: 3000
   }
)
{ acknowledged: true, deletedCount: 1 }

附带写关注的 deleteOne()

给定一个三成员副本集，以下操作指定 majority 的 w 和 100 的 wtimeout：

db.movies.deleteOne(
   { title: "A Corner in Wheat" },
   { writeConcern: { w: "majority", wtimeout: 100 } }
)
{ acknowledged: true, deletedCount: 1 }

指定排序规则。

排序规则允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号规则。

以下操作使用具有英语区域设置和strength: 2 的排序规则选项，这使得比较不区分大小写。过滤title: "the dark knight" 会匹配集合中标题为"The Dark Knight" 的文档：

db.movies.deleteOne(
   { title: "the dark knight" },
   { collation: { locale: "en", strength: 2 } }
)
{ acknowledged: true, deletedCount: 1 }

为删除操作指定 hint

在 rated 和 metacritic 字段上创建索引：

db.movies.createIndex( { rated: 1 } )
db.movies.createIndex( { metacritic: 1 } )

以下删除操作明确提示使用索引 { rated: 1 }：

db.movies.deleteOne(
   { metacritic: { $lte: 15 }, rated: "PG" },
   { hint: { rated: 1 } }
)
{ acknowledged: true, deletedCount: 1 }

注意

如果指定不存在的索引，则操作出错。

要查看使用的索引，可以使用 $indexStats 管道：

db.movies.aggregate( [ { $indexStats: { } }, { $sort: { name: 1 } } ] )

$indexStats 输出中的 accesses.ops 字段表示使用该索引的操作次数。

提示

要删除多个文档，请参阅 db.collection.deleteMany()

后退

db.collection.deleteMany

来年

db.collection.distinct

在此页面上