Mongoose optional search query parameters?

Question

I have a following situation. I need to build a mongoose query, based on certain arguments if present.

I.e. if object like this is passed

{
    player: "nickname",
    action: "capture"
}

the following search is performed:

Entry.find({
    player: obj.player,
    action: obj.action
}).
    exec(function(err, res){
        console.log(res);
    });

If I need to exclude "action" from search if action is not in the object, what should I do? Using ternary operator like action: (obj.action) ? obj.action:null doesn't work, as would search entries in DB where action is null.

JohnnyHK · Accepted Answer · 2015-08-13 19:00:40Z

44

Build up your query object programmatically:

var query = {
    player: 'player'
};

if (obj.action) {
    query.action = obj.action;
}

Entry.find(query).exec(function(err, res){
    console.log(res);
});

answered Aug 13, 2015 at 19:00

JohnnyHK

313k70 gold badges632 silver badges479 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

fivepointseven Over a year ago

Wow, didn't even think of that. Thanks a lot!

himani1349 Over a year ago

Does the order of fields in the query so created and the Entry model matter?

himani1349 Over a year ago

@JohnnyHK thanks.. and do you know if I want to search values greater than a particular range in this query-say there is a field called "budget" and we need to find all budgets greater than the given value?

Mr5o1 · Accepted Answer · 2019-12-14 22:41:00Z

10

With ES6, you can do this with a splat & ternary like this:

Entry.find({
  player: obj.player,
  ...obj.action ? { action: obj.action } : {}
})
.exec(function(err, res){
    console.log(res);
});

answered Dec 14, 2019 at 22:41

Mr5o1

1,8182 gold badges16 silver badges23 bronze badges

1 Comment

Essameldeen Youssef Over a year ago

I favor this as it is a 1 liner

fivepointseven · Accepted Answer · 2015-08-13 18:41:45Z

5

In case someone encounters same question, here's how I solved it:

var query = {
    player: 'player'
};

Entry.find({
    player: query.player,
    action: (query.action) ? query.action:/.*/
}).
    exec(function(err, res){
        console.log(res);
    });

answered Aug 13, 2015 at 18:41

fivepointseven

1,0512 gold badges11 silver badges23 bronze badges

2 Comments

JohnnyHK Over a year ago

A downside to this approach is that using the regex will hurt query performance. It's better to just omit the field from the query.

Mr5o1 Over a year ago

@JohnnyHK that's correct. 4 years on with ES6, you can avoid the regex with a splat & ternary

Collectives™ on Stack Overflow

Mongoose optional search query parameters?

3 Answers 3

3 Comments

1 Comment

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

1 Comment

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related