How to paginate with Mongoose in Node js

Question

I am writing a webapp with Node js and mongoose  How can I paginate the results I get from a  find   call  I would like a functionality comparable to  LIMIT 50 100  in SQL

User · Answer

In this case  you can add the query page and  or limit to your URL as a query string    For example   page 0 amp limit 25    this would be added onto your URL  http localhost 5000 page 0 amp limit 25    Since it would be a String we need to convert it to a Number for our calculations  Let s do it using the parseInt method and let s also provide some default values   const pageOptions         page  parseInt req query page  10     0      limit  parseInt req query limit  10     10    sexyModel find        skip pageOptions page   pageOptions limit       limit pageOptions limit       exec function  err  doc            if err    res status 500  json err   return             res status 200  json doc             BTW  Pagination starts with 0

User · Answer

After taking a closer look at the Mongoose API with the information provided by Rodolphe  I figured out this solution   MyModel find query  fields    skip  10  limit  5    function err  results

User · Answer

The best approach  IMO  is to use skip and limit BUT within a limited collections or documents    To make the query within limited documents  we can use specific index like index on a DATE type field  See that below  let page   ctx request body page    1 let size   ctx request body size    10 let DATE FROM   ctx request body date from let DATE TO   ctx request body date to  var start    parseInt page  - 1    parseInt size   let result   await Model find   created at     lte  DATE FROM   gte  DATE TO           sort    id  -1         select   lt fields gt         skip  start        limit  size                exec callback

User · Answer

Pagination using mongoose  express and jade - Here s a link to my blog with more detail  var perPage   10     page   Math max 0  req params page   Event find        select  name        limit perPage       skip perPage   page       sort           name   asc              exec function err  events            Event count   exec function err  count                res render  events                     events  events                  page  page                  pages  count   perPage

User · Answer

Using ts-mongoose-pagination      const trainers   await Trainer paginate            user  req userId                          perPage  3              page  1              select   -password  -createdAt -updatedAt -  v               sort    createdAt  -1                         return res status 200  json trainers

User · Answer

Here is a version that I attach to all my models  It depends on underscore for convenience and async for performance  The opts allows for field selection and sorting using the mongoose syntax   var     require  underscore    var async   require  async     function findPaginated filter  opts  cb      var defaults    skip   0  limit   10     opts     extend     defaults  opts      filter     extend     filter      var cntQry   this find filter     var qry   this find filter      if  opts sort        qry   qry sort opts sort         if  opts fields        qry   qry select opts fields          qry   qry limit opts limit  skip opts skip      async parallel              function  cb            cntQry count cb                  function  cb            qry exec cb                      function  err  results          if  err  return cb err         var count   0  ret                each results  function  r            if  typeof r      number               count   r            else if  typeof r      number               ret   r                             cb null   totalCount   count  results   ret                  return qry      Attach it to your model schema   MySchema statics findPaginated   findPaginated

User · Answer

Simple and powerful pagination solution  async getNextDocs no of docs required  number  last doc id   string        let docs      if   last doc id               get first 5 docs         docs   await MySchema find   sort    id  -1    limit no of docs required            else              get next 5 docs according to that last document id         docs   await MySchema find   id    lt  last doc id                                         sort    id  -1    limit no of docs required            return docs     last doc id  the last document id that you get  no of docs required  the number of docs that you want to fetch i e  5  10  50 etc    If you don t provide the last doc id to the method  you ll get i e  5 latest docs If you ve provided the last doc id then you ll get the next i e  5 documents

User · Answer

