db.collection.findOneAndUpdate()
在本页面
-
db.collection.findOneAndUpdate(过滤，更新，选项)-
version 3.2 中的新内容。
-
根据
filter
和
sort
条件更新单个文档。
findOneAndUpdate()方法具有以下形式：
更改了 version 3.6.
db.collection.findOneAndUpdate(
<filter>,
<update>,
{
projection: <document>,
sort: <document>,
maxTimeMS: <number>,
upsert: <boolean>,
returnNewDocument: <boolean>,
collation: <document>,
arrayFilters: [ <filterdocument1>, ... ]
}
)
findOneAndUpdate()方法采用以下参数：
|
参数
|
类型
|
描述
|
|---|---|---|
filter
|
document
|
更新的选择标准。可以使用与find()方法相同的query selectors。 指定一个空文档
{ }
以更新集合中返回的第一个文档。 如果未指定，则默认为空文档。 从 MongoDB 3.6.14(和 3.4.23)开始，如果查询参数不是文档，则操作错误。
|
update
|
document
|
更新文件。 必须仅包含更新 operators。
|
projection
|
document
|
可选的。 return 的字段子集。 要_返回返回文档中的所有字段，请省略此参数。 从 MongoDB 3.6.14(和 3.4.23)开始，如果投影参数不是文档，则操作错误。
|
sort
|
document
|
可选的。为
filter
匹配的文档指定排序 order。 从 MongoDB 3.6.14(和 3.4.23)开始，如果 sort 参数不是文档，则操作错误。 见cursor.sort()。
|
maxTimeMS
|
number
|
可选的。指定操作必须在其中完成的 time 限制(以毫秒为 单位)。如果超出限制则引发错误。
|
upsert
|
boolean
|
可选的。当
true
，findOneAndUpdate()时： 如果没有文件匹配
filter
，则创建一个新文档。有关详细信息，请参阅upsert 行为。插入新文档后返回
null
，除非
returnNewDocument
是
true
。 更新与
filter
匹配的单个文档。 要避免多次 upsert，请确保
filter
字段为唯一索引。 默认为
false
。
|
returnNewDocument
|
boolean
|
可选的。当
true
时，返回更新的文档而不是原始文档。 默认为
false
。
|
collation
|
document
|
可选的。 指定要用于操作的整理。 整理允许用户为 string 比较指定 language-specific 规则，例如字母和重音标记的规则。 排序规则选项具有以下语法： 排序规则：{ locale：<string>， caseLevel：<boolean>， caseFirst：<string>， strength：<int>， numericOrdering：<boolean>， alternate：<string>， maxVariable：<string>， backwards ：<boolean> } 指定排序规则时，
locale
字段是必填字段;所有其他校对字段都是可选的。有关字段的说明，请参阅整理文件。 如果未指定排序规则但集合具有默认排序规则(请参阅db.createCollection())，则操作将使用为集合指定的排序规则。 如果没有为集合或操作指定排序规则，MongoDB 使用先前版本中用于 string 比较的简单二进制比较。 您无法为操作指定多个排序规则。对于 example，您不能为每个字段指定不同的排序规则，或者如果使用排序执行查找，则不能对查找使用一个排序规则，而对排序使用另一个排序规则。 version 3.4 中的新内容。
|
arrayFilters
|
array
|
可选的。过滤器文档的 array，用于确定要在 array 字段上为更新操作修改哪些 array 元素。 在更新文档中，使用$ [<identifier>]过滤后的位置 operator 来定义标识符，然后在 array 过滤器文档中进行 reference。如果标识符未包含在更新文档中，则不能为标识符提供 array 过滤器文档。
注意
<identifier>
必须以小写字母开头，并且只包含字母数字字符。 您可以在更新文档中多次包含相同的标识符;但是，对于更新文档中的每个不同标识符(
$[identifier]
)，您必须指定
恰好一个
对应的 array 过滤器文档。也就是说，您不能为同一标识符指定多个 array 过滤器文档。对于 example，如果 update 语句包含标识符
x
(可能多次)，则不能为
arrayFilters
指定以下内容，其中包含 2 个单独的
x
过滤器文档： // INVALID [ { "x.a": { $gt: 85 } }, { "x.b": { $gt: 80 } } ] 但是，您可以在同一标识符上指定复合条件单个过滤器文档，例如以下示例： // Example 1 [ { $or: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] } ] // Example 2 [ { $and: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] } ] // Example 3 [ { "x.a": { $gt: 85 }, "x.b": { $gt: 80 } } ] 例如，请参阅为 Array Update Operations 指定 arrayFilters。 version 3.6 中的新内容。
|
|
返回：
|
返回原始文档，如果是
returnNewDocument: true
，则返回更新的文档。
|
findOneAndUpdate()更新集合中与
filter
匹配的第一个匹配文档。
sort
参数可用于影响更新的文档。
projection
参数采用以下形式的文档：
{ field1 : < boolean >, field2 : < boolean> ... }
<boolean>
value 可以是以下任何一种：
-
1或true包括该字段。即使未在投影参数中明确说明，该方法也会返回_id字段。 -
0或false排除该字段。这可以在任何字段上使用，包括_id。
要
db.collection.findOneAndUpdate()
在分片集合上使用，查询过滤器必须在分片键上包含相等条件。
从MongoDB 4.2开始，您可以更新文档的分片键值，除非分片键字段是不可变
_id
字段。有关更新分片键的详细信息，请参见更改文档的分片键值。
在MongoDB 4.2之前，文档的分片键字段值是不可变的。
要用于
db.collection.findOneAndUpdate()
更新分片键：
-
您 必须 在运行
mongos无论是在 事务或作为重试写。千万 不能 直接在碎片颁发运行。 -
您 必须 在查询过滤器的完整分片键上包含相等条件。例如，如果一个集合
messages使用的片键，更新为一个文件的碎片关键，你必须包括在查询过滤器。您可以根据需要在查询中包括其他字段。{ country : 1, userid : 1 }``country: <value>, userid: <value>
db.collection.findOneAndUpdate()
可以在多文档交易中使用。
重要在大多数情况下，与单文档写入相比，多文档事务产生的性能成本更高，并且多文档事务的可用性不应替代有效的架构设计。在许多情况下， 非规范化数据模型（嵌入式文档和数组）将继续是您的数据和用例的最佳选择。也就是说，在许多情况下，适当地对数据建模将最大程度地减少对多文档交易的需求。有关其他事务使用方面的注意事项（例如运行时限制和操作日志大小限制），另请参见 生产注意事项。
在事务内部，您可以指定对现有集合的读/写操作。如果
db.collection.findOneAndUpdate()
导致upsert，则该集合必须已经存在。
如果该操作导致upsert，则该集合必须已经存在。