mongoose-find-by-reference

English | 简体中文

This is a Mongoose plugin that allows your Mongoose to support lookup on reference fields.

Reference field is like this:

{
    type: MongooseSchema.Types.ObjectId,
    ref: 'XXX',
  }

Its principle is to parse your find request. When it finds that you want to filter the value of the reference field, it will read the model corresponding to the reference field and perform the search, obtain the id array that matches the filter, and then put the reference field The filter of the value is replaced by the judgment of whether the value of the reference field is in the id array.

install

npm i -S mongoose-find-by-reference

usage

The mongoose-find-by-reference module exposes a single function that you can pass to Mongoose schema's plugin() function.

const { MongooseFindByReference } = require("mongoose-find-by-reference");
const schema = new mongoose.Schema({
  /* ... */
});
schema.plugin(MongooseFindByReference);

Then, you can use it like this.

const result = await catModel
  .find({
    $and: {
      parents: {
        "owner.name": "Dean",
      },
      sex: 0,
    },
  })
  .exec();

Its conditions will be automatically replaced with:

const newConditions = {
  $and: {
    parents: {
      $in: [
        /* ObjectIDs for Eligible Cats */
      ],
    },
    sex: 0,
  },
};

need help

Now this project needs everyone's help, and there is currently a lack of testing.

Thanks to:

Thanks you so much for your contribution! 🎉 I appreciate your time and effort in submitting the pull request. Your changes are valuable, and we're grateful for your commitment to improving our project. If you have any further suggestions or if there's anything else you'd like to contribute, please feel free to let me know. Thanks again! 🙌