db.collection.updateOne（）

MongoDB 中文手册

参考 > 参考 > mongo Shell方法 > 收集方法 > db.collection.updateOne（）

在本页面

定义
句法
访问控制
行为
例子

定义¶

db.collection.updateOne（filter，update，options ）¶: mongo 壳法

此页面记录了mongoshell方法，并且没有引用MongoDB Node.js驱动程序（或任何其他驱动程序）方法。对于相应的MongoDB驱动程序API，请改为参考您特定的 MongoDB驱动程序文档。

3.2版中的新功能。

根据过滤器更新集合中的单个文档。

语法¶

该updateOne()方法具有以下语法：

复制

db.collection.updateOne(
   <filter>,
   <update>,
   {
     upsert: <boolean>,
     writeConcern: <document>,
     collation: <document>,
     arrayFilters: [ <filterdocument1>, ... ],
     hint:  <document|string>        // Available starting in MongoDB 4.2.1
   }
)

参数¶

该db.collection.updateOne()方法采用以下参数：

参数类型描述

过滤

文献

更新的选择标准。提供与方法中相同的查询选择器 find()。

指定一个空文档以更新集合中返回的第一个文档。{ }

更新

文件或管道

要应用的修改。可以是以下之一：

更新文件	仅包含更新运算符表达式。有关更多信息，请参见使用更新运算符表达式文档进行更新。
聚合管道（从MongoDB 4.2开始）	仅包含以下聚合阶段： `$addFields` 及其别名 `$set` `$project` 及其别名 `$unset` `$replaceRoot`及其别名`$replaceWith`。有关更多信息，请参见使用聚合管道更新。

要使用替换文档进行更新，请参阅 db.collection.replaceOne()。

upsert

布尔值

可选的。当true，updateOne()要么：

如果没有文档与匹配，则创建一个新文档filter。有关更多详细信息，请参见upsert行为。
更新与匹配的单个文档filter。

为避免多次更新，请确保filter字段被唯一索引。

默认为false。

writeConcern

文献

可选的。表达书面关切的文件。省略使用默认的写关注。

如果在事务中运行，则不要为操作明确设置写关注点。要对事务使用写关注，请参见事务和写关注。

collation

文献

可选的。

指定用于操作的排序规则。

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

排序规则选项具有以下语法：

复制

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

指定排序规则时，该locale字段为必填字段；所有其他排序规则字段都是可选的。有关字段的说明，请参见整理文档。

如果未指定排序规则，但是集合具有默认排序规则（请参阅参考资料db.createCollection()），则该操作将使用为集合指定的排序规则。

如果没有为集合或操作指定排序规则，则MongoDB使用先前版本中使用的简单二进制比较进行字符串比较。

您不能为一个操作指定多个排序规则。例如，您不能为每个字段指定不同的排序规则，或者如果对排序执行查找，则不能对查找使用一种排序规则，而对排序使用另一种排序规则。

3.4版的新功能。

arrayFilters

数组

可选的。筛选器文档数组，用于确定要对数组字段进行更新操作要修改的数组元素。

在更新文档中，使用$[<identifier>]过滤后的位置运算符定义一个标识符，然后在数组过滤器文档中引用该标识符。如果该标识符未包含在更新文档中，则不能具有标识符的数组过滤器文档。

注意

在<identifier>必须以小写字母开头，并且只包含字母数字字符。

您可以在更新文档中多次包含相同的标识符；但是，对于$[identifier]更新文档中的每个不同的标识符（），必须精确地指定一个对应的数组过滤器文档。也就是说，您不能为同一标识符指定多个数组过滤器文档。例如，如果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 } }
]

有关示例，请参阅为数组更新操作指定arrayFilters。

3.6版的新功能。

暗示

文件或字串

可选的。指定用于支持查询谓词的索引的文档或字符串。

该选项可以采用索引规范文档或索引名称字符串。

如果指定的索引不存在，则操作错误。

有关示例，请参阅为更新操作指定提示。

4.2.1版中的新功能。

返回¶

该方法返回包含以下内容的文档：

matchedCount 包含匹配文件的数量
modifiedCount 包含修改后的文件数
upsertedId包含_id上色文档的。
一个布尔值acknowledged，就true好像该操作在运行时带有写关注关系或false是否禁用了写关注关系

访问控制¶

在运行时authorization，用户必须具有包括以下特权的访问权限：

update 对指定集合的操作。
find 对指定集合的操作。
insert 如果操作导致更新，则对指定的集合执行操作。

内置角色readWrite提供所需的特权。

行为¶

更新单个文件¶

db.collection.updateOne()查找与过滤器匹配的第一个文档，并应用指定的更新修改。

使用更新运算符表达式文档进行更新¶

对于更新规范，该 db.collection.updateOne()方法可以接受仅包含更新运算符表达式的文档。

例如：

db.collection.updateOne(
   <query>,
   { $set: { status: "D" }, $inc: { quantity: 2 } },
   ...
)

使用聚合管道进行更新¶

从MongoDB 4.2开始，该db.collection.updateOne()方法可以接受指定要执行的修改的聚合管道。管道可以包括以下阶段：[ <stage1>, <stage2>, ... ]

$addFields 及其别名 $set
$project 及其别名 $unset
$replaceRoot及其别名$replaceWith。

使用聚合管道可以实现更具表达力的更新语句，例如根据当前字段值表达条件更新，或使用另一个字段的值更新一个字段。

例如：

db.collection.updateOne(
   <query>,
   [
      { $set: { status: "Modified", comments: [ "$misc1", "$misc2" ] } },
      { $unset: [ "misc1", "misc2" ] }
   ]
   ...
)

注意

该$set和$unset在管道中是指聚集阶段$set，并$unset 分别，而不是更新的运营商$set和$unset。

有关示例，请参见使用聚合管道更新。

UPSERT ¶

如果和没有文档匹配，则根据条件和修改创建一个新文档。请参阅使用Upsert更新。upsert: truefilterdb.collection.updateOne()filterupdate

如果在分片集合上指定，则必须在filter中包括完整的分片键。有关分片集合的其他行为，请参见分片集合。upsert: truedb.collection.updateOne()

封顶收藏¶

如果更新操作更改了文档大小，则该操作将失败。

分片集合¶

要db.collection.updateOne()在分片集合上使用：

如果未指定，则必须在字段上包括完全匹配项或将目标指定为单个分片（例如，通过在过滤器中包含分片键）。upsert: true_id
如果指定，则过滤器必须包含分片键。upsert: true

碎片键修改¶

从MongoDB 4.2开始，除非分片键字段是不可变_id字段，否则您可以更新文档的分片键值。有关更新分片键的详细信息，请参阅“ 更改文档的分片键值”。

在MongoDB 4.2之前，文档的分片键字段值是不可变的。

要用于db.collection.updateOne()更新分片键：

您必须在运行mongos无论是在交易或作为重试写。千万不能直接在碎片颁发运行。
您必须在查询过滤器中的完整分片键上包含相等条件。例如，如果一个集合messages 使用的片键，更新为一个文件的碎片关键，你必须包括在查询过滤器。您可以根据需要在查询中包括其他字段。{ country : 1, userid : 1 }country: <value>, userid: <value>

可解释性¶

updateOne()与不兼容 db.collection.explain()。

使用update()代替。

交易¶

db.collection.updateOne()可以在多文档交易中使用。

重要

在大多数情况下，与单文档写入相比，多文档事务产生的性能成本更高，并且多文档事务的可用性不应代替有效的架构设计。在许多情况下，非规范化数据模型（嵌入式文档和数组）对于您的数据和用例将继续是最佳的。也就是说，在许多情况下，对数据进行适当的建模将最大程度地减少对多文档交易的需求。

有关其他事务使用方面的注意事项（例如运行时限制和oplog大小限制），另请参见生产注意事项。

现有的收藏和交易¶

在事务内部，您可以指定对现有集合的读/写操作。如果db.collection.updateOne()导致upsert，则该集合必须已经存在。

写的担忧和事务¶

如果在事务中运行，则不要为操作明确设置写关注点。要对事务使用写关注，请参见事务和写关注。

例子¶

使用更新运算符表达式进行更新¶

该restaurant集合包含以下文档：

复制

{ "_id" : 1, "name" : "Central Perk Cafe", "Borough" : "Manhattan" },
{ "_id" : 2, "name" : "Rock A Feller Bar and Grill", "Borough" : "Queens", "violations" : 2 },
{ "_id" : 3, "name" : "Empire State Pub", "Borough" : "Brooklyn", "violations" : 0 }

