db.collection.findOneAndUpdate() — MongoDB Manual

link管理

链接快照平台

输入网页链接，自动生成快照
标签化管理网页链接

相关文章推荐

聪明的牛肉面 · Update error ...· 1 周前 ·

想出国的豆腐 · PostgreSQL Python: ...· 1 周前 ·

欢快的茶叶 · python json.update - ...· 1 周前 ·

会搭讪的大葱 · Changelog — Haystack ...· 6 天前 ·

爱笑的桔子 · How to update ...· 6 天前 ·

任性的斑马 · 世界上为什么没有第二个张家界？_市州聚焦_湖 ...· 2 月前 ·

谦和的蘑菇 · 中国创新创业教育大事记（1978～2018） ...· 2 月前 ·

小眼睛的火车 · OAUTH2 - "The request ...· 3 月前 ·

阳刚的皮带 · 【央企在非洲】东非高原上的“90后”· 4 月前 ·

挂过科的树叶 · 6. 使用Makefile控制编译 — ...· 6 月前 ·

Updates a single document based on the filter and sort criteria.

The findOneAndUpdate() method has the following form:

Changed in version 3.6.

returnNewDocument : < boolean > , collation : < document > , arrayFilters : [ < filterdocument1 > , ... ]

The findOneAndUpdate() method takes the following parameters:

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 3.6.14+ (and 3.4.23+), the operation errors if the query argument is not a document.


   
    update

document

The update document.

Must contain only update operators .


   
    projection

document

Optional. A subset of fields to return.

To return all fields in the returned document, omit this parameter.

Starting in MongoDB 3.6.14+ (and 3.4.23+), the operation errors if the projection argument is not a document.

document

Optional. Specifies a sorting order for the documents matched by the filter .

Starting in MongoDB 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 . Returns


    
     null

after inserting the new document, unless


    
     returnNewDocument


    
     true

Updates a single document that matches the


    
     filter

To avoid multiple upserts, ensure that the filter fields are uniquely indexed .

Defaults to false .


   
    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:

collation: {
   locale: <string>,
   caseLevel: <boolean>,
   caseFirst: <string>,
   strength: <int>,
   numericOrdering: <boolean>,
   alternate: <string>,
   maxVariable: <string>,
   backwards: <boolean>
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.
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 identifier x
(possibly multiple times), you cannot specify the following for
arrayFilters that includes 2 separate filter documents for x:
  { "x.a": { $gt: 85 } },
  { "x.b": { $gt: 80 } }
However, you can specify compound conditions on the same identifier
in a single filter document, such as in the following examples:
  { $or: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] }
  { $and: [{"x.a": {$gt: 85}}, {"x.b": {$gt: 80}}] }
  { "x.a": { $gt: 85 }, "x.b": { $gt: 80 } }
