On this page本页内容
db.collection.findOneAndDelete( filter, options )
This is a mongosh
method. This is not the documentation for Node.js
or other programming language specific driver methods.
In most cases, mongosh
methods work the same way as the legacy mongo
shell methods. However, some legacy methods are unavailable in mongosh
.
For the legacy mongo
shell documentation, refer to the documentation for the corresponding MongoDB Server release:
For MongoDB API drivers, refer to the language specific MongoDB driver documentation.
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>, { writeConcern: <document>, projection: <document>, sort: <document>, maxTimeMS: <number>, collation: <document> } )
The findOneAndDelete()
method takes the following parameters:findOneAndDelete()
方法采用以下参数:
filter | document |
|
writeConcern | document |
{ w: <value>, j: <boolean>, wtimeout: <number> }
|
projection | document |
|
sort | document |
|
maxTimeMS | number | |
collation | document |
collation: { locale: <string>, caseLevel: <boolean>, caseFirst: <string>, strength: <int>, numericOrdering: <boolean>, alternate: <string>, maxVariable: <string>, backwards: <boolean> }
|
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
参数可用于影响要删除的文档。
Starting in MongoDB 4.4, as part of making 从MongoDB 4.4开始,作为使find()
and findAndModify()
projection consistent with aggregation's $project
stage,find()
和findAndModify()
投影与聚合的$project
阶段一致的一部分,
find()
and findAndModify()
projection can accept aggregation expressions and syntax.find()
和findAndModify()
投影可以接受聚合表达式和语法。The projection
parameter takes a document in the following form:projection
参数采用以下形式的文档:
{ field1: <value>, field2: <value> ... }
Projection | |
---|---|
<field>: <1 or true> | true .true 。
|
<field>: <0 or false> | |
"<field>.$": <1 or true> | $ 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 。true .true 。
|
<field>: <array projection> | $elemMatch , $slice , specifies the array element(s) to include, thereby excluding those elements that do not meet the expressions. $elemMatch 、$slice 指定要包含的数组元素,从而排除那些不符合表达式的元素。 |
<field>: <aggregation expression> |
|
For fields in an embedded documents, you can specify the field using either:对于嵌入文档中的字段,可以使用以下方法之一指定字段:
"field.nestedfield": <value>
{ field: { nestedfield: <value> } }
(Starting in MongoDB 4.4){ field: { nestedfield: <value> } }
(从MongoDB 4.4开始)_id
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
以抑制该字段。
A projection
cannot contain both include and exclude specifications, with the exception of the _id
field:projection
不能同时包含包含和排除规范,但_id
字段除外:
_id
field is the only field that you can explicitly exclude._id
字段是唯一可以显式排除的字段。_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:有关投影的更多信息,请参阅:
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 要将缺少shard键的文档作为目标,可以将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
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.要将写关注点用于事务,请参阅事务和写关注点。
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大小限制),请参阅生产注意事项。
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 }
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
mongod
或主mongod
。j:true
w:1
to have the delete written to on-disk journel.w:1
中指定的要将delete写入磁盘日志的MongoDB实例的数量。wtimeout : 1000
wtimeout
is only applicable for w
values greater than 1.wtimeout
仅适用于大于1
的w
值。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
选项删除文档。
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: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 }
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 }
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" }
This error message has been shortened for brevity.为简洁起见,此错误消息已被缩短。
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:以下操作包括排序规则选项:
db.myColl.findOneAndDelete( { category: "cafe", status: "a" }, { collation: { locale: "fr", strength: 1 } } );
The operation returns the following document:该操作返回以下文档:
{ "_id" : 1, "category" : "café", "status" : "A" }