db.collection.findOneAndDelete()

On this page本页内容

Definition定义

db.collection.findOneAndDelete(filter, options)

mongo Shell Method

This page documents the mongo shell method, and does not refer to the MongoDB Node.js driver (or any other driver) method. 本页记录了mongo shell方法，未提及MongoDB Node.js驱动程序（或任何其他驱动程序）方法。For corresponding MongoDB driver API, refer to your specific MongoDB driver documentation instead.有关相应的MongoDB驱动程序API，请参阅特定的MongoDB驱动程序文档。

New in version 3.2.版本3.2中的新功能。

Deletes a single document based on the filter and sort criteria, returning the deleted document.根据filter和sort条件删除单个文档，并返回已删除的文档。

The findOneAndDelete() method has the following form:findOneAndDelete()方法的形式如下：

db.collection.findOneAndDelete(
   <filter>,
   {
     projection: <document>,
     sort: <document>,
     maxTimeMS: <number>,
     collation: <document>
   }
)

The findOneAndDelete() method takes the following parameters:findOneAndDelete()方法采用以下参数：

Parameter参数Type类型Description描述
filter document

The selection criteria for the deletion. 删除的选择标准。The same query selectors as in the find() method are available.可用与find()方法中相同的查询选择器。

Specify an empty document { } to delete the first document returned in the collection.指定空文档{}以删除集合中返回的第一个文档。

If unspecified, defaults to an empty document.如果未指定，则默认为空文档。

Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the query argument is not a document.从MongoDB 4.2（以及4.0.12+、3.6.14+和3.4.23+）开始，如果查询参数不是文档，则会出现操作错误。

projection document

Optional.可选。A subset of fields to return.要返回的字段的子集。

To return all fields in the returned document, omit this parameter.要返回返回的文档中的所有字段，请忽略此参数。

Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the projection argument is not a document.从MongoDB 4.2（以及4.0.12+、3.6.14+和3.4.23+）开始，如果投影参数不是文档，则会出现操作错误。

sort document

Optional.可选。Specifies a sorting order for the documents matched by the filter.指定filter匹配的文档的排序顺序。

Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the sort argument is not a document.从MongoDB 4.2（以及4.0.12+、3.6.14+和3.4.23+）开始，如果排序参数不是文档，则会出现操作错误。

See cursor.sort().请参见cursor.sort()。

maxTimeMS number Optional.可选。Specifies a time limit in milliseconds within which the operation must complete within. 以毫秒为单位指定操作必须在内完成的时间限制。Throws an error if the limit is exceeded.如果超出限制，则引发错误。
collation document

Optional.可选。

Specifies the collation to use for the operation.指定要用于该操作的排序规则。

Collation排序规则 allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号的规则。

The collation option has the following syntax:语法如下所示：

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

When specifying collation, the locale field is mandatory; all other collation fields are optional. 指定排序规则时，locale字段是必需的；所有其他排序规则字段都是可选的。For descriptions of the fields, see Collation Document.有关这些字段的描述，请参阅排序规则文档。

If the collation is unspecified but the collection has a default collation (see db.createCollection()), the operation uses the collation specified for the collection.如果未指定排序规则，但集合具有默认排序规则（请参见db.createCollection()），则操作将使用为集合指定的排序规则。

If no collation is specified for the collection or for the operations, MongoDB uses the simple binary comparison used in prior versions for string comparisons.如果没有为集合或操作指定排序规则，MongoDB将使用以前版本中用于字符串比较的简单二进制比较。

You cannot specify multiple collations for an operation. 不能为一个操作指定多个排序规则。For example, you cannot specify different collations per field, or if performing a find with a sort, you cannot use one collation for the find and another for the sort.例如，不能为每个字段指定不同的排序规则，或者如果使用排序执行查找，则不能对查找使用一种排序规则，对排序使用另一种排序规则。

New in version 3.4.版本3.4中的新功能。

Returns:返回：Returns the deleted document.返回已删除的文档。

Behavior行为

Document Match文件匹配

findOneAndDelete() deletes the first matching document in the collection that matches the filter. 删除集合中与filter匹配的第一个匹配文档。The sort parameter can be used to influence which document is deleted.sort参数可用于影响删除的文档。

Projection预测

Language Consistency语言一致性