For examples, see Specify arrayFilters for an Array Update Operations.
New in version 3.6.
Behavior¶
findOneAndUpdate() updates the first matching
document in the collection that matches the filter.
The sort parameter can be used to influence which document is updated.
The projection parameter takes a document in the following form:
{ field1 : < boolean >, field2 : < boolean> ... }
The <boolean> value can be any of the following:
1 or true to include the field. The method returns the
_id field even if it is not explicitly stated in the projection
parameter.
0 or false to exclude the field. This can be used on any
field, including _id.
Examples¶
Update A Document¶
The grades collection contains documents similar to the following:
{ _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
{ _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
{ _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
{ _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
{ _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
{ _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }
The following operation finds the first document where name : R. Stiles
and increments the score by 5:
db.grades.findOneAndUpdate(
   { "name" : "R. Stiles" },
   { $inc: { "points" : 5 } }
The operation returns the original document before the update:
{ _id: 6319, name: "R. Stiles", "assignment" : 2, "points" : 12 }
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:
{ _id: 6305, name : "A. MacDyver", "assignment" : 5, "points" : 24 },
{ _id: 6308, name : "B. Batlock", "assignment" : 3, "points" : 22 },
{ _id: 6312, name : "M. Tagnum", "assignment" : 5, "points" : 30 },
{ _id: 6319, name : "R. Stiles", "assignment" : 2, "points" : 12 },
{ _id: 6322, name : "A. MacDyver", "assignment" : 2, "points" : 14 },
{ _id: 6234, name : "R. Stiles", "assignment" : 1, "points" : 10 }
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.




    

db.grades.findOneAndUpdate(
   { "name" : "A. MacDyver" },
   { $inc : { "points" : 5 } },
   { sort : { "points" : 1 } }
The operation returns the original document before the update:
{ _id: 6322, name: "A. MacDyver", "assignment" : 2, "points" : 14 }
Project the Returned Document¶
The following operation uses projection to only display the _id,
points, and assignment fields in the returned document:
db.grades.findOneAndUpdate(
   { "name" : "A. MacDyver" },
   { $inc : { "points" : 5 } },
   { sort : { "points" : 1 }, projection: { "assignment" : 1, "points" : 1 } }
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.
{ "_id" : 6322, "assignment" : 2, "points" : 14 }
   db.grades.findOneAndUpdate(
      { "name" : "A. MacDyver" },
      { $inc : { "points" : 5 } },
      { sort: { "points" : 1 }, maxTimeMS : 5 };
catch(e){
   print(e);
If the operation exceeds the time limit, it returns:
Error: findAndModifyFailed failed: { "ok" : 0, "errmsg" : "operation exceeded time limit", "code" : 50 }
Update Document with Upsert¶
The following operation uses the upsert field to insert the update
document if nothing matches the filter:
try {
   db.grades.findOneAndUpdate(
      { "name" : "A.B. Abracus" },
      { $set: { "name" : "A.B. Abracus", "assignment" : 5}, $inc : { "points" : 5 } },
      { sort: { "points" : 1 }, upsert:true, returnNewDocument : true }
catch (e){
   print(e);
The operation returns the following:
   "_id" : ObjectId("5789249f1c49e39a8adc479a"),
   "name" : "A.B. Abracus",
   "assignment" : 5,
   "points" : 5
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:
{ _id: 1, category: "café", status: "A" }
{ _id: 2, category: "cafe", status: "a" }
{ _id: 3, category: "cafE", status: "a" }
The following operation includes the collation
option:
db.myColl.findOneAndUpdate(
   { category: "cafe" },
   { $set: { status: "Updated" } },
   { collation: { locale: "fr", strength: 1 } }
The operation returns the following document:
{ "_id" : 1, "category" : "café", "status" : "A" }
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:
db.students.insert([
   { "_id" : 1, "grades" : [ 95, 92, 90 ] },
   { "_id" : 2, "grades" : [ 98, 100, 102 ] },
   { "_id" : 3, "grades" : [ 95, 110, 100 ] }
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:
db.students.findOneAndUpdate(
   { grades: { $gte: 100 } },
   { $set: { "grades.$[element]" : 100 } },
   { arrayFilters: [ { "element": { $gte: 100 } } ] }
The operation updates the grades field for a single document, and
after the operation, the collection has the following documents:
{ "_id" : 1, "grades" : [ 95, 92, 90 ] }
{ "_id" : 2, "grades" : [ 98, 100, 100 ] }
{ "_id" : 3, "grades" : [ 95, 110, 100 ] }
      "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 }
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 in the db.collection.findOneAndUpdate
method:
db.students2.findOneAndUpdate(
   { },
   { $set: { "grades.$[elem].mean" : 100 } },
   { arrayFilters: [ { "elem.grade": { $gte: 85 } } ] }
The operation updates the grades field for a single document, and after the
operation, the collection has the following documents:
   "_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" : 75, "std" : 6 },
      { "grade" : 87, "mean" : 90, "std" : 3 },
      { "grade" : 85, "mean" : 85, "std" : 4 }