Mongoose: findOneAndUpdate doesn't return updated document

Question

Below is my code

var mongoose = require('mongoose'); mongoose.connect('mongodb://localhost/test'); var Cat = mongoose.model('Cat', { name: String, age: {type: Number, default: 20}, create: {type: Date, default: Date.now} }); Cat.findOneAndUpdate({age: 17}, {$set:{name:"Naomi"}},function(err, doc){ if(err){ console.log("Something wrong when updating data!"); } console.log(doc); });

I already have some record in my mongo database and I would like to run this code to update name for which age is 17 and then print result out in the end of code.

However, why I still get same result from console(not the modified name) but when I go to mongo db command line and type "db.cats.find();". The result came with modified name.

Then I go back to run this code again and the result is modified.

My question is: If the data was modified, then why I still got original data at first time when console.log it.

using {new:true} did not seem to work with updateOne, replaced updateOne with findOneAndUpdate and its working — Kritish Bhattarai
– Kritish Bhattarai, Commented Jun 24, 2021 at 2:41

XCS · Accepted Answer · 2020-02-25 23:45:12Z

Why this happens?

The default is to return the original, unaltered document. If you want the new, updated document to be returned you have to pass an additional argument: an object with the new property set to true.

From the mongoose docs:

Query#findOneAndUpdate
Model.findOneAndUpdate(conditions, update, options, (error, doc) => { // error: any errors that occurred // doc: the document before updates are applied if `new: false`, or after updates if `new = true` }); 
Available options

new: bool - if true, return the modified document rather than the original. defaults to false (changed in 4.0)

Solution

Pass {new: true} if you want the updated result in the doc variable:

// V--- THIS WAS ADDED Cat.findOneAndUpdate({age: 17}, {$set:{name:"Naomi"}}, {new: true}, (err, doc) => { if (err) { console.log("Something wrong when updating data!"); } console.log(doc); });

This appears to be broken for me, it still returns the old document with new: true.
makes sense to me since you already have access to the new document
I get the new doc, but _id is null, so its not really the new doc.

6be709c0 · Accepted Answer · 2021-12-18 19:58:43Z

164

For anyone using the Node.js driver instead of Mongoose, you'll want to use {returnOriginal:false} instead of {new:true}.

2021 - Mongodb ^4.2.0 Update
{ returnDocument: 'after' }

edited Dec 18, 2021 at 19:58

6be709c0

8,5014 gold badges40 silver badges53 bronze badges

answered Apr 18, 2017 at 13:52

Pedro Hoehl Carvalho

2,4322 gold badges23 silver badges25 bronze badges

4 Comments

Kevin Ng Over a year ago

Thank you! This works for me mongodb node version 2.2.27

Askdesigners Over a year ago

This is kind of an idiot API. Why not use the same signatures for Mongoose as the native API? Why not return the updated doc by default? Mongoose is one of the more irritating libs I use everyday.

kunthet Over a year ago

I'm using "mongodb": "^3.6.9" and { returnOriginal:false } is deprecated. Use { returnDocument: 'after' } instead.

Daniel Over a year ago

Thank you! This works for me. @kunthet I was actually using this, as the documentation explained that the suggested { returnOriginal: false } is deprecated. But for some reason, I cannot get that to work, while it works as expected using the suggestion.

6be709c0 · Accepted Answer · 2021-12-18 19:59:19Z

So, "findOneAndUpdate" requires an option to return original document. And, the option is:

MongoDB shell

{returnNewDocument: true}

Ref: https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndUpdate/

Mongoose

{new: true}

Ref: http://mongoosejs.com/docs/api.html#query_Query-findOneAndUpdate

Node.js MongoDB Driver API:

{returnOriginal: false}

2021 - Mongodb ^4.2.0 Update
{ returnDocument: 'after' }

Ref: http://mongodb.github.io/node-mongodb-native/3.0/api/Collection.html#findOneAndUpdate

Laravel: 'returnDocument' => FindOneAndUpdate::RETURN_DOCUMENT_AFTER

score 47 · Accepted Answer · 2015-09-27 18:53:40Z

By default findOneAndUpdate returns the original document. If you want it to return the modified document pass an options object { new: true } to the function:

Cat.findOneAndUpdate({ age: 17 }, { $set: { name: "Naomi" } }, { new: true }, function(err, doc) { });

vkarpov15 · Accepted Answer · 2019-10-09 16:11:51Z

Mongoose maintainer here. You need to set the new option to true (or, equivalently, returnOriginal to false)

await User.findOneAndUpdate(filter, update, { new: true }); // Equivalent await User.findOneAndUpdate(filter, update, { returnOriginal: false });

See Mongoose findOneAndUpdate() docs and this tutorial on updating documents in Mongoose.

I have mistaken to write returnNewDocument instead of just new. thanks for help!

flash · Accepted Answer · 2017-05-01 01:21:36Z

For whoever stumbled across this using ES6 / ES7 style with native promises, here is a pattern you can adopt...

const user = { id: 1, name: "Fart Face 3rd"}; const userUpdate = { name: "Pizza Face" }; try { user = await new Promise( ( resolve, reject ) => { User.update( { _id: user.id }, userUpdate, { upsert: true, new: true }, ( error, obj ) => { if( error ) { console.error( JSON.stringify( error ) ); return reject( error ); } resolve( obj ); }); }) } catch( error ) { /* set the world on fire */ }

Mongoose will return a promise if you don't provide a callback function. There is no need to create your own promise!
@joeytwiddle Mongoose will not return a Promise if you don't provide a callback. Instead it returns a Query object that provides only a small subset of the Promise API. This is according to the Mongoose documentation.

Paul Roub · Accepted Answer · 2017-08-31 17:15:40Z

This is the updated code for findOneAndUpdate. It works.

db.collection.findOneAndUpdate( { age: 17 }, { $set: { name: "Naomi" } }, { returnNewDocument: true } )

Jonathan Thurft · Accepted Answer · 2018-05-01 10:04:22Z

If you want to return the altered document you need to set the option {new:true} API reference you can use Cat.findOneAndUpdate(conditions, update, options, callback) // executes

Taken by the official Mongoose API http://mongoosejs.com/docs/api.html#findoneandupdate_findOneAndUpdate you can use the following parameters

A.findOneAndUpdate(conditions, update, options, callback) // executes A.findOneAndUpdate(conditions, update, options) // returns Query A.findOneAndUpdate(conditions, update, callback) // executes A.findOneAndUpdate(conditions, update) // returns Query A.findOneAndUpdate() // returns Query

Another implementation thats is not expressed in the official API page and is what I prefer to use is the Promise base implementation that allow you to have .catch where you can deal with all your various error there.

 let cat: catInterface = { name: "Naomi" }; Cat.findOneAndUpdate({age:17}, cat,{new: true}).then((data) =>{ if(data === null){ throw new Error('Cat Not Found'); } res.json({ message: 'Cat updated!' }) console.log("New cat data", data); }).catch( (error) => { /* Deal with all your errors here with your preferred error handle middleware / method */ res.status(500).json({ message: 'Some Error!' }) console.log(error); });

Aljohn Yamaro · Accepted Answer · 2020-06-05 09:53:10Z

I know, I am already late but let me add my simple and working answer here

const query = {} //your query here const update = {} //your update in json here const option = {new: true} //will return updated document const user = await User.findOneAndUpdate(query , update, option)

Sourabh Khurana · Accepted Answer · 2019-04-05 07:31:04Z

Below shows the query for mongoose's findOneAndUpdate. Here new: true is used to get the updated doc and fields is used for specific fields to get.

eg. findOneAndUpdate(conditions, update, options, callback)

await User.findOneAndUpdate({ "_id": data.id, }, { $set: { name: "Amar", designation: "Software Developer" } }, { new: true, fields: { 'name': 1, 'designation': 1 } }).exec();

Crucial · Accepted Answer · 2021-12-06 22:51:52Z

2021 - Mongodb ^4.2.0 Update

This applies to the mongodb node driver, NOT mongoose.

It seems like the latest version of the Mongodb node driver uses the following syntax, if you are searching and updating using "collection.findOneAndUpdate":

.findOneAndUpdate(query, update, { returnDocument: 'after' | 'before' })

Couldn't find the answer here myself while searching, so posting this in case others are in the same situation.

This does not provide an answer to the question. Once you have sufficient reputation you will be able to comment on any post; instead, provide answers that don't require clarification from the asker. - From Review

Kamen Kanchev · Accepted Answer · 2023-01-23 21:12:14Z

Make sure you check if you're using Mongoose or MongoDB

if using Mongoose - use {new: true}

const query = await Model.findOneAndUpdate({filter}, {update}, {new: true});

if using MongoDB - use {returnNewDocument: true}

const query = await Model.findOneAndUpdate({filter}, {update}, {returnNewDocument: true});

Make sure you're using the correct one since, because if you don't, it's just gonna get ommited and you're get the old document.

Dharman · Accepted Answer · 2020-08-13 12:04:17Z

1

In some scenarios {new: true} is not working. Then you can try this.

{'returnNewDocument':true}

edited Aug 13, 2020 at 12:04

Dharman♦

33.9k27 gold badges105 silver badges157 bronze badges

answered Aug 13, 2020 at 11:58

Prakash Harvani

1,0418 silver badges18 bronze badges

Comments

Mohiuddin Saifullah · Accepted Answer · 2023-01-22 15:42:22Z

const updatedDocument = await Model.findOneAndUpdate(req.params.id, req.body, { upsert: true, new: true, })

use this to get update document

All2Pie · Accepted Answer · 2022-02-07 12:39:11Z

export function newDocumentOnUpdatePlugin(schema) { schema.pre( ['update', 'findOneAndUpdate', 'updateOne', 'updateMany'], function (next) { this.setOptions({ new: true }); next(); }, ); }

I have created this plugin if anyone need this functionality across the whole app and want to avoid repetition. Just use this as a global plugin

Zehan Khan · Accepted Answer · 2022-12-01 10:03:08Z

0

This option is necessary to get updated document instance

{ new: true }

answered Dec 1, 2022 at 10:03

Zehan Khan

173 bronze badges

Comments

Alon Rosenfeld · Accepted Answer · 2024-01-06 07:39:47Z

In version "mongodb": "^6.3.0", work with the FindOneAndUpdateOptions options, use {includeResultMetadata: boolean}

/** * Return the ModifyResult instead of the modified document. Defaults to true * but will default to false in the next major version. */ includeResultMetadata?: boolean;

Collectives™ on Stack Overflow

Mongoose: findOneAndUpdate doesn't return updated document

17 Answers 17

Why this happens?

Solution

13 Comments

4 Comments

MongoDB shell

Mongoose

Node.js MongoDB Driver API:

1 Comment

1 Comment

3 Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

17 Answers 17

Why this happens?

Solution

13 Comments

4 Comments

MongoDB shell

Mongoose

Node.js MongoDB Driver API:

1 Comment

1 Comment

3 Comments

2 Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Comments

Comments

Comments

Comments

Comments

Linked

Related