The Mongoose Query API remove() method is used to remove single or multiple documents, from a collection using the MongoDB query system.
Syntax:
Query.prototype.remove(filter, callback)
Parameters: It accepts the following 2 parameters as mentioned above and described below:
- filter: It is a mongoose object which identifies the existing document(s) to remove.
- callback: It is a callback function that accepts 2 parameters, error and mongooseDeleteResult.
Return type: It returns a Query object as a response.
Creating node application And Installing Mongoose:
Step 1: Create a node application using the following command:
mkdir folder_name cd folder_name npm init -y touch main.js
Step 2: After completing the Node.js application, Install the required module using the following command:
npm install mongoose
Example 1: In this example, we will use this method to remove existing documents that have an age less than “20”.
Filename: main.js
const mongoose = require( 'mongoose' )
// Database connection {
dbName: 'event_db' ,
useNewUrlParser: true ,
useUnifiedTopology: true
}, err => err ? console.log(err)
: console.log( 'Connected to database' ));
const personSchema = new mongoose.Schema({
name: {
type: String,
},
age: {
type: Number,
}
}); const personsArray = [ {
name: 'Luffy' ,
age: 19
},
{
name: 'Nami' ,
age: 20,
},
{
name: 'Zoro' ,
age: 35
}
] const Person = mongoose.model( 'Person' , personSchema);
(async () => { await Person.insertMany(personsArray);
const res = await Person.where({ age: { $lt: 20 } }).remove();
console.log({ res });
})() |
Step to Run Application: Run the application using the following command from the root directory of the project:
node main.js
Output:
GUI Representation of the Database using MongoDB Compass:
Example 2: In this example, we will use this method to remove an existing document that has the name “Luffy”.
Filename: main.js
const mongoose = require( 'mongoose' )
// Database connection {
dbName: 'event_db' ,
useNewUrlParser: true ,
useUnifiedTopology: true
}, err => err ? console.log(err)
: console.log( 'Connected to database' ));
const personSchema = new mongoose.Schema({
name: {
type: String,
},
age: {
type: Number,
}
}); const personsArray = [ {
name: 'Luffy' ,
age: 19
},
{
name: 'Nami' ,
age: 20,
},
{
name: 'Zoro' ,
age: 35
}
] const Person = mongoose.model( 'Person' , personSchema);
(async () => { await Person.insertMany(personsArray);
const res = await Person.where({ name: "Luffy" }).remove();
console.log({ res });
})() |
Step to Run Application: Run the application using the following command from the root directory of the project:
node main.js
Output:
GUI Representation of the Database using MongoDB Compass:
Reference: https://mongoosejs.com/docs/api/query.html#query_Query-remove