A solid approach to implement this would be to pass the values from the frontend using a query string  Let s say we want to get page  2 and also limit the output to 25 results  The query string would look like this   page 2 amp limit 25    this would be added onto your URL  http localhost 5000 page 2 amp limit 25    Let s see the code      We would receive the values with req query  lt  lt valueName gt  gt     gt  e g  req query page    Since it would be a String we need to convert it to a Number in order to do our    necessary calculations  Let s do it using the parseInt   method and let s also provide some default values     const page   parseInt req query page  10     1     getting the  page  value   const limit   parseInt req query limit  10     25     getting the  limit  value   const startIndex    page - 1    limit     this is how we would calculate the start index aka the SKIP value   const endIndex   page   limit     this is how we would calculate the end index     We also need the  total  and we can get it easily using the Mongoose built-in   countDocuments   method   const total   await  lt  lt modelName gt  gt  countDocuments        skip   will return a certain number of results after a certain number of documents     limit   is used to specify the maximum number of results to be returned      Let s assume that both are set  if that s not the case  the default value will be used for     query   query skip startIndex  limit limit         Executing the query   const results   await query        Pagination result      Let s now prepare an object for the frontend   const pagination           If the endIndex is smaller than the total number of documents  we have a next page   if  endIndex  lt  total        pagination next           page  page   1        limit                If the startIndex is greater than 0  we have a previous page   if  startIndex  gt  0        pagination prev           page  page - 1        limit                 Implementing some final touches and making a successful response  Express js   const advancedResults         success  true      count  results length      pagination      data  results       That s it  All we have to do now is send the  results  to the frontend   res status 200  json advancedResults       I would suggest implementing this logic into middleware so you can be able to use it for various routes  controllers

User · Answer

Use this simple plugin   https   github com WebGangster mongoose-paginate-v2  Installation   x000D   x000D  npm install mongoose-paginate-v2 x000D   x000D   x000D   Usage     Add plugin to a schema and then use model paginate method    x000D   x000D  const mongoose           require  mongoose    x000D  const mongoosePaginate   require  mongoose-paginate-v2    x000D   x000D  const mySchema   new mongoose Schema    x000D       your schema definition     x000D      x000D   x000D  mySchema plugin mongoosePaginate   x000D   x000D  const myModel   mongoose model  SampleModel    mySchema    x000D   x000D  myModel paginate   then        Usage x000D   x000D   x000D

User · Answer

This is example function for getting the result of skills model with pagination and limit options   export function get skills req  res        console log  get skills         var page   req body page     1 or 2      var size   req body size     5 or 10 per page      var query            if page  lt  0    page     0                 result     status   401  message   invalid page number should start with 1            return res json result               query skip   size    page - 1       query limit   size      Skills count    function err1 tot count     to get the total count of skills       if err1                   res json               status  401              message  something went wrong                err  err                            else                   Skills find       query  sort   name  1   exec function err skill doc                if  err                                  res json                        status  200                       message  Skills list                        data  data                       tot count  tot count                                                  else                                 res json                         status  401                        message   something went wrong                         err  err                                                 Skills find end             Skills count end

User · Answer

localhost 3000 asanas  pageNo 1 amp size 3      requiring asanas model const asanas   require     models asanas      const fetchAllAsanasDao        gt        return new Promise  resolve  reject    gt         var pageNo   parseInt req query pageNo       var size   parseInt req query size       var query               if  pageNo  lt  0    pageNo     0                response                      error   true                   message    invalid page number  should start with 1                             return res json response                     query skip   size    pageNo - 1           query limit   size     asanas              find pageNo   size   query           then  asanasResult    gt                    resolve asanasResult                               catch  error    gt                    reject error

User · Answer

Above answer s holds good       Just an add-on for anyone who is into async-await rather than   promise      const findAllFoo   async  req  resp  next    gt        const pageSize   10      const currentPage   1       try           const foos   await FooModel find      find all documents              skip pageSize    currentPage - 1      we will not retrieve all records  but will skip first  n  records              limit pageSize      will limit restrict the number of records to display          const numberOfFoos   await FooModel countDocuments       count the number of records for that model          resp setHeader  max-records   numberOfFoos           resp status 200  json foos          catch  err            resp status 500  json               message  err

User · Answer

Query  search   productName  Params  page   1    Pagination router get  quot  search  page quot    req  res  next    gt      const resultsPerPage   5    const page   req params page  gt   1   req params page   1    const query   req query search    page   page - 1     Product find   name  query         select  quot name quot        sort   name   quot asc quot          limit resultsPerPage       skip resultsPerPage   page       then  results    gt          return res status 200  send results               catch  err    gt          return res status 500  send err

User · Answer

The easiest and more speedy way is  paginate with the objectId Example   Initial load condition  condition    limit 12  type        Take the first and last ObjectId from response data  Page next condition  condition    limit 12  type  next   firstId  57762a4c875adce3c38c662d   lastId  57762a4c875adce3c38c6615      Page next condition  condition    limit 12  type  next   firstId  57762a4c875adce3c38c6645   lastId  57762a4c875adce3c38c6675      In mongoose  var condition           var sort      id  1        if  req body type     next             condition  id      gt  req body lastId          else if  req body type     prev             sort      id  -1            condition  id      lt  req body firstId           var query   Model find condition        sort  sort    limit req body limit    query exec function err  properties            return res json    result   result

User · Answer

This is a sample example you can try this     var  pageNumber   2     pageSize   50   Student count    function err count     Student find     null        sort          Name  1            skip  pageNumber  gt  0      pageNumber - 1     pageSize    0  limit  pageSize  exec function err  docs        if  err        res json err       else       res json            TotalCount   count            Array   docs

User · Answer

You can chain just like that   var query   Model find   sort  mykey   1  skip 2  limit 5    Execute the query using exec  query exec callback

User · Answer

There are some good answers giving the solution that uses skip    amp  limit    however  in some scenarios  we also need documents count to generate pagination  Here s what we do in our projects  const PaginatePlugin    schema  options    gt      options   options         schema query paginate   async function params        const pagination           limit  options limit    10        page  1        count  0           pagination limit   parseInt params limit     pagination limit     const page   parseInt params page      pagination page   page  gt  0   page   pagination page     const offset    pagination page - 1    pagination limit      const  data  count    await Promise all         this limit pagination limit  skip offset         this model countDocuments this getQuery                pagination count   count      return   data  pagination          mySchema plugin PaginatePlugin    limit  DEFAULT LIMIT        using async await const   data  pagination     await MyModel find         populate         sort         paginate   page  1  limit  10        or using Promise MyModel find      paginate req query     then    data  pagination      gt             catch err   gt

User · Answer

You can either use skip   and limit    but it s very inefficient  A better solution would be a sort on indexed field plus limit     We at Wunderflats have published a small lib here  https   github com wunderflats goosepage It uses the first way

User · Answer

You can do using mongoose-paginate-v2  For more info click here const mongoose           require  mongoose    const mongoosePaginate   require  mongoose-paginate-v2     const mySchema   new mongoose Schema          your schema code      mySchema plugin mongoosePaginate    const myModel   mongoose model  SampleModel    mySchema    myModel paginate   then        Usage

User · Answer

This is what I done it on code  var paginate   20  var page   pageNumber  MySchema find     sort  mykey   1  skip  pageNumber-1  paginate  limit paginate       exec function err  result               Write some stuff here           That is how I done it

User · Answer

let page limit skip lastPage  query   page   req params page  1    1     This is the page fetch from the server  limit   req params limit   1    1      This is the limit  it also fetch from the server  skip    page - 1    limit       Number of skip document  lastPage   page   limit      last index   counts   await userModel countDocuments     Number of document in the collection  query   query skip skip  limit limit    current page  const paginate         For previous page if skip  gt  0       paginate prev            page  page - 1         limit  limit      For next page  if lastPage  lt  counts      paginate next          page  page   1       limit  limit   results   await query   Here is the final results of the query

User · Answer

You can write query like this     mySchema find   skip  page-1  per page  limit per page  exec function err  articles            if  err                return res status 400  send                   message  err                           else               res json articles                       page   page number coming from client as request parameters  per page   no of results shown per page   If you are using MEAN stack following blog post provides much of the information to create pagination in front end using angular-UI bootstrap and using mongoose skip and limit methods in the backend   see    https   techpituwa wordpress com 2015 06 06 mean-js-pagination-with-angular-ui-bootstrap

User · Answer

app get    page   req res   gt           post find     then  data   gt               let per page   5              let num page   Number req params page               let max pages   Math ceil data length per page               if num page    0    num page  gt  max pages                   res render  404                 else                  let starting   per page  num page-1                  let ending   per page starting                 res render  posts    posts data slice starting ending   pages  max pages  current page  num page

User · Answer

Was able to achieve results with async await as well   Code example below using an async handler with hapi v17 and mongoose v5                method   GET               path    api v1 paintings               config                    description   Get all the paintings                   tags    api    v1    all paintings                              handler  async  request  reply    gt                                          Grab the querystring parameters                    page and limit to handle our pagination                                    var pageOptions                         page  parseInt request query page  - 1    0                       limit  parseInt request query limit     10                                                         Apply our sort and limit                                   try                       return await Painting find                            sort  dateCreated  1  dateModified  -1                            skip pageOptions page   pageOptions limit                           limit pageOptions limit                           exec                     catch err                       return err

User · Answer

I m am very disappointed by the accepted answers in this question  This will not scale  If you read the fine print on cursor skip         The cursor skip   method is often expensive because it requires the server to walk from the beginning of the collection or index to get the offset or skip position before beginning to return result  As offset  e g  pageNumber above  increases  cursor skip   will become slower and more CPU intensive  With larger collections  cursor skip   may become IO bound    To achieve pagination in a scaleable way combine a limit    along with at least one filter criterion  a createdOn date suits many purposes    MyModel find    createdOn     lte  request createdOnBefore        limit  10    sort   -createdOn

User · Answer

If you are using mongoose as a source for a restful api have a look at   restify-mongoose  and its queries  It has exactly this functionality built in    Any query on a collection provides headers that are helpful here   test-01    curl -s -D - localhost 3330 data sort -created -o  dev null HTTP 1 1 200 OK link   lt  data sort -created amp p 0 gt   rel  first    lt  data sort -created amp p 1 gt   rel  next    lt  data sort -created amp p 134715 gt   rel  last        Response-Time  37   So basically you get a generic server with a relatively linear load time for queries to collections  That is awesome and something to look at if you want to go into a own implementation

User · Answer

You can use a little package called Mongoose Paginate that makes it easier     npm install mongoose-paginate   After in your routes or controller  just add           querying for  all     items in  MyModel     paginating by second page  10 items per page  10 results  page 2        MyModel paginate     2  10  function error  pageCount  paginatedResults      if  error        console error error       else       console log  Pages    pageCount       console log paginatedResults

User · Answer

Most easiest plugin for pagination   https   www npmjs com package mongoose-paginate-v2  Add plugin to a schema and then use model paginate method   var mongoose           require  mongoose    var mongoosePaginate   require  mongoose-paginate-v2     var mySchema   new mongoose Schema           your schema definition          mySchema plugin mongoosePaginate    var myModel   mongoose model  SampleModel    mySchema     myModel paginate   then        Usage

User · Answer

Try using mongoose function for pagination  Limit is the number of records per page and number of the page   var limit   parseInt body limit   var skip    parseInt body page -1    parseInt limit     db Rankings find                  sort  -id                limit limit               skip skip               exec function err wins

User · Answer

you can use the following line of code as well  per page   parseInt req query per page     10 page no   parseInt req query page no     1 var pagination       limit  per page     skip per page    page no - 1    users   await User find   lt CONDITION gt    limit pagination limit  skip pagination skip  exec     this code will work in latest version of mongo

[mongodb] How to paginate with Mongoose in Node.js?

Examples related to mongodb

Examples related to node.js

Examples related to mongoose

[mongodb] How to paginate with Mongoose in Node.js?

Examples related to mongodb

Examples related to node.js

Examples related to pagination

Examples related to mongoose