迁移

(文档)[https://github.com/demopark/sequelize-docs-Zh-CN/blob/v5/migrations.md]

migrations

  1. 安装 sequelize-cli

    1. npm install --save-dev sequelize-cli

  2. .sequelizerc 配置文件

  1. 'use strict';
  3. const path = require('path');
  5. module.exports = {
  6.   config: path.join(__dirname, 'database/config.json'),
  7.   'migrations-path': path.join(__dirname, 'database/migrations'),
  8.   'seeders-path': path.join(__dirname, 'database/seeders'),
  9.   'models-path': path.join(__dirname, 'app/model'),
  10. };
  1. 初始化 Migrations 配置文件和目录

npx sequelize init:config
npx sequelize init:migrations
npx sequelize init

  1. config, 包含配置文件,它告诉CLI如何连接数据库
  2. models,包含你的项目的所有模型
  3. migrations, 包含所有迁移文件
  4. seeders, 包含所有种子文件
  1. 将其改成我们项目中使用的数据库配置
  2.   "development": {
  3.     "username": "root", 
  4.     "password": null,
  5.     "database": "egg-sequelize-doc-default", // 数据库
  6.     "host": "127.0.0.1", // 地址
  7.     "dialect": "mysql" // 数据库类型  
  8.   },
  1. 此时 sequelize-cli 和相关的配置也都初始化好了，我们可以开始编写项目的第一个 Migration 文件来创建我们的一个 users 表了
    npx sequelize migration:generate —name=init-users

npx sequelize migration:generate —name User —attributes firstName:string,lastName:string,email:string

如果你的数据库还不存在,你可以调用 db:create 命令. 通过正确的访问,它将为你创建该数据库.

  1. 添加字段
  1. 'use strict';
  3. module.exports = {
  4.   // 在执行数据库升级时调用的函数，创建 users 表
  5.   up: async (queryInterface, Sequelize) => {
  6.     const { INTEGER, DATE, STRING } = Sequelize;
  7.     await queryInterface.createTable('users', {
  8.       id: { type: INTEGER, primaryKey: true, autoIncrement: true },
  9.       name: STRING(30),
  10.       age: INTEGER,
  11.       created_at: DATE,
  12.       updated_at: DATE,
  13.     });
  14.   },
  15.   // 在执行数据库降级时调用的函数，删除 users 表
  16.   down: async queryInterface => {
  17.     await queryInterface.dropTable('users');
  18.   },
  19. };
  1. 执行 migrate 进行数据库变更
  1. # 升级数据库
  2. npx sequelize db:migrate
  3. # 如果有问题需要回滚，可以通过 `db:migrate:undo` 回退一个变更
  4. # npx sequelize db:migrate:undo
  5. # 可以通过 `db:migrate:undo:all` 回退到初始状态
  6. # npx sequelize db:migrate:undo:all
  1. 编写model
  1. 'use strict';
  3. module.exports = app => {
  4.   const { STRING, INTEGER, DATE } = app.Sequelize;
  5.   const User = app.model.define('user', {
  6.     id: { type: INTEGER, primaryKey: true, autoIncrement: true },
  7.     name: STRING(30),
  8.     age: INTEGER,
  9.     created_at: DATE,
  10.     updated_at: DATE,
  11.   });
  12.   return User;
  13. };
  1. 访问model
  1. // app/controller/users.js
  2. const Controller = require('egg').Controller;
  4. function toInt(str) {
  5.   if (typeof str === 'number') return str;
  6.   if (!str) return str;
  7.   return parseInt(str, 10) || 0;
  8. }
  10. class UserController extends Controller {
  11.   async index() {
  12.     const ctx = this.ctx;
  13.     const query = { limit: toInt(ctx.query.limit), offset: toInt(ctx.query.offset) };
  14.     ctx.body = await ctx.model.User.findAll(query);
  15.   }
  17.   async show() {
  18.     const ctx = this.ctx;
  19.     ctx.body = await ctx.model.User.findByPk(toInt(ctx.params.id));
  20.   }
  22.   async create() {
  23.     const ctx = this.ctx;
  24.     const { name, age } = ctx.request.body;
  25.     const user = await ctx.model.User.create({ name, age });
  26.     ctx.status = 201;
  27.     ctx.body = user;
  28.   }
  30.   async update() {
  31.     const ctx = this.ctx;
  32.     const id = toInt(ctx.params.id);
  33.     const user = await ctx.model.User.findByPk(id);
  34.     if (!user) {
  35.       ctx.status = 404;
  36.       return;
  37.     }
  39.     const { name, age } = ctx.request.body;
  40.     await user.update({ name, age });
  41.     ctx.body = user;
  42.   }
  44.   async destroy() {
  45.     const ctx = this.ctx;
  46.     const id = toInt(ctx.params.id);
  47.     const user = await ctx.model.User.findByPk(id);
  48.     if (!user) {
  49.       ctx.status = 404;
  50.       return;
  51.     }
  53.     await user.destroy();
  54.     ctx.status = 200;
  55.   }
  56. }
  58. module.exports = UserController;
  1. 创建第一个种子
  1. npx sequelize-cli seed:generate --name managers
  3. # 同上
  4. npx sequelize seed:generate --name managers
  1. 运行种子 撤销种子
  1. # 运行种子
  2. npx sequelize-cli db:seed:all
  3. # 如果你想撤消最近的种子
  4. npx sequelize-cli db:seed:undo
  5. # 如果你想撤消特定的种子
  6. npx sequelize-cli db:seed:undo --seed name-of-seed-as-in-data
  7. # 如果你想撤消所有的种子
  8. npx sequelize-cli db:seed:undo:all

下一个是具有外键的迁移示例. 你可以使用 references 来指定外键:

  2. module.exports = {
  3.   up: (queryInterface, Sequelize) => {
  4.     return queryInterface.createTable('Person', {
  5.       name: Sequelize.STRING,
  6.       isBetaMember: {
  7.         type: Sequelize.BOOLEAN,
  8.         defaultValue: false,
  9.         allowNull: false
  10.       },
  11.       userId: {
  12.         type: Sequelize.INTEGER,
  13.         references: {
  14.           model: {
  15.             tableName: 'users',
  16.             schema: 'schema'
  17.           }
  18.           key: 'id'
  19.         },
  20.         allowNull: false
  21.       },
  22.     });
  23.   },
  25.   down: (queryInterface, Sequelize) => {
  26.     return queryInterface.dropTable('Person');
  27.   }
  28. }

.sequelizerc 文件

这是一个特殊的配置文件. 它允许你指定通常作为参数传递给CLI的各种选项:

env: 在其中运行命令的环境
config: 配置文件的路径
options-path: 带有其他参数的 JSON 文件的路径
migrations-path: migrations 文件夹的路径
seeders-path: seeders 文件夹的路径
models-path: models 文件夹的路径
url: 要使用的数据库连接字符串. 替代使用 —config 文件
debug: 可用时显示各种调试信息

初始化项目

  1. # 创建数据库
  2. npx sequelize db:create
  3. # 创建表
  4. npx sequelize db:migrate
  5. # 创建默认值
  6. npx sequelize db:seed:all

数据回滚

  1. # 如果你想撤消所有的种子
  2. npx sequelize-cli db:seed:undo:all
  3. # 回退到初始状态
  4. npx sequelize db:migrate:undo:all

生成公钥：openssl genrsa -out rsa_private_key.pem 1024
生成私钥: openssl rsa -in rsa_private_key.pem -pubout -out rsa_public_key.pem

命令 参数

如果没有全局安装可以通过npx 来运行
如果没有npx 可以选择全局安装

  1. npm install -g npx
  1.   sequelize db:migrate 运行挂起的迁移
  2.   sequelize db:migrate:schema:timestamps:add 更新迁移表以具有时间戳
  3.   sequelize db:migrate:status 列出所有迁移的状态
  4.   sequelize db:migrate:undo 恢复迁移
  5.   sequelize db:migrate:undo:all 恢复运行的所有迁移
  6.   sequelize db:seed 运行指定的播种机
  7.   sequelize db:seed:undo 从数据库中删除数据
  8.   sequelize db:seed:all 运行每个播种机
  9.   sequelize db:seed:undo:all 从数据库中删除数据
  10.   sequelize db:create 创建配置指定的数据库
  11.   sequelize db:drop 删除配置指定的数据库
  12.   sequelize init 初始化项目
  13.   sequelize init:config 初始化配置
  14.   sequelize init:migrations 初始化迁移
  15.   sequelize init:models 初始化模型
  16.   sequelize init:seeders 初始化播种机
  17.   sequelize migration:generate 生成一个新的迁移文件 [别名：migration:create]
  18.   sequelize model:generate 生成模型及其迁移 [别名：model:create]
  19.   sequelize seed:generate 生成一个新的种子文件 [别名：seed:create]
  21.   --version 显示版本号 [boolean]
  22.   --help 显示帮助