@lykmapipo/mongoose-aggregatable

    0.4.0 • Public • Published

    mongoose-aggregatable

    Build Status Dependencies Status Coverage Status GitHub License

    Commitizen Friendly code style: prettier Code Style npm version

    mongoose plugin to add aggregations behaviour.

    Requirements

    Install

    $ npm install --save mongoose @lykmapipo/mongoose-aggregatable

    Usage

    import mongoose from 'mongoose';
    import aggregatable from '@lykmapipo/mongoose-aggregatable';
    
    const PersonSchema = new Schema({
      name: { type: String },
      father: { type: ObjectId, ref: 'Person', aggregatable: true },
      mother: { type: ObjectId, ref: 'Person', aggregatable: true },
      sister: { type: ObjectId, ref: 'Person', aggregatable: true },
      brother: { type: ObjectId, aggregatable: { from: 'people' } },
      relatives: { type: [ObjectId], ref: 'Person', aggregatable: true },
      friends: [{ type: ObjectId, ref: 'Person', aggregatable: true }]
    });
    PersonSchema.plugin(aggregatable);
    const Person = mongoose.model('Person', PersonSchema);
    
    const aggregate = Person.lookup();
    aggregate.exec((error, people) => { ... });

    API

    aggregatable(schema: Schema, [options: Object])

    An aggregatable schema plugin. Once applied to a schema will allow to perform aggrgation from aggregatable schema field and add lookup model static method.

    options: Object

    • allowDiskUse: Boolean - Enable aggregation disk usage. Default to true.

    Example

    const PersonSchema = new Schema({
      name: { type: String },
      father: { type: ObjectId, ref: 'Person', aggregatable: true },
      mother: { type: ObjectId, ref: 'Person', aggregatable: true },
      sister: { type: ObjectId, ref: 'Person', aggregatable: true },
      brother: { type: ObjectId, aggregatable: { from: 'people' } },
      relatives: { type: [ObjectId], ref: 'Person', aggregatable: true },
      friends: [{ type: ObjectId, ref: 'Person', aggregatable: true }]
    });
    PersonSchema.plugin(aggregatable);
    const Person = mongoose.model('Person', PersonSchema);

    lookup([criteria: Object]) : Aggregate

    Initialize aggregations on the model using aggregatable paths and return mongoose Aggregate instance.

    Example:

    const aggregate = Person.lookup();
    aggregate.exec((error, people) => { ... });

    Schema Options

    Each aggregatable field/path can define below options

    • from: String - Specifies the collection in the same database to perform the lookup with. If not specified ref will be used to compute model collection name to lookup. See
    • foreignField: String - Specifies the field from the documents in the from collection. If not specified _id will be used. See

    Example

    const PersonSchema = new Schema({
      name: { type: String },
      father: { type: ObjectId, ref: 'Person', aggregatable: true }
    });
    
    const PersonSchema = new Schema({
      name: { type: String },
      brother: { type: ObjectId, aggregatable: { from: 'people' } }
    });
    
    const PersonSchema = new Schema({
      name: { type: String },
      brother: { type: ObjectId, aggregatable: { from: 'people', foreignField: '_id' } }
    });

    Testing

    • Clone this repository

    • Install all development dependencies

    $ npm install
    • Then run test
    $ npm test

    References

    Contribute

    It will be nice, if you open an issue first so that we can know what is going on, then, fork this repo and push in your ideas. Do not forget to add a bit of test(s) of what value you adding.

    Licence

    The MIT License (MIT)

    Copyright (c) lykmapipo & Contributors

    Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

    The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

    THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    Install

    npm i @lykmapipo/mongoose-aggregatable

    DownloadsWeekly Downloads

    57

    Version

    0.4.0

    License

    MIT

    Unpacked Size

    57.4 kB

    Total Files

    19

    Last publish

    Collaborators

    • lykmapipo