db.collection.findOneAndDelete()

在本页面

Definition

根据filtersort标准删除单个文档,并返回已删除的文档。

findOneAndDelete()方法具有以下形式:

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

findOneAndDelete()方法采用以下参数:

Parameter Type Description
filter document 更新的选择标准。与find()方法中相同的query selectors可用。


指定一个空文档{ }删除集合中返回的第一个文档。
如果未指定,则默认为空文档。
从 MongoDB 3.6.14(和 3.4.23)开始,如果查询参数不是文档,则操作错误。
| projection |文档|可选。要返回的字段子集。
要返回返回文档中的所有字段,请省略此参数。

Note





从 MongoDB 3.6.14(和 3.4.23)开始,如果 projection 参数不是文档,则操作会出错。



|
| sort |文档|可选。指定与filter匹配的文档的排序 Sequences。

> [!NOTE]




从 MongoDB 3.6.14(和 3.4.23)开始,如果 sort 参数不是文档,则操作错误。



See cursor.sort().|
| maxTimeMS |数字|可选。指定必须在其内完成操作的时间限制(以毫秒为单位)。如果超出限制,则会引发错误。
| collation |文档|可选。
指定用于操作的collation
Collation允许用户为字符串比较指定特定于语言的规则,例如字母大写和重音符号的规则。
排序规则选项具有以下语法:
collation: {
locale: <string>,
caseLevel: <boolean>,
caseFirst: <string>,
strength: <int>,
numericOrdering: <boolean>,
alternate: <string>,
maxVariable: <string>,
backwards: <boolean>
}
指定排序规则时,locale字段为必填字段;所有其他排序规则字段都是可选的。有关字段的说明,请参见Collation Document
如果未指定排序规则,但是集合具有默认排序规则(请参见db.createCollection()),则该操作将使用为集合指定的排序规则。
如果没有为集合或操作指定排序规则,则 MongoDB 使用先前版本中使用的简单二进制比较进行字符串比较。
您不能为一个操作指定多个排序规则。例如,您不能为每个字段指定不同的排序规则,或者如果对排序执行查找,则不能对查找使用一种排序规则,而对排序使用另一种排序规则。
3.4 版中的新功能。

Returns: 返回已删除的文档。

Behavior

findOneAndDelete()删除集合中与filter匹配的第一个匹配文档。 sort参数可用于影响哪个文档被更新。

projection参数采用以下格式的文档:

{ field1 : < boolean >, field2 : < boolean> ... }

<boolean>值可以是以下任意值:

Examples

删除文件

grades集合包含类似于以下内容的文档:

{ _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 }

以下操作将找到第一个文档name : M. Tagnum并将其删除:

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

该操作返回已删除的“原始”文档:

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

排序和删除文档

grades集合包含类似于以下内容的文档:

{ _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 }

以下操作首先在name : "A. MacDyver"找到所有文档。然后,它会以points升序排序,然后删除最低分值的文档:

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

该操作返回已删除的“原始”文档:

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

投影已删除的文档

以下操作使用投影仅返回返回的文档中的_idassignment字段:

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

该操作返回带有assignment_id字段的原始文档:

{ _id: 6322, "assignment" : 2 }

带时间限制更新文档

以下操作将 5ms 的时间限制设置为完成删除操作:

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

如果操作超过时间限制,则返回:

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

Specify Collation

3.4 版的新功能。

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

集合myColl具有以下文档:

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

以下操作包括collation选项:

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

该操作返回以下文档:

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