mongoose-aggregate-paginate-allowdiskuse
mongoose-aggregate-paginate-allowdiskuse
is a Mongoose plugin easy to add pegination for aggregates. It includes the optionallowDiskUse
for bigger queries. This plugin is to be used in combination with view pagination middleware such as express-paginate.
Index
Install
npm install mongoose-aggregate-paginate-allowdiskuse --save
Usage
This plugin must first be added to a schema:
var mongooseAggregatePaginate = ; mySchema;
MyModel
will have a new function called paginate
(e.g. MyModel.aggregatePaginate()
).
MyModel.aggregatePaginate(aggregate, options, callback)
Arguments
aggregate
- An object of the Mongoose aggregate.options
- An object with options for the Mongoose query, such as sortingpage
- Default:1
limit
- Default:10
sortBy
- Default:undefined
allowDiskUse
- Default:false
callback(err, results, pageCount, itemCount)
- A callback is called once pagination results are retrieved, or an error has occurred.
Examples
var MyModel = mongoose // find users above 18 by cityvar aggregate = MyModel;aggregatevar options = page : 1 limit : 15 allowDiskUse: true MyModel
Tests
npm test
Acknowlegements
mongoose-aggregate-paginate-allowdiskuse is based on mongoose-aggregate-paginate.
License
[travis-ci-url]: https://travis-ci.org/Maheshkumar-Kakade/mongoose-aggregate-paginate