- Reference >
mongo
Shell Methods >- Collection Methods >
- db.collection.findOneAndUpdate()
db.collection.findOneAndUpdate()¶
On this page
Definition¶
-
db.collection.
findOneAndUpdate
(filter, update, options)¶ Important
mongo
Shell MethodThis page documents a
mongo
method. This is not the documentation for database commands or language-specific drivers, such as Node.js. To use the database command, see theupdate
command.For MongoDB API drivers, refer to the language-specific MongoDB driver documentation.
Updates a single document based on the
filter
andsort
criteria.The
findOneAndUpdate()
method has the following form:The
findOneAndUpdate()
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 the first document returned in the collection.If unspecified, defaults to an empty document.
Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the query argument is not a document.
If no document matches the
filter
, no document is updated.update
document or array The update document or, starting in MongoDB 4.2, an aggregation pipeline.
If passed a document with update operator expressions,
db.collection.findOneAndUpdate()
performs the specified modification.Note
The document must contain only update operator expressions. You cannot specify a replacement document
{ <field1>: <value1>, ...}
. To use a replacement document, seedb.collection.findOneAndReplace()
instead.Starting in MongoDB 4.2, if passed an aggregation pipeline
[ <stage1>, <stage2>, ... ]
,db.collection.findOneAndUpdate()
modifies the document per the pipeline. The pipeline can consist of the following stages:$addFields
and its alias$set
$project
and its alias$unset
$replaceRoot
and its alias$replaceWith
.
projection
document Optional. A subset of fields to return.
To return all fields in the returned document, omit this parameter.
Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the projection argument is not a document.
sort
document Optional. Specifies a sorting order for the documents matched by the
filter
.Starting in MongoDB 4.2 (and 4.0.12+, 3.6.14+, and 3.4.23+), the operation errors if the sort argument is not a document.
See
cursor.sort()
.maxTimeMS
number Optional. Specifies a time limit in milliseconds within which the operation must complete within. Throws an error if the limit is exceeded. upsert
boolean Optional. When
true
,findOneAndUpdate()
either:- Creates a new document if no documents match the
filter
. For more details see upsert behavior. Returnsnull
after inserting the new document, unlessreturnNewDocument
istrue
. - Updates a single document that matches the
filter
.
To avoid multiple upserts, ensure that the
filter
field(s) are uniquely indexed.Defaults to
false
, which does not insert a new document when no match is found.returnNewDocument
boolean Optional. When
true
, returns the updated document instead of the original document.Defaults to
false
.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 determine 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 Array Update Operations with arrayFilters.
Note
arrayFilters
is not available for updates that use an aggregation pipeline.New in version 3.6.
Returns: Returns either the original document or, if returnNewDocument: true
, the updated document.
Behavior¶
Document Match¶
db.collection.findOneAndUpdate()
updates the first matching
document in the collection that matches the filter
. If no document
matches the filter
, no document is updated.
The sort
parameter can be used to influence which document is updated.
Projection¶
The projection
parameter takes a document in the following form:
The <boolean>
value can be any of the following:
1
ortrue
to include the field. The method returns the_id
field even if it is not explicitly stated in the projection parameter.0
orfalse
to exclude the field. This can be used on any field, including_id
.
Sharded Collections¶
To use db.collection.findOneAndUpdate()
on a sharded collection, the query filter must
include an equality condition on the shard key.
Shard Key Modification¶
Starting in MongoDB 4.2, you can update a document’s shard key value
unless the shard key field is the immutable _id
field. For details
on updating the shard key, see Change a Document’s Shard Key Value.
Before MongoDB 4.2, a document’s shard key field value is immutable.
To use db.collection.findOneAndUpdate()
to update the shard key:
- You must run on a
mongos
either in a transaction or as a retryable write. Do not issue the operation directly on the shard. - You must include an equality condition on the full shard
key in the query filter. For example, if a collection
messages
uses{ country : 1, userid : 1 }
as the shard key, to update the shard key for a document, you must includecountry: <value>, userid: <value>
in the query filter. You can include additional fields in the query as appropriate.
Transactions¶
db.collection.findOneAndUpdate()
can be used inside multi-document transactions.
Important
In most cases, multi-document transaction incurs a greater performance cost over single document writes, and the availability of multi-document transactions 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.
Existing Collections and Transactions¶
Inside a transaction, you can specify read/write operations on existing
collections. If the db.collection.findOneAndUpdate()
results in an
upsert, the collection must already exist.
If the operation results in an upsert, the collection must already exist.
Write Concerns and Transactions¶
Do not explicitly set the write concern for the operation if run in a transaction. To use write concern with transactions, see Transactions and Write Concern.
Examples¶
In this section
Update A Document¶
The grades
collection contains documents similar to the following:
The following operation finds the first document where name : R. Stiles
and increments the score by 5
:
The operation returns the original document before the update:
If returnNewDocument
was true, the operation would return the
updated document instead.
Sort And Update A Document¶
The grades
collection contains documents similar to the following:
The following operation updates a document where name : "A. MacDyver"
. The
operation sorts the matching documents by points
ascending to update the
matching document with the least points.
The operation returns the original document before the update:
Project the Returned Document¶
The following operation uses projection to only display the _id
,
points
, and assignment
fields in the returned document:
The operation returns the original document with only the
fields specified in the projection
document and the _id
field as it was not
explicitly suppressed (_id: 0
) in the projection document.
Update Document with Time Limit¶
The following operation sets a 5ms time limit to complete the update:
If the operation exceeds the time limit, it returns:
Update Document with Upsert¶
The following operation uses the upsert
field to insert the update
document if nothing matches the filter
:
The operation returns the following:
If returnNewDocument
was false, the operation would return null
as
there is no original document to return.
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:
The operation returns the following document:
Array Update Operations with arrayFilters
¶
Note
arrayFilters
is not available for updates that use an
aggregation pipeline.
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¶
Note
arrayFilters
is not available for updates that use an
aggregation pipeline.
Create a collection students
with the following documents:
To modify all elements that are greater than or equal to 100
in the
grades
array, use the filtered positional operator
$[<identifier>]
with the arrayFilters
option in the
db.collection.findOneAndUpdate
method:
The operation updates the grades
field for a single document, and
after the operation, the collection has the following documents:
Update Specific Elements of an Array of Documents¶
Note
arrayFilters
is not available for updates that use an
aggregation pipeline.
Create a collection students2
with the following documents:
The following operation finds a document where the _id
field equals
1
and uses the filtered positional operator $[<identifier>]
with
the arrayFilters
to modify the mean
for all elements in the
grades
array where the grade is greater than or equal to 85
.
The operation updates the grades
field for a single document, and after the
operation, the collection has the following documents:
Use an Aggregation Pipeline for Updates¶
Starting in MongoDB 4.2, db.collection.findOneAndUpdate()
can
accept an aggregation pipeline for the update. The pipeline can consist
of the following stages:
$addFields
and its alias$set
$project
and its alias$unset
$replaceRoot
and its alias$replaceWith
.
Using the aggregation pipeline allows for a more expressive update statement, such as expressing conditional updates based on current field values or updating one field using the value of another field(s).
For example, create a collection students2
with the following
documents:
The following operation finds a document where the _id
field equals
1
and uses an aggregation pipeline to calculate a new field
total
from the grades
field:
Note
The $set
used in the pipeline refers to the aggregation stage
$set
and not the update operator $set
.
The operation returns the updated document :