以下操作将使用字段更新单个文档：name: "Central Perk Cafe"violations

复制

try {
   db.restaurant.updateOne(
      { "name" : "Central Perk Cafe" },
      { $set: { "violations" : 3 } }
   );
} catch (e) {
   print(e);
}

该操作返回：

复制

{ "acknowledged" : true, "matchedCount" : 1, "modifiedCount" : 1 }

如果未找到匹配项，则该操作返回：

复制

{ "acknowledged" : true, "matchedCount" : 0, "modifiedCount" : 0 }

如果找不到匹配项，则设置将插入文档。请参阅使用Upsert更新upsert: true

使用聚合管道更新¶

从MongoDB 4.2开始，db.collection.updateOne()可以使用聚合管道进行更新。管道可以包括以下阶段：

$addFields 及其别名 $set
$project 及其别名 $unset
$replaceRoot及其别名$replaceWith。

使用聚合管道可以实现更具表达力的更新语句，例如根据当前字段值表达条件更新，或使用另一个字段的值更新一个字段。

实施例1 ¶

以下示例使用聚合管道使用文档中其他字段的值来修改字段。

members使用以下文档创建一个集合：

复制

db.members.insertMany([
    { "_id" : 1, "member" : "abc123", "status" : "A", "points" : 2, "misc1" : "note to self: confirm status", "misc2" : "Need to activate", "lastUpdate" : ISODate("2019-01-01T00:00:00Z") },
    { "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60, comments: [ "reminder: ping me at 100pts", "Some random comment" ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }
])

假设，而不是独立的misc1，并misc2在第一文档中的字段，要收集这些成comments场，就像第二个文档。以下更新操作使用聚合管道执行以下操作：

添加新comments字段并设置该lastUpdate字段。
删除集合中所有文档的misc1和misc2字段。

复制

db.members.updateOne(
   { _id: 1 },
   [
      { $set: { status: "Modified", comments: [ "$misc1", "$misc2" ], lastUpdate: "$$NOW" } },
      { $unset: [ "misc1", "misc2" ] }
   ]
)

注意

该$set和$unset在管道中是指聚集阶段$set，并$unset 分别，而不是更新的运营商$set和$unset。

第一阶段

该$set阶段：

创建一个新的数组字段，comments其元素是misc1和misc2字段的当前内容，并且
将字段设置为lastUpdate聚合变量的值NOW。聚合变量 NOW解析为当前日期时间值，并且在整个管道中保持不变。要访问聚合变量，请在变量前加双美元符号$$ 并用引号引起来。

第二阶段

该$unset阶段将删除misc1和misc2字段。

命令后，集合包含以下文档：

复制

{ "_id" : 1, "member" : "abc123", "status" : "Modified", "points" : 2, "lastUpdate" : ISODate("2020-01-23T05:21:59.321Z"), "comments" : [ "note to self: confirm status", "Need to activate" ] }
{ "_id" : 2, "member" : "xyz123", "status" : "A", "points" : 60, "comments" : [ "reminder: ping me at 100pts", "Some random comment" ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }

示例2¶

聚合管道允许更新基于当前字段值执行条件更新，并使用当前字段值来计算单独的字段值。

例如，students3使用以下文档创建一个集合：

复制

db.students3.insert([
   { "_id" : 1, "tests" : [ 95, 92, 90 ], "average" : 92, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") },
   { "_id" : 2, "tests" : [ 94, 88, 90 ], "average" : 91, "grade" : "A", "lastUpdate" : ISODate("2020-01-23T05:18:40.013Z") },
   { "_id" : 3, "tests" : [ 70, 75, 82 ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }
]);

第三个文档缺少和字段。使用聚合管道，可以使用计算出的平均成绩和字母成绩更新文档。_id: 3averagegrade

复制

db 。学生3 。updateOne （
   {_  id ： 3  }，
   [ 
     {  $ set ： {  平均值： {  $ trunc ： [   {  $ avg ： “ $ tests”  }， 0  ]  }， lastUpdate ： “ $$ NOW”  }  }，
     {  $ set ： {  等级： {  $ switch ： { 
                           分支机构： [ 
                               {  案例： {  $ gte ： [ “ $ average” ， 90  ]  }， 然后： “ A” 