Starting in MongoDB 4.4, as part of making find and findAndModify projection consistent with aggregation’s $project stage,从MongoDB 4.4开始，作为使find和findAndModify投影与聚合的$project阶段保持一致的一部分，

The projection parameter takes a document in the following form:projection参数采用以下形式的文档：

{ field1: <value>, field2: <value> ... }
ProjectionDescription描述
<field>: <1 or true> Specifies the inclusion of a field.指定字段的包含。
<field>: <0 or false> Specifies the exclusion of a field.指定字段的排除。
"<field>.$": <1 or true> With the use of the $ array projection operator, you can specify the projection to return the first element that match the query condition on the array field; e.g. "arrayField.$" : 1. 使用$数组投影运算符，可以指定投影以返回与数组字段上的查询条件匹配的第一个元素；例如，"arrayField.$" : 1。(Not available for views.)（不适用于视图。）
<field>: <array projection> Using the array projection operators $elemMatch, $slice, specifies the array element(s) to include, thereby excluding those elements that do not meet the expressions. 使用数组投影运算符$elemMatch、$slice，指定要包含的数组元素，从而排除那些不符合表达式的元素。(Not available for views.)（不适用于视图。）
<field>: <aggregation expression>

Specifies the value of the projected field.指定投影字段的值。

Starting in MongoDB 4.4, with the use of aggregation expressions and syntax, including the use of literals and aggregation variables, you can project new fields or project existing fields with new values. 从MongoDB 4.4开始，通过使用聚合表达式和语法，包括使用文字和聚合变量，可以投影新字段或使用新值投影现有字段。For example,例如

  • If you specify a non-numeric, non-boolean literal (such as a literal string or an array or an operator expression) for the projection value, the field is projected with the new value; e.g.:如果为投影值指定非数字、非布尔文字（例如文字字符串、数组或运算符表达式），则会使用新值投影字段；如。：
    • { field: [ 1, 2, 3, "$someExistingField" ] }
    • { field: "New String Value" }
    • { field: { status: "Active", total: { $sum: "$existingArray" } } }
  • To project a literal value for a field, use the $literal aggregation expression; e.g.:要为字段投影文字值，请使用$literal聚合表达式；如。：
    • { field: { $literal: 5 } }
    • { field: { $literal: true } }
    • { field: { $literal: { fieldWithValue0: 0, fieldWithValue1: 1 } } }

In versions 4.2 and earlier, any specification value (with the exception of the previously unsupported document value) is treated as either true or false to indicate the inclusion or exclusion of the field.在版本4.2和更早版本中，任何规范值（以前不支持的文档值除外）都被视为true或false，以指示包含或排除该字段。

New in version 4.4.版本4.4中的新功能。

Embedded Field Specification嵌入式字段规范

For fields in an embedded documents, you can specify the field using either:对于嵌入文档中的字段，可以使用以下任一方法指定字段：

  • dot notation; e.g. 点符号；如："field.nestedfield": <value>
  • nested form; e.g. 嵌套形式；如：{ field: { nestedfield: <value> } } (Starting in MongoDB 4.4)

_id Field Projection场投影

The _id field is included in the returned documents by default unless you explicitly specify _id: 0 in the projection to suppress the field.默认情况下，_id字段包含在返回的文档中，除非在投影中明确指定_id: 0以抑制该字段。

Inclusion or Exclusion包容还是排斥

A projection cannot contain both include and exclude specifications, with the exception of the _id field:projection不能同时包含包含和排除规范，但_id字段除外：

  • In projections that explicitly include fields, the _id field is the only field that you can explicitly exclude.在显式包含字段的投影中，_id字段是唯一可以显式排除的字段。
  • In projections that explicitly excludes fields, the _id field is the only field that you can explicitly include; however, the _id field is included by default.在显式排除字段的投影中，_id字段是唯一可以显式包括的字段；但是，默认情况下会包含_id字段。

For more information on projection, see also:有关投影的更多信息，请参阅：

Sharded Collections碎片集合

When using db.collection.findOneAndDelete() against a sharded collection, the query must contain an equality condition on shard key.对分片集合使用db.collection.findOneAndDelete()时，query必须在分片键上包含相等条件。

