db.collection.update()
在本页面
定义
-
db.collection.
update
(查询,更新,选项)修改集合中的现有文档。该方法可以修改现有文档的特定字段或完全替换现有文档,具体取决于更新参数。
默认情况下,update()方法更新 单 文档。设置多参数
multi:true
以更新 match 查询条件的所有文档。
语法
db.collection.update()
方法具有以下形式:
参数
db.collection.update()
方法采用以下参数:
参数 | 类型 | 描述 |
---|---|---|
|
document |
更新的选择标准。提供与方法中相同的查询选择器
|
|
document or pipeline |
要应用的修改。可以是以下之一: 更新文件:仅包含更新运算符表达式 更新文件:仅包含键值对
|
|
boolean |
可选的。如果设置为
|
|
boolean |
可选的。如果设置为
|
|
document |
可选的。表示写关注的文件。省略使用默认写入问题。w: 1 如果在事务中运行,请不要为操作明确设置写关注点。要对事务使用写关注,请参见 事务和写关注。 有关使用的示例
|
|
document |
可选的。 排序规则允许用户为字符串比较指定特定于语言的规则,例如字母大写和重音符号的规则。 有关使用的示例
|
|
array |
可选的。过滤器文档数组,用于确定要在数组 字段上为更新操作修改的数组元素。 在更新文档中,使用$ [<identifier>]来定义标识符,仅更新那些与arrayFilters中相应的filter文档相匹配的数组元素。 注意 如果更新文档中未包含标识符,则不能具有数组过滤器文档作为标识符。 有关示例,请参阅为数组更新操作指定arrayFilters。 version 3.6 中的新内容。 |
hint |
document or string |
可选的。一个文档或字符串,它指定用于支持查询谓词的索引。 该选项可以采用索引规范文档或索引名称字符串。 如果指定的索引不存在,则操作错误。 有关示例,请参见为更新操作指定提示。 4.2版中的新功能。 |
返回: |
该方法返回包含操作状态的WriteResult文档。 |
访问控制
在运行时
authorization
,用户必须具有包括以下特权的访问权限:
-
update
对指定集合的操作。 -
find
对指定集合的操作。 -
insert
如果操作导致更新,则对指定的集合执行操作。
内置角色
readWrite
提供所需的特权。
行为
分片集合
db.collection.update()
要与分片集合一起使用,必须在 字段上包括完全匹配项或将目标设为单个分片(例如:通过包含分片键)。
multi: false_id
当
db.collection.update()
执行更新操作(而不是文档替换操作)时,
db.collection.update()
可以针对多个分片。
也可以看看
findAndModify()
替换分片集合上的文档操作
从MongoDB 4.2开始,替换文档操作首先尝试使用查询过滤器来针对单个分片。如果该操作无法通过查询过滤器定位到单个分片,则它将尝试以替换文档定位。
在早期版本中,该操作尝试使用替换文档作为目标。
upsert
在分片集合上
upsert
在分片集合上
对于
db.collection.update()
包含
upsert:true
且位于分片集合上的操作,您必须在中包含完整的分片键
filter
:
-
用于更新操作。
-
用于替换文档操作(从MongoDB 4.2开始)。
碎片键修改
从MongoDB 4.2开始,您可以更新文档的分片键值,除非分片键字段是不可变
_id
字段。有关更新分片键的详细信息,请参见更改文档的分片键值。
在MongoDB 4.2之前,文档的分片键字段值是不可变的。
要用于
db.collection.update()
更新分片键:
-
您必须指定。
multi: false
-
您 必须 在运行
mongos
无论是在 事务或作为重试写。千万 不能 直接在碎片发布运行。 -
您 必须 在查询过滤器的完整分片键上包含相等条件。例如,如果一个集合
messages
使用{ country : 1, userid : 1 }
的片键,更新为一个文件的碎片关键,你必须包括country: <value>, userid: <value>
在查询过滤器。您可以根据需要在查询中包括其他字段。
事务
db.collection.update()
可以在多文档交易中使用。
重要
在大多数情况下,与单文档写入相比,多文档事务产生的性能成本更高,并且多文档事务的可用性不应替代有效的架构设计。在许多情况下, 非规范化数据模型(嵌入式文档和数组)将继续是您的数据和用例的最佳选择。也就是说,在许多情况下,适当地对数据建模将最大程度地减少对多文档交易的需求。
有关其他事务使用方面的注意事项(例如:运行时限制和操作日志大小限制),另请参见 生产注意事项。
现有的集合和事务
在事务内部,您可以指定对现有集合的读/写操作。如果
db.collection.update()
导致upsert,则该集合必须已经存在。
如果该操作导致upsert,则该集合必须已经存在。
写关注和事务
如果在事务中运行,请不要为操作明确设置写关注点。要对事务使用写关注,请参见 事务和写关注。
例子
使用更新运算符表达式($ inc,$ set)
在
mongo
shell中,创建一个
books
包含以下文档的集合。此命令首先从
books
集合中删除所有先前存在的文档:
如果
<update>
文档包含更新运算符修饰符(例如使用
$set
修饰符的修饰符),则:
-
该
<update>
文档必须_仅_ 包含更新运算符表达式。 -
该
db.collection.update()
方法仅更新文档中的相应字段。-
要整体更新嵌入式文档或数组,请为该字段指定替换值。
-
要更新嵌入式文档或数组中的特定字段,请使用点表示法 指定该字段。
-
您可以使用下面的Web Shell插入示例文档并执行示例更新操作:
在此操作中:
-
该
<query>
参数指定更新哪个文档,{ _id: 1 }
-
在
$inc
操作递增stock
字段, -
在
$set
运算符替换值:-
item
字段, -
publisher
info
嵌入文档中的字段, -
tags
字段 -
ratings
数组中的第二个元素。
-
更新后的文档如下:
此操作对应于以下SQL语句:
注意
如果
query
参数已匹配多个文档,则此操作将仅更新一个匹配的文档。要更新多个文档,必须将multi
选项设置为true
。
也可以看看
$set
,$inc
,Update运算符
,点符号
将元素添加到现有数组
在
mongo
shell中,创建一个
books
包含以下文档的集合。此命令首先从
books
集合中删除所有先前存在的文档:
以下操作使用
$push
update运算符将新对象附加到
ratings
数组。
您可以使用下面的Web Shell插入示例文档并执行示例更新操作:
更新后的文档如下:
也可以看看
$push
删除字段($ unset)
在
mongo
shell中,创建一个
books
包含以下文档的集合。此命令首先从
books
集合中删除所有先前存在的文档:
以下操作使用
$unset
操作符通过删除
tags
文档中的字段。
{ _id: 1 }
您可以使用下面的Web Shell插入示例文档并执行示例更新操作:
更新后的文档如下:
没有直接等效于
$unset
的SQL ,但是
$unset
类似于以下SQL命令,该命令
tags
从
books
表中删除了该字段:
也可以看看
$unset
,$rename
,update运算符
替换整个文件
在
mongo
shell中,创建一个
books
包含以下文档的集合。此命令首先从
books
集合中删除所有先前存在的文档:
如果
<update>
文档_仅_ 包含
field:value
表达式,则:
-
该
db.collection.update()
方法_将_匹配的文档_替换_为<update>
文档。该db.collection.update()
方法_不会_替换该_id
值。 -
db.collection.update()
_无法_更新多个文档。
以下操作将传递
<update>
仅包含字段和值对的文档。该
<update>
文档将完全替换原始文档(
_id
字段除外)。
您可以使用下面的Web Shell插入示例文档并执行示例更新操作:
更新的文档_仅_包含替换文档中的
_id
字段和该字段。这样,这些字段
ratings
和
reorder
不再存在于更新的文档中,因为这些字段不在替换文档中。
此操作对应于以下SQL语句:
更新多个文件
在
mongo
shell中,创建一个
books
包含以下文档的集合。此命令首先从
books
集合中删除所有先前存在的文档:
如果
multi
设置为
true
,则该
db.collection.update()
方法将更新_所有_符合
<query>
条件的文档。该
multi
更新操作可以与其他的读/写操作交错。
以下操作将 所有小于或等于10的 文档的
reorder
字段设置
true
为。如果匹配的文档中不存在该字段,则运算符将使用指定的值添加该字段。
您可以使用下面的Web Shell插入示例文档并执行示例更新操作:
集合中的结果文档如下:
此操作对应于以下SQL语句:
注意
您无法指定何时执行替换,即<update>文档何时_仅_包含表达式:
multi: true
field:value
也可以看看
$set`
如果不存在匹配项,则插入新文档(
Upsert
)
Upsert
)
当您指定选项
upsert:true
时:
-
如果文档符合查询条件,请
db.collection.update()
执行更新。 -
如果没有文件的查询条件匹配,
db.collection.update()
插入一个_单一的_文件。
如果在分片集合上指定
upsert: true
,则必须在
filter
中包含完整的分片键。有关分片集合的其他 行为,请参见分片集合。
db.collection.update()
替换文件更新
如果没有文档符合查询条件,并且
<update>
参数是替换文档(即:仅包含字段和值的键值对),则更新将插入带有替换文档的字段和值的新文档。
-
如果您
_id
在查询参数或替换文档中指定字段,则MongoDB将_id
在插入的文档中使用该字段。 -
如果您未
_id
在查询参数或替换文档中指定字段,则MongoDB生成的_id
字段会添加带有随机生成的ObjectId值的 字段。
注意
您不能
_id
在查询参数和替换文档中指定其他字段值。如果这样做,则操作错误。
例如,以下更新将upsert选项设置为
true
:
如果没有文档与该
<query>
参数匹配,则更新操作将插入_仅_包含替换文档的文档。由于
_id
在替换文档或查询文档中未指定任何字段,因此该操作
ObjectId
将为新文档的
_id
字段创建一个新的唯一性。您可以看到
upsert
反映在操作的WriteResult中:
该操作将以下文档插入
books
集合中(您的ObjectId值将有所不同):
带运算符表达式的Upsert
如果没有文档符合查询条件,并且
<update>
参数是带有update运算符expression的文档,则该操作根据
<query>
参数中的equals子句创建基本文档,并应用参数中的表达式
<update>
。
来自的比较操作
<query>
将不会包含在新文档中。如果新文档不包含该
_id
字段,则MongoDB将
_id
使用ObjectId值添加该字段。
例如,以下更新将upsert选项设置为
true
:
如果没有文档符合查询条件,则该操作将插入以下文档(您的ObjectId值将有所不同):
也可以看看
$setOnInsert
使用Upsert的聚合管道
如果
<update>
参数是聚合管道,则更新将从
<query>
参数中的equals子句创建基础文档,然后将管道应用于文档以创建要插入的文档。如果新文档不包含该
_id
字段,则MongoDB将
_id
使用ObjectId值添加该字段。
例如,以下
upsert:true
操作指定使用以下内容的聚合管道
-
该
$replaceRoot
阶段可以提供与$setOnInsert
更新运算符表达式类似的行为, -
$set
可以提供与$set
更新操作符表达式相似的行为的阶段, -
聚合变量
NOW
,它解析为当前日期时间,并且可以提供与$currentDate
更新运算符表达式类似的行为 。
如果没有文档与该
<query>
参数匹配,则该操作会将以下文档插入到
books
集合中(您的ObjectId值将有所不同):
也可以看看
有关使用聚合管道进行更新的其他示例,请参见使用聚合管道进行更新。
结合Upsert和多选项
结合使用Upsert和多选项(匹配)
在
mongo
shell中,将以下文档插入
books
集合中:
以下操作同时指定了
multi
选项和
upsert
选项。如果存在匹配的文档,则该操作将更新所有匹配的文档。如果不存在匹配的文档,则该操作将插入一个新文档。
该操作将更新所有匹配的文档,并产生以下结果:
结合使用Upsert和多选项(无匹配项)
如果集合中_没有_匹配的文档,则该操作将导致使用
<query>
和
<update>
规范中的字段插入单个文档。例如,考虑以下操作:
该操作将以下文档插入
books
集合中(您的ObjectId值将有所不同):
带Dotted_id查询的Upsert
当执行
update()
with 且查询不匹配任何现有文档时,如果查询使用点表示法在字段上指定条件,则MongoDB将拒绝插入新文档 。
upsert: true
_id
此限制可确保
_id
文档中嵌入的字段的顺序 定义明确,并且不与查询中指定的顺序绑定。
如果您尝试以这种方式插入文档,MongoDB将引发错误。例如,考虑以下更新操作。由于更新操作指定
upsert:true
了
_id
字段并且查询使用点符号指定了字段上的条件,因此在构建要插入的文档时,更新将导致错误。
该
WriteResult
操作将返回以下错误:
也可以看看
WriteResult()
使用唯一索引
警告
为避免多次插入同一文档,请仅在
query
字段是唯一索引时使用upsert: true
。
给定一个名为集合
people
,其中没有包含
Andy
值的
name
字段,考虑当多个客户端在同一时间使用
upsert: true
发出以下
db.collection.update()
时:
如果所有
db.collection.update()
操作
query
在任何客户端成功插入数据之前完成了该 部分,
并且
该
name
字段上没有唯一索引,则每个更新操作都可能导致插入。
为防止MongoDB多次插入同一文档,请在字段上创建唯一索引
name
。使用唯一索引,如果多个应用程序使用
upsert: true
发出相同的更新,则_恰好一个_
db.collection.update()
将成功插入新文档。
其余操作将是:
-
更新新插入的文档,
-
当他们尝试插入重复项时失败。
如果操作由于重复的索引键错误而失败,则应用程序可以重试该操作,该操作将作为更新操作成功。
也可以看看
$setOnInsert
使用聚合管道更新
从MongoDB 4.2开始,
db.collection.update()
方法可以接受指定要执行的修改的聚合管道。管道可以包括以下阶段:
[ <stage1>, <stage2>, ... ]
-
$addFields
及其别名$set
-
$project
及其别名$unset
-
$replaceRoot
及其别名$replaceWith
。
使用聚合管道可以实现更具表达力的更新语句,例如根据当前字段值表达条件更新,或使用另一个字段的值更新一个字段。
使用文档中其他字段的值修改字段
members
使用以下文档创建一个集合:
假设您希望将这些字段收集到一个新字段中,而不是使用单独的
misc1
和
misc2
字段
comments
。以下更新操作使用聚合管道执行以下操作:
-
添加新
comments
字段并设置该lastUpdate
字段。 -
删除集合中所有文档的
misc1
和misc2
字段。
注意
$set
和$unset
在管道中是指聚合阶段$set
,并$unset
分别,而不是更新的运营商$set
和$unset
。
第一阶段
$set
阶段:
-
创建一个新的数组字段,
comments
其元素是misc1
和misc2
字段的当前内容, -
并且将字段设置为
lastUpdate
聚合变量的值NOW
。聚合变量NOW
解析为当前日期时间值,并且在整个管道中保持不变。要访问聚合变量,请在变量前加双美元符号$$
并用引号引起来。
第二阶段
$unset
阶段将删除
misc1
和
misc2
字段。
命令后,集合包含以下文档:
也可以看看
Updates with Aggregation Pipeline
根据当前字段值执行条件更新
使用以下文档创建一个
students3
集合:
使用聚合管道,可以使用计算出的平均成绩和字母成绩更新文档。
注意
$set
管道中的使用是指聚合阶段$set
,而不是更新运算符$set
。
第一阶段
$set
阶段:
-
根据字段
average
的平均值 计算一个新tests
字段。请参阅$avg
有关$avg
聚合运算符$trunc
的更多信息和有关$trunc
截取聚合运算符的更多信息 。 -
将字段设置为
lastUpdate
聚合变量的值NOW
。聚合变量NOW
解析为当前日期时间值,并且在整个管道中保持不变。要访问聚合变量,请在变量前加双美元符号$$
并用引号引起来。
第二阶段
$set
阶段根据前一阶段计算的平均
成绩
计算新的
成绩
等级。参见
$switch
以获取有关
$switch
聚合运算符的更多信息。
命令后,集合包含以下文档:
也可以看看
Updates with Aggregation Pipeline
指定
arrayFilters
数组更新操作
arrayFilters
数组更新操作
在更新文档中,使用
$[<identifier>]
过滤后的位置运算符定义一个标识符,然后在数组过滤器文档中引用该标识符。如果更新文档中未包含标识符,则不能具有数组过滤器文档作为标识符。
注意
在
<identifier>
必须以小写字母开头,并且只包含字母数字字符。
您可以在更新文档中多次包含相同的标识符;但是,对于
$[identifier]
更新文档中的每个不同的标识符,必须
精确地
指定
一个
对应的数组过滤器文档。即:您不能为同一标识符指定多个数组过滤器文档。例如:如果update语句包含标识符
x
(可能多次),则不能为以下内容指定以下内容
arrayFilters
:包括2个单独的过滤器文档
x
:
但是,可以在单个过滤器文档中的相同标识符上指定复合条件,例如以下示例:
arrayFilters
不适用于使用聚合管道的更新。
更新元素匹配
arrayFilters
条件
arrayFilters
条件
要更新所有符合指定条件的数组元素,请使用 arrayFilters参数。
在
mongo
shell程序中,
students
使用以下文档创建一个集合:
要更新
grades
阵列中大于或等于
100
的所有元素 ,使用过滤的位置操作符
$[<identifier>]
与所述
arrayFilters
选项:
操作后,集合包含以下文档:
更新文档数组的特定元素
您还可以使用arrayFilters参数更新文档数组中的特定文档字段。
在
mongo
shell程序中,
students2
使用以下文档创建一个集合:
要修改
mean
的
grades
数组中
grade
大于或等于
85
的所有元素的字段 值,请使用
$[<identifier>]
带有过滤条件的位置运算符和
arrayFilters
:
操作后,集合具有以下文档:
指定
hint
更新操作
hint
更新操作
4.2版中的新功能。
mongo
shell程序中,
members
使用以下文档创建一个集合:
在集合上创建以下索引:
以下更新操作
hints
明确指出要使用索引:
{status: 1 }
注意
如果指定的索引不存在,则操作错误。
update命令返回以下内容:
要查看使用的索引,请运行
explain
以下操作:
db.collection.explain().update()
不修改文件。
覆盖默认写问题
对副本集的以下操作指定5,000毫秒的写关注时间
"w: majority"
,以 使该方法在写传送到大多数有表决权的副本集成员之后返回,或者该方法在5秒钟后超时。
指定排序规则
指定 用于操作的排序规则。
排序规则允许用户为字符串比较指定特定于语言的规则,例如字母大写和重音符号的规则。
排序规则选项具有以下语法:
指定排序规则时,该
locale
字段为必填字段;所有其他排序规则字段都是可选的。有关字段的说明,请参见整理文档。
如果未指定排序规则,但是集合具有默认排序规则(请参阅参考资料
db.createCollection()
),则该操作将使用为集合指定的排序规则。
如果没有为集合或操作指定排序规则,则MongoDB会将以前版本中使用的简单二进制比较用于字符串比较。
您不能为一个操作指定多个排序规则。例如,您不能为每个字段指定不同的排序规则,或者如果对排序执行查找,则不能对查找使用一种排序规则,而对排序使用另一种排序规则。
3.4版的新功能。
在
mongo
shell程序中,创建一个
myColl
包含以下文档的集合 :
下面的操作包括排序选项和设置
multi
,以
true
更新所有匹配的文档:
该操作的写入结果返回以下文档,指示集合中的所有三个文档均已更新:
操作后,集合包含以下文档:
写结果
成功的结果
db.collection.update()
方法返回一个
WriteResult
包含操作状态的对象。成功后,
WriteResult
对象包含符合查询条件的文档数,更新插入的文档数以及修改的文档数: