orm-paging

ORM Pagination Helper

npm install orm-paging
4 downloads in the last day
33 downloads in the last week
93 downloads in the last month

ORM Pagination Helper Plugin

This plugin adds a pagination helper function for ORM.

Dependencies

Of course you need orm to use it. Other than that, no more dependencies.

Install

npm install orm-paging

DBMS Support

Any driver supported by ORM is supported by this plugin.

Usage

Model.pages(cb)   // total pages
Model.page(page) // get page

Example

var orm = require("orm");
var paging = require("orm-paging");

orm.connect("mysql://username:password@host/database", function (err, db) {
    if (err) throw err;

    db.use(paging);

    var Person = db.define("person", {
        name      : String,
        surname   : String,
        age       : Number
    });
    Person.settings.set("pagination.perpage", 10); // default is 20

    Person.pages(function (err, pages) {
        console.log("Total pages: %d", pages);

        Person.page(3).order("name").run(function (err, people) {
            // should get you page 3, which means people from index 20 to 29 (ordered by name)
        });
    });
});
npm loves you