Docs HomeMongoDB Manual

db.collection.findOneAndDelete()

Definition定义

db.collection.findOneAndDelete( filter, options )
Important

mongosh Method

This page documents a mongosh method. This is not the documentation for database commands or language-specific drivers, such as Node.js.本页记录了一个mongosh方法。这不是数据库命令或特定语言驱动程序(如Node.js)的文档。

For the database command, see the delete command.

For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.

For the legacy mongo shell documentation, refer to the documentation for the corresponding MongoDB Server release:

mongo shell v4.4

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

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

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

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

Parameter参数Type类型Description描述
filterdocumentThe 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+), the operation errors if the query argument is not a document. 从MongoDB 4.2(和4.0.12+)开始,如果查询参数不是文档,则操作会出错。
writeConcerndocumentOptional.可选的。A document expressing the write concern. Omit to use the default write concern. 表示写入关注的文件。忽略使用默认的写入关注。
{ w: <value>, j: <boolean>, wtimeout: <number> }
See Delete A Document Using WriteConcern for usage.有关用法,请参阅使用WriteConcern删除文档以了解用法。
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. 要在事务中使用写入关注,请参阅事务和写入关注
projectiondocumentOptional.可选的。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+), the operation errors if the projection argument is not a document. 从MongoDB 4.2(和4.0.12+)开始,如果投影参数不是文档,则操作会出错。
sortdocumentOptional.可选的。Specifies a sorting order for the documents matched by the filter.filter匹配的文档指定排序顺序。
Starting in MongoDB 4.2 (and 4.0.12+) the operation errors if the sort argument is not a document.从MongoDB 4.2(和4.0.12+)开始,如果排序参数不是文档,则操作会出错。
See cursor.sort(). 请参阅cursor.sort()
maxTimeMSnumberOptional.可选的。Specifies a time limit in milliseconds within which the operation must complete within. Throws an error if the limit is exceeded.指定操作必须在内完成的时间限制(以毫秒为单位)。如果超过限制,则抛出错误。
collationdocumentOptional.可选的。
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选项具有以下语法:
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. 例如,不能为每个字段指定不同的排序规则,或者如果使用排序执行查找,则不能为查找使用一个排序规则,为排序使用另一个排序顺序。
Returns:返回值:Returns the deleted document.返回已删除的文档。

Behavior行为

Document Match文档匹配

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

Projection投影

Important

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> ... }
Projection投影Description描述
<field>: <1 or true>Specifies the inclusion of a field. If you specify a non-zero integer for the projection value, the operation treats the value as true.指定包含字段。如果为投影值指定非零整数,则操作会将该值视为true
<field>: <0 or false>Specifies the exclusion of a field.指定字段的排除。
"<field>.$": <1 or true>Uses the $ array projection operator to return the first element that matches the query condition on the array field. 使用$数组投影运算符返回与数组字段上的查询条件匹配的第一个元素。If you specify a non-zero integer for the projection value, the operation treats the value as true.如果为投影值指定非零整数,则操作会将该值视为true
Not available for views. 不可用于视图
<field>: <array projection>Uses the array projection operators ($elemMatch, $slice) to specify the array elements to include.使用数组投影运算符($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开始,通过使用聚合表达式和语法,包括使用文字和聚合变量,您可以投影新字段或使用新值投影现有字段。
  • 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, for example: 如果为投影值指定非数字、非布尔文字(如文字字符串、数组或运算符表达式),则字段将使用新值进行投影,例如:
    • { 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, for example: 要为字段投影文字值,请使用$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及更早版本中,任何规范值(以前不支持的文档值除外)都被视为真或假,以指示包含或排除字段。
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, for example 点表示法,例如"field.nestedfield": <value>
  • nested form, for example { field: { nestedfield: <value> } } (Starting in MongoDB 4.4)嵌套形式,例如{ field: { nestedfield: <value> } }从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不能同时包含include和exclude规范,_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.有关其他事务使用注意事项(如运行时限制和操作日志大小限制),请参阅生产注意事项

Examples实例

Delete A Document删除文档

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

 db.scores.insertMany( [
{ _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 }

Delete A Document Using WriteConcern使用WriteConcern删除文档

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

db.scores.insertMany( [
{ _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 uses a write concern document inside of the db.collection.findOneAndDelete() method with options:以下操作在带有选项的db.collection.findOneAndDelete()方法内部使用一个写入关注文档:

  • w:1 to requests acknowledgment that the write operation has propagated to the standalone mongod or the primary in a replica set.用来请求确认写入操作已传播到副本集中的独立mongod或主mongod
  • j:true to tell the number of MongoDB instances specified in w:1 to have the delete written to on-disk journel.告诉w:1中指定的要在磁盘journel上写入删除的MongoDB实例的数量。
  • wtimeout : 1000 to specify a time limit, in milliseconds, for the write concern. 指定写入关注的时间限制(以毫秒为单位)。wtimeout is only applicable for w values greater than 1.仅适用于大于1w值。
db.scores.findOneAndDelete(
{ name: "A. MacDyver" },
{
writeConcern: {
w : 1,
j : true,
wtimeout : 1000
}
}
)

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

{ _id: 6305, name: 'A. MacDyver', assignment: 5, points: 24 }

The document is deleted with the writeConcern options specified.删除文档时指定了writeConcern选项。

Sort And Delete A Document排序并删除文档

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

db.scores.insertMany( [
{ _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:然后,在删除点值最低的文档之前,它会按升序排序:

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:以下操作使用投影仅返回返回文档中的_idassignment字段:

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:以下操作设置5ms的时间限制以完成删除:

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:如果操作超过时间限制,则返回:

MongoServerError: operation exceeded time limit: { "ok": 0, "code" : 50, "codeName" : "MaxTimeMSExpired" }
Note

This error message has been shortened for brevity.为简洁起见,此错误消息已被缩短。

Specify Collation指定排序规则

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包含以下文档:

db.myColl.insertMany( [
{ _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:以下操作包括collation选项:

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

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

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