db.collection.update()
重要
已弃用的 mongosh 方法
此方法在 mongosh
中已弃用。有关替代方法,请参阅与旧版 mongo Shell 的兼容性更改。
定义
db.collection.update(query, update, options)
修改集合中的一个或多个现有文档。该方法可以修改现有文档的特定字段,或者完全替换现有文档,具体取决于更新参数。
默认情况下,
db.collection.update()
方法更新单个文档。包含选项multi: true以更新与查询条件匹配的所有文档。
兼容性
可以使用 db.collection.update()
查找托管在以下环境中的部署:
MongoDB Atlas :用于在云中部署 MongoDB 的完全托管服务
MongoDB Enterprise:基于订阅、自我管理的 MongoDB 版本
MongoDB Community:源代码可用、免费使用且可自行管理的 MongoDB 版本
要了解如何使用 Atlas 用户界面更新 MongoDB Atlas 中托管的文档,请参阅编辑单个文档。
语法
5.0 版本中的更改。
db.collection.update()
方法采用以下形式:
db.collection.update( <query>, <update>, { upsert: <boolean>, multi: <boolean>, writeConcern: <document>, collation: <document>, arrayFilters: [ <filterdocument1>, ... ], hint: <document|string>, let: <document> // Added in MongoDB 5.0 } )
参数
db.collection.update()
方法采用以下参数:
范围 | 类型 | 说明 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
文档 | ||||||||||
文档或管道 | 要应用的修改。可以是以下之一:
有关详细信息和示例,请参阅Oplog 条目。 | |||||||||
布尔 | ||||||||||
布尔 | 可选。如果设为 | |||||||||
文档 | ||||||||||
文档 | ||||||||||
阵列 | 选修的。大量过滤器文档,用于确定针对大量字段的更新操作要修改哪些大量元素。 在更新文档中,使用 注意如果更新文档中未包含某一标识符,则无法获得该标识符的数组筛选文档。 有关示例,请参阅为数组更新操作指定 | |||||||||
文档或字符串 | 可选。指定用于支持 查询谓词 的 索引 的文档或字符串。 该选项可以采用索引规范文档或索引名称字符串。 如果指定不存在的索引,则操作出错。 有关示例,请参阅为更新操作指定 | |||||||||
文档 | 可选。 指定包含变量列表的文档。这样可以将变量与查询文本分开,从而提高命令的可读性。 文档语法为:
变量设置为表达式返回的值,并且之后不能再进行更改。 要访问命令中的变量值,请使用双美元符号前缀 ( 注意要使用变量筛选结果,您必须在 有关使用 版本 5.0 中的新增功能。 |
返回:
该方法返回包含操作状态的 WriteResult 文档。
访问控制
在使用 authorization
运行的部署中,用户必须具有包含以下特权的访问权限:
内置角色readWrite
提供所需的特权。
行为
在使用 Upsert
进行更新中使用 $expr
尝试在将 upsert 标志设置为true
的情况下使用$expr操作符会产生错误。
分片集合
要在分片集合上将db.collection.update()
与multi: false
一起使用,必须在_id
字段中包含精确匹配项或定位单个分片(例如通过包含分片键)。
当db.collection.update()
执行更新操作(而非文档替换操作)时, db.collection.update()
可以定位多个分片。
提示
另请参阅:
分片集合上的替换文档操作
替换文档操作首先尝试使用查询筛选器定位单个分片。如果该操作无法通过查询筛选器定位单个分片,则会尝试通过替换文档定位。
在早期版本中,该操作会尝试使用替换文档定位。
upsert
分片集合
对于包含db.collection.update()
upsert: true 且针对分片集合的 操作,您必须在 中包含完整的分片键:filter
用于更新操作。
用于替换文档操作。
但是,collection中的文档可能会缺少分片键字段。要定位缺少分片键的文档,可以将null
等值匹配与另一个筛选条件(例如针对_id
字段)结合使用。例如:
{ _id: <value>, <shardkeyfield>: null } // _id of the document missing shard key
分片键修改
您可以更新文档的分片键值,除非分片键字段是不可变的_id
字段。
要使用 修改 现有 分片键值:db.collection.update()
提示
由于缺失的键值是作为 null 相等匹配的一部分返回的,因此为避免更新空值键,请酌情纳入其他查询条件(例如 _id
字段)。
另请参阅分片集合上的upsert
。
缺少分片键
分片集合中的文档可能缺少分片键字段。要使用db.collection.update()
设置文档缺失的分片键,必须在mongos
上运行。请勿直接对分片发出此操作。
此外,以下要求也适用:
提示
由于缺失的键值是作为 null 相等匹配的一部分返回的,因此为避免更新空值键,请酌情纳入其他查询条件(例如 _id
字段)。
另请参阅:
事务
db.collection.update()
可以在分布式事务中使用。
重要
在大多数情况下,与单文档写入操作相比,分布式事务会产生更高的性能成本,并且分布式事务的可用性不应取代有效的模式设计。在许多情况下,非规范化数据模型(嵌入式文档和数组)仍然是数据和使用案例的最佳选择。换言之,对于许多场景,适当的数据建模将最大限度地减少对分布式事务的需求。
有关其他事务使用注意事项(如运行时间限制和 oplog 大小限制),另请参阅生产注意事项。
在 ACID 事务中进行更新或插入 (upsert)
如果分布式事务不是跨分片写入事务,则可以在该事务中创建集合和索引。
db.collection.update()
和upsert: true
可以在现有集合或不存在的集合上运行。如果在不存在的集合上运行,该操作将创建该集合。
提示
另请参阅:
写关注和事务
如果是在事务中运行,则请勿显式设置此操作的写关注。要将写关注与事务一起使用,请参阅事务和写关注。
Oplog 条目
如果db.collection.update()
操作成功更新一个或多个文档,该操作则会在oplog (操作日志)上添加一个条目。如果操作失败或找不到任何要更新的文档,则不会在 oplog 上添加条目。
举例
以下标签页展示了各种常见的update()
操作。
在mongosh
中,创建包含以下文档的books
集合。此命令首先从books
集合中删除所有以前存在的文档:
db.books.remove({}); db.books.insertMany([ { "_id" : 1, "item" : "TBD", "stock" : 0, "info" : { "publisher" : "1111", "pages" : 430 }, "tags" : [ "technology", "computer" ], "ratings" : [ { "by" : "ijk", "rating" : 4 }, { "by" : "lmn", "rating" : 5 } ], "reorder" : false }, { "_id" : 2, "item" : "XYZ123", "stock" : 15, "info" : { "publisher" : "5555", "pages" : 150 }, "tags" : [ ], "ratings" : [ { "by" : "xyz", "rating" : 5 } ], "reorder" : false } ]);
在不存在匹配项时插入一个新文档 (Upsert
)
当您指定选项upsert: true 时:
如果文档与查询条件匹配,
db.collection.update()
则会执行更新。如果没有符合查询条件的文档,则
db.collection.update()
会插入单个文档。注意
如果大致在同一时间发出多个相同的upsert ,则将
update()
与upsert: true一起使用时可能会创建重复的文档。有关详细信息,请参阅使用重复值进行更新或插入。
如果您在分片集合上指定upsert: true
,则必须在filter
中包含完整的分片键。有关分片集合上的其他db.collection.update()
行为,请参阅分片集合。
以下标签页展示了upsert
修饰符和update()
的各种用法。
使用重复值进行更新或插入
除非有唯一索引来防止重复,否则 upsert 可能会创建重复的文档。
以某一情况为例,其中不存在名为 Andy
的文档,且多个客户端大致会在同一时间发出以下命令:
db.people.update( { name: "Andy" }, { $inc: { score: 1 } }, { upsert: true, multi: true } )
如果所有update()
操作在任何客户端成功插入数据之前完成查询阶段,并且name
字段上没有唯一索引,则每个update()
操作都可能导致插入,从而使用name: Andy
创建多个文档。
name
字段上的唯一索引可确保只创建一个文档。使用唯一索引后,多个update()
操作现在会表现出以下行为:
仅需一个
update()
操作即可成功插入新文档。其他
update()
操作要么更新新插入的文档,要么由于唯一键冲突而失败。为了使其他
update()
操作能够更新新插入的文档,必须满足以下所有条件:目标collection具有会导致重复键错误的唯一索引。
更新操作不是
updateMany
或multi
是false
。更新匹配条件为:
单个相等谓词。例如
{ "fieldA" : "valueA" }
等式谓词的逻辑 AND。例如
{ "fieldA" : "valueA", "fieldB" : "valueB" }
相等谓词中的字段与唯一索引键模式中的字段匹配。
更新操作不会修改唯一索引键模式中的任何字段。
下表显示了upsert
操作的示例,当发生键冲突时,这些操作要么导致更新,要么失败。
唯一索引键模式 | 更新操作 | 结果 | ||||||
---|---|---|---|---|---|---|---|---|
|
| 匹配文档的 score 字段递增 1。 | ||||||
|
| 操作失败是因为它修改了唯一索引键模式 ( name ) 中的字段。 | ||||||
|
| 操作失败,因为等值谓词字段( name 、 email )与索引键字段( name )不匹配。 |
提示
另请参阅:
使用聚合管道进行更新
db.collection.update()
方法可接受指定要执行的修改的聚合管道[ <stage1>, <stage2>, ... ]
。该管道可以由以下阶段组成:
$addFields
及其别名$set
使用聚合分析管道可以进行更具表现力的更新声明,例如基于当前字段值的Express条件更新或使用另一个字段的值更新一个字段。
使用文档中其他字段的值修改字段
使用以下文档创建 students
集合:
db.students.insertMany( [ { "_id" : 1, "student" : "Skye", "points" : 75, "commentsSemester1" : "great at math", "commentsSemester2" : "loses temper", "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }, { "_id" : 2, "students" : "Elizabeth", "points" : 60, "commentsSemester1" : "well behaved", "commentsSemester2" : "needs improvement", "lastUpdate" : ISODate("2019-01-01T00:00:00Z") } ] )
假设您不想将 commentsSemester1
和 commentsSemester2
字段分开,而是将它们收集到新的 comments
字段中。以下更新操作使用聚合管道:
添加新的
comments
字段并设置lastUpdate
字段。删除集合中所有文档的
commentsSemester1
和commentsSemester2
字段。
db.members.update( { }, [ { $set: { comments: [ "$commentsSemester1", "$commentsSemester2" ], lastUpdate: "$$NOW" } }, { $unset: [ "commentsSemester1", "commentsSemester2" ] } ], { multi: true } )
执行该命令之后,集合中将包含以下文档:
{ "_id" : 1, "student" : "Skye", "status" : "Modified", "points" : 75, "lastUpdate" : ISODate("2020-01-23T05:11:45.784Z"), "comments" : [ "great at math", "loses temper" ] } { "_id" : 2, "student" : "Elizabeth", "status" : "Modified", "points" : 60, "lastUpdate" : ISODate("2020-01-23T05:11:45.784Z"), "comments" : [ "well behaved", "needs improvement" ] }
提示
另请参阅:
根据当前字段值执行条件更新
使用以下文档创建 students3
集合:
db.students3.insertMany( [ { "_id" : 1, "tests" : [ 95, 92, 90 ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }, { "_id" : 2, "tests" : [ 94, 88, 90 ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") }, { "_id" : 3, "tests" : [ 70, 75, 82 ], "lastUpdate" : ISODate("2019-01-01T00:00:00Z") } ] )
使用聚合分析管道,您可以使用计算出的平均成绩和字母等级来更新文档。
db.students3.update( { }, [ { $set: { average : { $trunc: [ { $avg: "$tests" }, 0 ] }, lastUpdate: "$$NOW" } }, { $set: { grade: { $switch: { branches: [ { case: { $gte: [ "$average", 90 ] }, then: "A" }, { case: { $gte: [ "$average", 80 ] }, then: "B" }, { case: { $gte: [ "$average", 70 ] }, then: "C" }, { case: { $gte: [ "$average", 60 ] }, then: "D" } ], default: "F" } } } } ], { multi: true } )
执行该命令之后,集合中将包含以下文档:
{ "_id" : 1, "tests" : [ 95, 92, 90 ], "lastUpdate" : ISODate("2020-01-24T17:29:35.340Z"), "average" : 92, "grade" : "A" } { "_id" : 2, "tests" : [ 94, 88, 90 ], "lastUpdate" : ISODate("2020-01-24T17:29:35.340Z"), "average" : 90, "grade" : "A" } { "_id" : 3, "tests" : [ 70, 75, 82 ], "lastUpdate" : ISODate("2020-01-24T17:29:35.340Z"), "average" : 75, "grade" : "C" }
提示
另请参阅:
为数组更新操作指定arrayFilters
在更新文档中,使用 $[<identifier>]
筛选后的位置运算符来定义标识符,然后在数组筛选文档中引用该标识符。如果更新文档中未包含某一标识符,则无法获得该标识符的数组筛选文档。
注意
<identifier>
必须以小写字母开头,且只能包含字母数字字符。
您可以在更新文档中多次包含相同的标识符;但对于更新文档中的每个不同标识符 ($[identifier]
),您必须准确指定一个对应的数组筛选器文档。也就是说,不能为同一个标识符指定多个数组筛选器文档。例如,如果更新语句包含标识符 x
(可能多次),则不能为 arrayFilters
指定以下内容,其中包括 x
的 2 个单独的筛选器文档:
// 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
不适用于使用聚合管道的更新。
更新元素匹配 arrayFilters
条件
要更新符合指定条件的所有数组元素,请使用 arrayFilters 参数。
在mongosh
中,使用以下文档创建students
集合:
db.students.insertMany( [ { "_id" : 1, "grades" : [ 95, 92, 90 ] }, { "_id" : 2, "grades" : [ 98, 100, 102 ] }, { "_id" : 3, "grades" : [ 95, 110, 100 ] } ] )
要更新 grades
数组中大于或等于 100
的所有元素,请使用带有 arrayFilters
选项的筛选位置运算符 $[<identifier>]
:
db.students.update( { grades: { $gte: 100 } }, { $set: { "grades.$[element]" : 100 } }, { multi: true, arrayFilters: [ { "element": { $gte: 100 } } ] } )
操作完成后,集合包含以下文档:
{ "_id" : 1, "grades" : [ 95, 92, 90 ] } { "_id" : 2, "grades" : [ 98, 100, 100 ] } { "_id" : 3, "grades" : [ 95, 100, 100 ] }
更新文档数组的特定元素
还可以使用 arrayFilters 参数更新文档数组中的特定文档字段。
在mongosh
中,使用以下文档创建students2
集合:
db.students2.insertMany( [ { "_id" : 1, "grades" : [ { "grade" : 80, "mean" : 75, "std" : 6 }, { "grade" : 85, "mean" : 90, "std" : 4 }, { "grade" : 85, "mean" : 85, "std" : 6 } ] }, { "_id" : 2, "grades" : [ { "grade" : 90, "mean" : 75, "std" : 6 }, { "grade" : 87, "mean" : 90, "std" : 3 }, { "grade" : 85, "mean" : 85, "std" : 4 } ] } ] )
要修改 grades
数量中等级大于或等于 85
的所有元素的 mean
字段的值,请将过滤后的位置操作符 $[<identifier>]
与 arrayFilters
结合使用:
db.students2.update( { }, { $set: { "grades.$[elem].mean" : 100 } }, { multi: true, arrayFilters: [ { "elem.grade": { $gte: 85 } } ] } )
操作完成后,集合有以下文档:
{ "_id" : 1, "grades" : [ { "grade" : 80, "mean" : 75, "std" : 6 }, { "grade" : 85, "mean" : 100, "std" : 4 }, { "grade" : 85, "mean" : 100, "std" : 6 } ] } { "_id" : 2, "grades" : [ { "grade" : 90, "mean" : 100, "std" : 6 }, { "grade" : 87, "mean" : 100, "std" : 3 }, { "grade" : 85, "mean" : 100, "std" : 4 } ] }
为更新操作指定 hint
在mongosh
中,使用以下文档创建newStudents
集合:
db.newStudents.insertMany( [ { "_id" : 1, "student" : "Richard", "grade" : "F", "points" : 0, "comments1" : null, "comments2" : null }, { "_id" : 2, "student" : "Jane", "grade" : "A", "points" : 60, "comments1" : "well behaved", "comments2" : "fantastic student" }, { "_id" : 3, "student" : "Ronan", "grade" : "F", "points" : 0, "comments1" : null, "comments2" : null }, { "_id" : 4, "student" : "Noah", "grade" : "D", "points" : 20, "comments1" : "needs improvement", "comments2" : null }, { "_id" : 5, "student" : "Adam", "grade" : "F", "points" : 0, "comments1" : null, "comments2" : null }, { "_id" : 6, "student" : "Henry", "grade" : "A", "points" : 86, "comments1" : "fantastic student", "comments2" : "well behaved" } ] )
在集合上创建以下索引:
db.newStudents.createIndex( { grade: 1 } )
以下更新操作明确提示使用索引{grade: 1 }
:
db.newStudents.update( { points: { $lte: 20 }, grade: "F" }, // Query parameter { $set: { comments1: "failed class" } }, // Update document { multi: true, hint: { grade: 1 } } // Options )
注意
如果指定不存在的索引,则操作出错。
更新命令返回以下内容:
WriteResult({ "nMatched" : 3, "nUpserted" : 0, "nModified" : 3 })
要查看使用的索引,请对操作运行 explain
:
db.newStudents.explain().update( { "points": { $lte: 20 }, "grade": "F" }, { $set: { "comments1": "failed class" } }, { multi: true, hint: { grade: 1 } } )
使用以下项中的变量: let
版本 5.0 中的新增功能。
要定义可在命令中其他位置访问的变量,请使用 let 选项。
注意
要使用变量筛选结果,您必须在 $expr
操作符中访问该变量。
创建集合 cakeFlavors
:
db.cakeFlavors.insertMany( [ { _id: 1, flavor: "chocolate" }, { _id: 2, flavor: "strawberry" }, { _id: 3, flavor: "cherry" } ] )
以下示例在 let
中定义了 targetFlavor
和 newFlavor
变量,并使用这些变量将蛋糕口味从樱桃更改为橙子:
db.cakeFlavors.update( { $expr: { $eq: [ "$flavor", "$$targetFlavor" ] } }, [ { $set: { flavor: "$$newFlavor" } } ], { let : { targetFlavor: "cherry", newFlavor: "orange" } } )
覆盖默认写关注
以下对副本集的操作指定了写关注 w: 2
,其 wtimeout
为 5000 毫秒。该操作要么在写操作传播到主节点和一个辅助节点后返回,要么在 5 秒后超时。
db.books.update( { stock: { $lte: 10 } }, { $set: { reorder: true } }, { multi: true, writeConcern: { w: 2, wtimeout: 5000 } } )
指定排序规则。
指定用于操作的排序规则。
排序规则允许用户为字符串比较指定特定于语言的规则,例如字母大小写和重音符号规则。
排序规则选项的语法如下:
collation: { locale: <string>, caseLevel: <boolean>, caseFirst: <string>, strength: <int>, numericOrdering: <boolean>, alternate: <string>, maxVariable: <string>, backwards: <boolean> }
指定排序规则时,locale
字段为必填字段;所有其他排序规则字段均为可选字段。有关字段的说明,请参阅排序规则文档。
如果未指定排序规则,但集合具有默认排序规则(请参阅 db.createCollection()
),则操作将使用为集合指定的排序规则。
如果没有为收集或操作指定排序规则,MongoDB 将使用先前版本中使用的简单二进制比较来进行字符串比较。
您不能为一个操作指定多个排序规则。例如,您不能为每个字段指定不同的排序规则,或者如果执行带排序的查找,则不能使用一种排序规则进行查找而另一种排序规则进行排序。
在mongosh
中,使用以下文档创建名为myColl
的集合:
db.myColl.insertMany( [ { _id: 1, category: "café", status: "A" }, { _id: 2, category: "cafe", status: "a" }, { _id: 3, category: "cafE", status: "a" } ] )
以下操作包括排序规则选项,并将 multi
设置为 true
,以更新所有匹配的文档:
db.myColl.update( { category: "cafe" }, { $set: { status: "Updated" } }, { collation: { locale: "fr", strength: 1 }, multi: true } )
操作的写入结果返回以下文档,指示集合中的所有三个文档均已更新:
WriteResult({ "nMatched" : 3, "nUpserted" : 0, "nModified" : 3 })
操作完成后,集合包含以下文档:
{ "_id" : 1, "category" : "café", "status" : "Updated" } { "_id" : 2, "category" : "cafe", "status" : "Updated" } { "_id" : 3, "category" : "cafE", "status" : "Updated" }
WriteResult
成功结果
db.collection.update()
方法返回一个包含操作状态的WriteResult()
对象。成功后, WriteResult()
对象将包含符合查询条件的文档数、更新插入的文档数以及修改的文档数:
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1 })
写关注错误
如果db.collection.update()
方法遇到写关注错误,结果将包括WriteResult.writeConcernError
字段:
WriteResult({ "nMatched" : 1, "nUpserted" : 0, "nModified" : 1, "writeConcernError": { "code" : 64, "errmsg" : "waiting for replication timed out", "errInfo" : { "wtimeout" : true, "writeConcern" : { "w" : "majority", "wtimeout" : 100, "provenance" : "getLastErrorDefaults" } } })
下表解释了 WriteResult.writeConcernError.provenance
的可能值:
来源 | 说明 |
---|---|
clientSupplied | 应用程序中指定了写关注。 |
customDefault | 写入关注源自自定义的默认值。请参阅 setDefaultRWConcern 。 |
getLastErrorDefaults | 写关注源自副本集的 settings.getLastErrorDefaults 字段。 |
implicitDefault | 在没有所有其他写入关注规范的情况下,写入关注源自服务器。 |
与写关注无关的错误
如果db.collection.update()
方法遇到非写关注错误,结果将包括WriteResult.writeError
字段:
WriteResult({ "nMatched" : 0, "nUpserted" : 0, "nModified" : 0, "writeError" : { "code" : 7, "errmsg" : "could not contact primary for replica set shard-a" } })