egg-objection v1.0.5

egg-objection

Install

$ npm i egg-objection --save
# 从下面选择一种
$ npm install pg
$ npm install sqlite3
$ npm install mysql
$ npm install mysql2
$ npm install mariasql

Usage

// {app_root}/config/plugin.js
exports.objection = {
  enable: true,
  package: 'egg-objection',
};

// {app_root}/config/config.default.js
config.objection = {
  client: {
    knex: {
      client: 'mysql2', // pg/sqlite3/mysql/mysql2/mariasql
      connection: {
        host: '127.0.0.1',
        user: 'root',
        password: 'password_example',
        database: 'example',
      },
    },
    delegate: 'model', // 注入model到app[delegate]
    baseDir: 'model', // model文件目录
  },
};

see config/config.default.js for more detail.
see Objection Doc for more doc

Example

在app/model新建model

// app/model/user.js

'use strict';

module.exports = app => {
  class User extends app.model {
    static get tableName() {
      return 'users';
    }
  };
  return User;
}

在controller里使用

// app/controller/home.js

'use strict';

const Controller = require('egg').Controller;

class HomeController extends Controller {
  async index() {
    const users = await this.ctx.model.User.query().orderBy('id');
    this.ctx.body = users;
  }
}

module.exports = HomeController;

License

MIT