findByIdAndDelete Method in Mongoose

The findByIdAndDelete() function in Mongoose is a commonly used method to find and remove a document by its unique ID in MongoDB. This method simplifies the process of deleting documents, making it an essential tool for Node.js developers working with MongoDB. Whether you're managing user data, posts, or other collections, this method provides an efficient way to handle deletions.

What is the findByIdAndDelete() Method?

findByIdAndDelete() is a Mongoose method used to search for a document by its _id and remove it from the collection. It not only deletes the document but also returns the deleted document (if found), providing useful feedback for debugging and logging. Unlike older methods like remove(), findByIdAndDelete() is preferred for its clarity and simplicity. It’s a part of Mongoose’s more modern and consistent API for document removal operations.

Syntax

Model.findByIdAndDelete(id, options, callback);

Parameters:

• id: The unique identifier of the document to be deleted (typically the _id field).
• options (optional): An object with additional options (e.g., lean, select).
• callback (optional): A function to handle the result of the operation (e.g., error or deleted document).

Step-by-Step Guide to Using findByIdAndDelete()

Follow these steps to use the findByIdAndDelete() method in Mongoose to delete documents based on their unique _id:

Step 1. Install Mongoose Module:

You can visit the link to Install mongoose module. Run the following command in your terminal. This will install the latest version of Mongoose.

npm install mongoose

Step 2. Check Mongoose Version:

After installing mongoose module, we can check your mongoose version in command prompt using the command.

npm version mongoose

This ensures that Mongoose is installed correctly and shows the version in the command prompt.

Step 3. Create and Run the File:

• Create a New Folder: Create a new folder for your project (if not already created).
  
• Add a New File: Inside this folder, create a new JavaScript file (for example, index.js).
  
• Add the Code: Add the following code to your index.js file to use findByIdAndDelete(). Here’s an example demonstrating how to use the findByIdAndDelete() function to delete a document from the database:

const mongoose = require('mongoose');

// Database connection
mongoose.connect('mongodb://127.0.0.1:27017/geeksforgeeks', {
 useNewUrlParser: true,
 useCreateIndex: true,
 useUnifiedTopology: true
});

// User model
const User = mongoose.model('User', {
 name: { type: String },
 age: { type: Number }
});

// Find a document whose 
// id=5ebadc45a99bde77b2efb20e and remove it
var id = '5ebadc45a99bde77b2efb20e';
User.findByIdAndDelete(id, function (err, docs) {
 if (err){
 console.log(err)
 }
 else{
 console.log("Deleted : ", docs);
 }
});

Explanation:

• Database Connection: First, a connection to the MongoDB database is established using mongoose.connect().
• Model Definition: We define a User model with fields name and age.
• Delete Operation: The findByIdAndDelete() function is called with a specific id to find and delete the document matching that ID.
• Callback: The callback function handles the result of the operation. If the document is successfully deleted, it returns the deleted document; otherwise, it logs an error.

Run the File: Open your terminal and navigate to the folder where index.js is located. Run the following command to execute the file:

node index.js

The project structure will look like this: 👁 project structure

Make sure you have installed mongoose module using following command:

npm install mongoose

Step 4: Check the Database (Before Deletion)

Below is the sample data in the database before the function is executed, We can use any GUI tool or terminal to see the database, like we have used Robo3T GUI tool as shown below: 👁 Database

Step 5: Run the File

Run index.js file using below command. After running the above command, the document with the specified ID will be deleted from the database.

node index.js

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

Why Use findByIdAndDelete()?

• Efficiency: findByIdAndDelete() provides a straightforward, clean API for deleting documents based on their unique _id.
• Returns Deleted Document: It returns the deleted document, so you can easily log or process the result if needed.
• Compatibility: It is part of Mongoose’s modern API, ensuring compatibility with future updates and reducing reliance on deprecated methods like remove().

Conclusion

The findByIdAndDelete() method in Mongoose is a simple yet powerful tool to delete a document by its ID from MongoDB. Its clear syntax and modern implementation make it a preferred choice over older methods. Whether you're building user management features or cleaning up your database, findByIdAndDelete() offers an efficient and easy-to-use solution for deleting documents in Mongoose. By following the steps outlined above, you can easily integrate this method into your Node.js and Mongoose applications.