安装egg-sequelize
npm install egg-sequelize mysql2 --save // 下载mysql驱动插件
npm install sequelize-cli --save-dev // 下载sequelize管理工具
引入sequelize
- 在 config/plugin.js 中引入 egg-sequelize 插件
'use strict';
/** @type Egg.EggPlugin */
module.exports = {
// had enabled by egg
// static: {
// enable: true,
// }
sequelize:{
enable:true,
package:"egg-sequelize"
}
};
- 在 config/config.default.js 中编写 sequelize 配置
# 这里连接的是存服务数据的数据库
const config = exports = {
sequelize: {
dialect: "mysql",
host: "localhost", // 数据库地址
port: '3306',
database: "test-db", // 数据库名称
username: "root",
password: "",
timezone: "+08:00", // 东八时区
dialectOptions: {
useUTC: false // 输出为东八时区，但是不管用
}
}
};
初始化sequelize
- 创建相应数据库
- 在 egg 项目中，我们希望将所有数据库 Migrations 相关的内容都放在 database 目录下，所以我们在项目根目录下新建一个 .sequelizerc 配置文件：
# 指定目录地址
'use strict';
const path = require('path');
module.exports = {
config: path.join(__dirname, 'database/config.json'),
'migrations-path': path.join(__dirname, 'database/migrations'),
'seeders-path': path.join(__dirname, 'database/seeders'),
'models-path': path.join(__dirname, 'app/model'),
};
- 创建config.js、 migrations、seeders、models
# 创建sequelize配置数据库
npx sequelize init:config
# 创建migrations文件夹
npx sequelize init:migrations
# 创建种子数据文件夹
npx sequelize init:seeders
# 创建model文件夹
npx sequelize init:models
- 创建user数据表
npx sequelize migration:generate --name=init-user
在database/migrations文件夹下生成对应js文件
'use strict';
module.exports = {
up: async (queryInterface, Sequelize) => {
/**
* Add altering commands here.
*
* Example:
* await queryInterface.createTable('users', { id: Sequelize.INTEGER });
*/
const {INTEGER,STRING,DATE} = Sequelize;
await queryInterface.createTable("user",{
name:STRING,
age:INTEGER,
createAt:DATE,
updateAt:DATE
},{
freezeTableName:true, //强制表明不为复数
paranoid:true,
});
},
down: async (queryInterface, Sequelize) => {
/**
* Add reverting commands here.
*
* Example:
* await queryInterface.dropTable('users');
*/
await queryInterface.dropTable("user");
}
};
执行命令
npx sequelize db:migrate
完成
- 创建初始数据
执行命令
npx sequelize seed:generate --name seed-user
在database/seeders文件夹下生成对应js
'use strict';
module.exports = {
up: async (queryInterface, Sequelize) => {
/**
* Add seed commands here.
*
* Example:
* await queryInterface.bulkInsert('People', [{
* name: 'John Doe',
* isBetaMember: false
* }], {});
*/
return queryInterface.sequelize.transaction(async t => {
return await queryInterface.bulkInsert("user",[{name:"askwan",age:29},{name:"Bob",age:28}],{transaction:t});
})
},
down: async (queryInterface, Sequelize) => {
/**
* Add commands to revert seed here.
*
* Example:
* await queryInterface.bulkDelete('People', null, {});
*/
return queryInterface.sequelize.transaction(async t => {
return await queryInterface.bulkDelete("user",null,{transaction:t});
})
}
};
sequelize-cli 常用命令
# 通过命令行创建模型，使用 model:generate 命令
# name: 模型名称
# attributes: 模型的属性列表
# 创建模型 User, 模型包括属性 firstName、lastName、email
npx sequelize model:generate --name User --attributes firstName:string,lastName:string,email:string
# 创建模型 Role, 模型包括属性 roleName
npx sequelize model:generate --name Role --attributes roleName:string
# 数据库迁移
npx sequelize db:migrate
# 撤销上一次迁移操作
# 可使用 --name xxx 指定具体迁移
npx sequelize db:migrate:undo
# 撤销所有迁移操作
npx sequelize db:migrate:undo:all
# 创建种子，用于生成测试数据
npx sequelize seed:generate --name demo-role
npx sequelize seed:generate --name demo-user
# 插入演示数据到数据库种
npx sequelize db:seed:all
# 撤销指定种子文件
npx sequelize db:seed:undo --seed 指定种子文件
# 撤销所有种子文件
db:seed:undo:all
