How to paginate with mongoose in node js

When using Mongoose for pagination search, two key concepts are typically involved: limit and skip. These parameters can be used in MongoDB queries to achieve pagination. limit restricts the number of query results, while skip skips a specified number of documents.

The following are the steps to implement pagination with Mongoose:

1. Determine the page size (i.e., limit): This specifies the number of records to display per page.
2. Calculate the number of documents to skip (i.e., skip): This is derived from the current page number to determine how many records to bypass. For example, if displaying 10 records per page, the number of documents to skip for page 2 is 10 * (current page number - 1).

Example Code

Here is a simple example demonstrating how to implement pagination search using Mongoose:

javascript
const mongoose = require('mongoose');
const { Schema } = mongoose;

// Assume we have a user model
const UserSchema = new Schema({
  name: String,
  age: Number,
  // More fields...
});

const User = mongoose.model('User', UserSchema);

// Pagination function
async function findUsersWithPagination(page, limit) {
  try {
    // Calculate the number of documents to skip
    const skip = (page - 1) * limit;

    // Retrieve the paginated data
    const users = await User.find()
      .skip(skip)   // Skip preceding documents
      .limit(limit) // Restrict returned documents
      .exec();      // Execute the query

    // Retrieve the total document count to calculate total pages
    const count = await User.countDocuments();

    return {
      total: count,           // Total document count
      perPage: limit,         // Records per page
      currentPage: page,      // Current page number
      totalPages: Math.ceil(count / limit), // Total pages
      data: users             // Current page data
    };
  } catch (error) {
    throw error;
  }
}

// Use the pagination function, e.g., to retrieve page 2 with 5 records per page
findUsersWithPagination(2, 5).then(paginatedResults => {
  console.log(paginatedResults);
}).catch(err => {
  console.error(err);
});

In this example, the findUsersWithPagination function accepts page and limit as parameters to adjust the query. It first calculates the number of documents to skip, then applies the skip and limit methods to the query. Finally, it retrieves the total document count to provide detailed pagination information.

Additionally, in practical applications, you may need to consider sorting issues to ensure consistent document ordering, which can typically be achieved by using the .sort() method in the find query.

Furthermore, if handling large datasets, frequent use of skip may lead to performance issues because skip causes the database to traverse more documents. In such cases, you might consider using cursors or other pagination strategies.