Query and construct document with aliases with Model.translateAliases

[rkt2spc]

Follow up from #5321
Usage:

var Character = mongoose.model('Character', new mongoose.Schema({
  name: { type: String, alias: '名' },
  bio: {
    age: { type: Number, alias: '年齢' }
  }
}));

// The condition for the 'find' query will become { name: 'Stark', bio: { age: 40 } }
Character
  .find(Charater.translateAliases({
    '名': 'Stark',
    '年齢': 40
  })
  .exec((err, characters) => {})

// Can be use similarily when constructing new document
var char = new Character(Character.translateAliases({
  '名': 'Stark',
  '年齢': 40
});

[rkt2spc]

Maybe I should put it under Schema instead of Model?

[vkarpov15]

I'm not sure separating out dotted paths is the right behavior here. If you're querying by '年齢', you'd want to query 'bio.age': 30 rather than bio: { age: 30 }, because the latter will only match if bio is an object that contains exactly 1 key, age. On the other hand, 'bio.age': 30 would match even if bio has other keys, for example birthday.

[rkt2spc]

My bad, I was over thinking it
Do you prefer that I put it under schema instead of model?

[vkarpov15]

Hmm. I think schema is actually the better place to put the logic, but there should still be a helper function on model. But this code looks good, I'm gonna merge it into the 4.11 branch

[bencmbrook]

Any plans to have querying with aliases without additional query code?
e.g.

Person.findOne({ name: 'Ben' }, ...)

where

var personSchema = new Schema({
  n: {
    type: String,
    alias: 'name'
  }
});

Would be a great way to change schema without breaking existing query code

[rkt2spc]

Pre-hooks seems like a good way to implement transparent aliased queries. I'll look on to it next weekend

[vkarpov15]

Should be easy to implement as a plugin, but haven't tried. I appreciate the suggestion, but please open up a new issue instead of commenting on a closed one 👍