Open In App

Mongoose | findByIdAndUpdate() Function

Improve
Improve
Improve
Like Article
Like
Save Article
Save
Share
Report issue
Report

The findByIdAndUpdate() function is used to find a matching document, updates it according to the update arg, passing any options, and returns the found document (if any) to the callback.

Installation of mongoose module:

  1. You can visit the link to Install mongoose module. You can install this package by using this command.
    npm install mongoose
  2. After installing mongoose module, you can check your mongoose version in command prompt using the command.
    npm version mongoose
  3. After that, you can just create a folder and add a file, for example index.js. To run this file you need to run the following command.
    node index.js

Filename: index.js




const mongoose = require('mongoose');
  
// Database connection
    useNewUrlParser: true,
    useCreateIndex: true,
    useUnifiedTopology: true,
    useFindAndModify: false
});
  
// User model
const User = mongoose.model('User', {
    name: { type: String },
    age: { type: Number }
});
  
// Find a document whose 
// user_id=5eb985d440bd2155e4d788e2 and update it
// Updating name field of this user_id to name='Gourav'
var user_id = '5eb985d440bd2155e4d788e2';
User.findByIdAndUpdate(user_id, { name: 'Gourav' },
                            function (err, docs) {
    if (err){
        console.log(err)
    }
    else{
        console.log("Updated User : ", docs);
    }
});


Steps to run the program:

  1. The project structure will look like this:
  2. Make sure you have installed mongoose module using following command:
    npm install mongoose
  3. Below is the sample data in the database before the function is executed. You can use any GUI tool or terminal to see the database, like we have used Robo3T GUI tool as shown below:
    Database
  4. Run index.js file using below command:
    node index.js

  5. After the function is executed, You can see in the database that the particular user is removed as shown below:
    new Database

So this is how you can use the mongoose findByIdAndUpdate() function which finds a matching document, updates it according to the update arg, passing any options, and returns the found document (if any) to the callback.


Last Updated : 20 May, 2020
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads