- Reference >
mongo
Shell Methods >- Collection Methods >
- db.collection.updateMany()
db.collection.updateMany()¶
On this page
Definition¶
-
db.collection.
updateMany
(filter, update, options)¶ New in version 3.2.
Updates multiple documents within the collection based on the filter.
The
updateMany()
method has the following form:Changed in version 3.6.
The
updateMany()
method takes the following parameters:Parameter Type Description filter
document The selection criteria for the update. The same query selectors as in the
find()
method are available.Specify an empty document
{ }
to update all documents in the collection.update
document The modifications to apply.
Use Update Operators such as
$set
,$unset
, or$rename
.Using the update() pattern of
field: value
for theupdate
parameter throws an error.upsert
boolean Optional. When
true
,updateMany()
either:- Creates a new document if no documents match the
filter
. For more details see upsert behavior. - Updates documents that match the
filter
.
To avoid multiple upserts, ensure that the
filter
fields are uniquely indexed.Defaults to
false
.writeConcern
document Optional. A document expressing the write concern. Omit to use the default write concern.
Do not explicitly set the write concern for the operation if run in a transaction. To use write concern with transactions, see Read Concern/Write Concern/Read Preference.
collation
document Optional.
Specifies the collation to use for the operation.
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.
The collation option has the following syntax:
When specifying collation, the
locale
field is mandatory; all other collation fields are optional. For descriptions of the fields, see Collation Document.If the collation is unspecified but the collection has a default collation (see
db.createCollection()
), the operation uses the collation specified for the collection.If no collation is specified for the collection or for the operations, MongoDB uses the simple binary comparison used in prior versions for string comparisons.
You cannot specify multiple collations for an operation. For example, you cannot specify different collations per field, or if performing a find with a sort, you cannot use one collation for the find and another for the sort.
New in version 3.4.
arrayFilters
array Optional. An array of filter documents that determines which array elements to modify for an update operation on an array field.
In the update document, use the
$[<identifier>]
filtered positional operator to define an identifier, which you then reference in the array filter documents. You cannot have an array filter document for an identifier if the identifier is not included in the update document.Note
The
<identifier>
must begin with a lowercase letter and contain only alphanumeric characters.You can include the same identifier multiple times in the update document; however, for each distinct identifier (
$[identifier]
) in the update document, you must specify exactly one corresponding array filter document. That is, you cannot specify multiple array filter documents for the same identifier. For example, if the update statement includes the identifierx
(possibly multiple times), you cannot specify the following forarrayFilters
that includes 2 separate filter documents forx
:However, you can specify compound conditions on the same identifier in a single filter document, such as in the following examples:
For examples, see Specify arrayFilters for an Array Update Operations.
New in version 3.6.
Returns: A document containing: - A boolean
acknowledged
astrue
if the operation ran with write concern orfalse
if write concern was disabled matchedCount
containing the number of matched documentsmodifiedCount
containing the number of modified documentsupsertedId
containing the_id
for the upserted document
- Creates a new document if no documents match the
Behavior¶
updateMany()
updates all matching documents in
the collection that match the filter
, using the update
criteria
to apply modifications.
If upsert: true
and no documents match the filter
,
updateMany()
creates a new
document based on the filter
and update
parameters. See
Update Multiple Documents with Upsert.
Capped Collections¶
If an update operation changes the document size, the operation will fail.
Transactions¶
db.collection.updateMany()
supports multi-document transactions.
If the operation results in an upsert, the collection must already exist.
Do not explicitly set the write concern for the operation if run in a transaction. To use write concern with transactions, see Read Concern/Write Concern/Read Preference.
Important
In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transaction should not be a replacement for effective schema design. For many scenarios, the denormalized data model (embedded documents and arrays) will continue to be optimal for your data and use cases. That is, for many scenarios, modeling your data appropriately will minimize the need for multi-document transactions. For additional transactions usage considerations (such as runtime limit and oplog size limit), see also Production Considerations.
Examples¶
Update Multiple Documents¶
The restaurant
collection contains the following documents:
The following operation updates all documents where violations
are
greater than 4
and $set
a flag for review:
The operation returns:
The collection now contains the following documents:
If no matches were found, the operation instead returns:
Setting upsert: true
would insert a document if no match was found.
Update Multiple Documents with Upsert¶
The inspectors
collection contains the following documents:
The following operation updates all documents with Sector
greater
than 4 and inspector
equal to "R. Coltrane"
:
The operation returns:
The collection now contains the following documents:
Since no documents matched the filter, and upsert
was true
,
updateMany
inserted the document with a
generated _id
, the equality conditions from the filter
, and the
update
modifiers.
Update with Write Concern¶
Given a three member replica set, the following operation specifies a
w
of majority
and wtimeout
of 100
:
If the acknowledgement takes longer than the wtimeout
limit, the following
exception is thrown:
The wtimeout
error only indicates that the operation did not complete on
time. The write operation itself can still succeed outside of the set time
limit.
Specify Collation¶
New in version 3.4.
Collation allows users to specify language-specific rules for string comparison, such as rules for lettercase and accent marks.
A collection myColl
has the following documents:
The following operation includes the collation option:
Specify arrayFilters
for an Array Update Operations¶
New in version 3.6.
Starting in MongoDB 3.6, when updating an array field, you can
specify arrayFilters
that determine which array elements to
update.
Update Elements Match arrayFilters
Criteria¶
Create a collection students
with the following documents:
To update all elements that are greater than or equal to 100
in the
grades
array, use the filtered positional operator
$[<identifier>]
with the arrayFilters
option:
After the operation, the collection contains the following documents:
Update Specific Elements of an Array of Documents¶
Create a collection students2
with the following documents:
To modify the value of the mean
field for all elements in the
grades
array where the grade is greater than or equal to 85
,
use the filtered positional operator $[<identifier>]
with
the arrayFilters
:
After the operation, the collection has the following documents: