Open In App

Mongoose Query API.prototype.getFilter() Method

Improve
Improve
Like Article
Like
Save
Share
Report

The Mongoose Query API getFilter() method is used to return the current query filter which is applied to the mongoose query system.

Syntax:

Query.prototype.getFilter()

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 return the query filters applied to the mongoose query.

Filename: main.js

Javascript




// Importing the module
const mongoose = require('mongoose')
  
// Creating the 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: 20
    },
    {
        name: 'Nami',
        age: 20,
    },
    {
        name: 'Zoro',
        age: 35
    }
]
  
const Person = mongoose.model('Person', personSchema);
  
(async () => {
    const res = await Person.where({ age: 35 }).getFilter();
    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

Mongoose Query API.prototype.getFilter() Method

Mongoose Query API.prototype.getFilter() Method

Example 2: In this example, we will use this method to return the query filters applied to the mongoose query.

Filename: main.js

Javascript




// Importing the module
const mongoose = require('mongoose')
  
// Creating the 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: 20
    },
    {
        name: 'Nami',
        age: 20,
    },
    {
        name: 'Zoro',
        age: 35
    }
]
  
const Person = mongoose.model('Person', personSchema);
  
(async () => {
    const res = await Person
        .find({ age: 20 })
        .where('name')
        .equals('Luffy')
        .getQuery();
    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

Mongoose Query API.prototype.getFilter() Method

Mongoose Query API.prototype.getFilter() Method

Reference: https://mongoosejs.com/docs/api/query.html#query_Query-getFilter



Last Updated : 11 Jan, 2023
Like Article
Save Article
Previous
Next
Share your thoughts in the comments
Similar Reads