Sequelize plugin for Egg.js,Based on egg-sequelize at present
NOTE: This plug-in integrates sequelize to egg.js on the basis of egg sequelize, provides dynamic database creation, realizes data dynamic deployment, and is perfectly compatible with all functions of the current egg sequelize plug-in more documentation please visit sequelize and egg-sequelize
egg-sequelize-plus | egg 1.x |
---|---|
1.x | 😁 |
0.x | ❌ |
$ npm i egg-sequelize-plus --save
If the egg project fails to start and reminds mysql2 or sequelize module that it cannot be found , just like this
could not find module 'mysql2'
// or
could not find module 'sequelize'
you can try the following command
$ npm install mysql2 --save
// or
$ npm install sequelize --save
// {app_root}/config/plugin.js
exports.sequelizePlus = {
enable: true,
package: 'egg-sequelize-plus',
};
// {app_root}/config/config.default.js
exports.sequelizePlus = {
dialect: 'mysql', // support: mysql, mariadb, postgres, mssql
database: 'test',
host: 'localhost', //default
port: 3306,
username: 'root', // default
password: 'root', // default
// delegate: 'myModel', // load all models to `app[delegate]` and `ctx[delegate]`, default to `model`
// baseDir: 'my_model', // load all files in `app/${baseDir}` as models, default to `model`
// exclude: 'index.js', // ignore `app/${baseDir}/index.js` when load models, support glob and array
// more sequelize options
logging: false,
options: {
timezone: 'Asia/Shanghai',
pool: {
maxConnections: 5,
},
},
};
You can also use the connection uri to configure the connection:
exports.sequelize = {
dialect: 'mysql', // support: mysql, mariadb, postgres, mssql
connectionUri: 'mysql://root:@127.0.0.1:3306/test',
// delegate: 'myModel', // load all models to `app[delegate]` and `ctx[delegate]`, default to `model`
// baseDir: 'my_model', // load all files in `app/${baseDir}` as models, default to `model`
// exclude: 'index.js', // ignore `app/${baseDir}/index.js` when load models, support glob and array
// more sequelize options
};
egg-sequelize has a default sequelize options below
{
delegate: 'model',
baseDir: 'model',
logging(...args) {
// if benchmark enabled, log used
const used = typeof args[1] === 'number' ? `[${args[1]}ms]` : '';
app.logger.info('[egg-sequelize]%s %s', used, args[0]);
},
host: 'localhost',
port: 3306,
username: 'root',
benchmark: true,
define: {
freezeTableName: false,
underscored: true,
},
}
see config/config.default.js for more detail and default config
Please put models under app/model
dir by default.
model file | class name |
---|---|
user.js |
app.model.User |
person.js |
app.model.Person |
user_group.js |
app.model.UserGroup |
user/profile.js |
app.model.User.Profile |
created_at datetime
, updated_at datetime
.user_id
, comments_count
.Define a model first.
NOTE:
options.delegate
default tomodel
, soapp.model
is an Instance of Sequelize, so you can use methods like:app.model.sync, app.model.query ...
// app/model/user.js
module.exports = app => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const User = app.model.define('user', {
login: STRING,
name: STRING(30),
password: STRING(32),
age: INTEGER,
last_sign_in_at: DATE,
created_at: DATE,
updated_at: DATE,
});
User.findByLogin = async function(login) {
return await this.findOne({
where: {
login: login
}
});
}
// don't use arraw function
User.prototype.logSignin = async function() {
return await this.update({
last_sign_in_at: new Date()
});
}
return User;
};
Now you can use it in your controller:
// app/controller/user.js
class UserController extends Controller {
async index() {
const users = await this.ctx.model.User.findAll();
this.ctx.body = users;
}
async show() {
const user = await this.ctx.model.User.findByLogin(this.ctx.params.login);
await user.logSignin();
this.ctx.body = user;
}
Define all your associations in Model.associate()
and egg-sequelize will execute it after all models loaded. See example below.
egg-sequelize support load multiple datasources independently. You can use config.sequelize.datasources
to configure and load multiple datasources.
// config/config.default.js
exports.sequelize = {
datasources: [{
delegate: 'model', // load all models to app.model and ctx.model
baseDir: 'model', // load models from `app/model/*.js`
database: 'biz', // other sequelize configurations
},
{
delegate: 'admninModel', // load all models to app.adminModel and ctx.adminModel
baseDir: 'admin_model', // load models from `app/admin_model/*.js`
database: 'admin', // other sequelize configurations
}]
};
Then we can define model like this:
// app/model/user.js
module.exports = app => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const User = app.model.define('user', {
login: STRING,
name: STRING(30),
password: STRING(32),
age: INTEGER,
last_sign_in_at: DATE,
created_at: DATE,
updated_at: DATE,
});
return User;
};
// app/admin_model/user.js
module.exports = app => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const User = app.adminModel.define('user', {
login: STRING,
name: STRING(30),
password: STRING(32),
age: INTEGER,
last_sign_in_at: DATE,
created_at: DATE,
updated_at: DATE,
});
return User;
};
If you define the same model for different datasource, the same model file will be excute twice for different database, so we can use the secound argument to get the sequelize instance:
// app/model/user.js
// if this file will load multiple times for different datasource
// we can use the secound argument to get the sequelize instance
module.exports = (app, model) => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const User = model.define('user', {
login: STRING,
name: STRING(30),
password: STRING(32),
age: INTEGER,
last_sign_in_at: DATE,
created_at: DATE,
updated_at: DATE,
});
return User;
};
By default, egg-sequelize will use sequelize@5, you can cusomize sequelize version by pass sequelize instance with config.sequelize.Sequelize
like this:
// config/config.default.js
exports.sequelize = {
Sequelize: require('sequelize');
};
// app/model/post.js
module.exports = app => {
const { STRING, INTEGER, DATE } = app.Sequelize;
const Post = app.model.define('Post', {
name: STRING(30),
user_id: INTEGER,
created_at: DATE,
updated_at: DATE, });
Post.associate = function() {
app.model.Post.belongsTo(app.model.User, {
as: 'user'
});
}
return Post;
};
// app/controller/post.js
class PostController extends Controller { a
async index() {
const posts = await this.ctx.model.Post.findAll({
attributes: [ 'id', 'user_id' ],
include: { model: this.ctx.model.User, as: 'user' },
where: { status: 'publish' },
order: 'id desc', });
this.ctx.body = posts;
}
async show() {
const post = await this.ctx.model.Post.findByPk(this.params.id); const user = await post.getUser();
post.setDataValue('user', user);
this.ctx.body = post;
}
async destroy() {
const post = await this.ctx.model.Post.findByPk(this.params.id); await post.destroy();
this.ctx.body = {
success: true
};
}
}
We strongly recommend you to use Sequelize - Migrations to create or migrate database.
This code should only be used in development.
// {app_root}/app.js
module.exports = app => {
if (app.config.env === 'local' || app.config.env === 'unittest') {
app.beforeStart(async () => {
await app.model.sync({force: true});
});
}};
Please open an issue here.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。