Starting in version 4.4, documents in a sharded collection can be missing the shard key fields. 从4.4版开始，切分集合中的文档可能会缺少切分键字段。To target a document that is missing the shard key, you can use the null equality match in conjunction with another filter condition (such as on the _id field). 要将缺少切分键的文档作为目标，可以将null相等匹配与另一个筛选条件结合使用（例如在_id字段上）。For example:例如：

{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key

Transactions事务

db.collection.findOneAndDelete() can be used inside multi-document transactions.可以在多文档事务中使用。

Do not explicitly set the write concern for the operation if run in a transaction. 如果在事务中运行，请不要显式设置操作的写入关注点。To use write concern with transactions, see Transactions and Write Concern.要将写关注点用于事务，请参阅事务和写关注点。

Important

In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transactions should not be a replacement for effective schema design. 在大多数情况下，与单文档写入相比，多文档事务会带来更大的性能成本，而多文档事务的可用性不应取代有效的模式设计。For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. 对于许多场景，非规范化数据模型（嵌入式文档和数组）将继续适合您的数据和用例。That is, for many scenarios, modeling your data appropriately will minimize the need for multi-document transactions.也就是说，对于许多场景，适当地建模数据将最大限度地减少对多文档事务的需求。

For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.有关其他事务使用注意事项（如运行时限制和oplog大小限制），请参阅生产注意事项。

Examples例子

Delete A Document删除文件

The scores collection contains documents similar to the following:scores集合包含与以下内容类似的文档：

{ _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
{ _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
{ _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
{ _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
{ _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
{ _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }

The following operation finds the first document where name : M. Tagnum and deletes it:以下操作将查找name : M. Tagnum的第一个文档并将其删除：

db.scores.findOneAndDelete(
   { "name" : "M. Tagnum" }
)

The operation returns the original document that has been deleted:该操作将返回已删除的原始文档：

{ _id: 6312, name: "M. Tagnum", "assignment" : 5, "points" : 30 }

Sort And Delete A Document对文档进行排序和删除

The scores collection contains documents similar to the following:scores集合包含与以下内容类似的文档：

{ _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
{ _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
{ _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
{ _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
{ _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
{ _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }

The following operation first finds all documents where name : "A. MacDyver". 下面的操作首先查找name : "A. MacDyver"的所有文档。It then sorts by points ascending before deleting the document with the lowest points value:然后，在删除具有最低点值的文档之前，它会按points升序排序：

db.scores.findOneAndDelete(
   { "name" : "A. MacDyver" },
   { sort : { "points" : 1 } }
)

The operation returns the original document that has been deleted:该操作将返回已删除的原始文档：

{ _id: 6322, name: "A. MacDyver", "assignment" : 2, "points" : 14 }

Projecting the Deleted Document投影已删除的文档

The following operation uses projection to only return the _id and assignment fields in the returned document:以下操作使用投影仅返回返回返回文档中的_id和assignment字段：

db.scores.findOneAndDelete(
   { "name" : "A. MacDyver" },
   { sort : { "points" : 1 }, projection: { "assignment" : 1 } }
)

The operation returns the original document with the assignment and _id fields:该操作返回带有assignment和_id字段的原始文档：

{ _id: 6322, "assignment" : 2 }

Update Document with Time Limit有时间限制的文件更新

The following operation sets a 5ms time limit to complete the deletion:以下操作设置了5毫秒的时间限制以完成删除：

try {
   db.scores.findOneAndDelete(
      { "name" : "A. MacDyver" },
      { sort : { "points" : 1 }, maxTimeMS : 5 };
   );
}
catch(e){
   print(e);
}

If the operation exceeds the time limit, it returns:如果操作超过时间限制，则返回：

Error: findAndModifyFailed failed: { "ok" : 0, "errmsg" : "operation exceeded time limit", "code" : 50 }

Specify Collation指定排序规则

New in version 3.4.版本3.4中的新功能。

Collation排序规则 allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.允许用户为字符串比较指定特定于语言的规则，例如字母大小写和重音符号的规则。

A collection myColl has the following documents:myColl集合包含以下文档：

{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }

The following operation includes the collation option:以下操作包括排序规则选项：

db.myColl.findOneAndDelete(
   { category: "cafe", status: "a" },
   { collation: { locale: "fr", strength: 1 } }
);

The operation returns the following document:该操作将返回以下文档：

{ "_id" : 1, "category" : "café", "status" : "A" }