README.zh_CN.md

egg-mysql-paginator

为 egg-mysql 提供分页功能

安装

$ npm i egg-mysql-paginator --save

依赖说明

依赖的 egg 版本

egg-mysql-paginator 版本	egg 2.x
2.x	😁
1.x	❌

依赖的插件

• mysql

开启插件

// config/plugin.js
exports.mysqlPaginator = {
  enable: true,
  package: 'egg-mysql-paginator',
};

使用指南

// 查询
const results = await app.mysqlPaginator.query('posts',{
  where: { status: 'draft' },
  orders: [['created_at','desc'], ['id','desc']],
  page: 1,
  size: 10
});
// 结果
  {
    pagination: {
      total: 21,
      size: 10,
      currentPage: 1,
      lastPage: 3,
      from: 0,
      to: 10
    },
    data: [...]
  }

模糊查询

const results = await app.mysqlPaginator.query('posts',{
  where: 'WHERE name LIKE %name%',
  orders: [['created_at','desc'], ['id','desc']],
  page: 1,
  size: 10
});

自定排序字段

const results = await app.mysqlPaginator.query('posts',{
  where: 'WHERE name LIKE %name%',
  orders: 'rank+',
  page: 1,
  size: 10
});

License

MIT