玩转Node.js-Sequelize数据迁移

2021-10-25 05:44:44

数据库迁移就像git一样，我们可以使用Sequelize迁移来帮助我们跟踪数据库的更改，并在各个不同时期的数据库状态之间进行切换，使用Sequelize迁移，需要安装 sequelize-cli 工具。

安装sequelize-cli

由于sequelize-cli依赖于sequelize包，sequelize又需要使用mysql2包来连接数据库，所以我们需要安装三个包。

npm i sequelize mysql2 sequelize-cli

如果是局部安装方式的话，安装完成之后进入node_modules目录下面的.bin目录下执行sequelizse-cli命令来测试sequelize-cli是否安装成功。

运行成功会出现下面信息。

初始化项目

执行sequelize-cli init命令初始化sequelize项目，成功执行之后会创建4个文件夹。

config：包含配置文件，它高速CLI如何连接数据库
models：包含你项目的所有模型
migrations：包含所有迁移文件
seeders：包含所有种子文件

config文件夹中的config.json配置有3个环境，分别是开始环境、测试环境、生产环境。

创建数据库

sequelize-cli会根据config/config.json里面的环境配置信息自动为我们创建数据库，默认情况会根据开发环境信息进行配置。

可以看到数据库成功创建。

删除数据库

sequelize-cli db:drop命令会根据配置信息删除数据库。

自定义环境变量

1.设置环境变量。

#设置环境变量NODE_ENV的值为home
set NODE_ENV=home
#删除环境变量，此时会得到home
echo %NODE_ENV%
#还原NODE_ENV的环境变量
set NODE_ENV=

2.在config/config.json中新增一项环境配置。

  "home": {
    "username": "root",
    "password": "root",
    "database": "c4az6_home",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },

3.再使用sequelize-cli创建数据库就会创建出home环境配置下的数据库了。

创建模型

使用model:generate或者model:create命令创建一个模型文件

参数：

--name：模型名称，必须
--attributes：字段列表，必须

参考

sequelize-cli model:create --name User --attributes username:STRING

注意：模型文件是给程序用的，迁移文件和种子文件是给sequelize-cli使用的。

执行迁移

所谓迁移，就是对数据库进行结构的创建、升级（修改）等操作。

使用db:migrate会找到迁移文件，然后执行里面的代码创建表和字段，同时会在数据库中创建一个sequelizemeta的表来记录迁移的脚本名称。

注意db:migrate不能对相同的表反复迁移，会报错。

我们可以通过db:migrate:status命令查看迁移文件的状态。

这个时候，如果有新的需求，要新增表，那么可以通过下面步骤实现。

1.首先还是创建模型。

2.查看状态发现为down，就是未迁移状态。

3.迁移。

4.连接数据库进行查看。

撤销迁移

db:migrate:undo命令会撤销最近的一次迁移操作，会删除最近一次创建的表，会把sequelizemeta表里面的最近一次记录删除。

有时候我们撤销不一定就非要删表，我们可能会有其他动作，这个时候我们就可以通过手动修改迁移脚本中的down函数代码来实现自定义撤销操作。

另外我们还可以通过db:migrate:undo:all命令来撤销所有的迁移脚本。

通过db:migrate:undo --name 脚本名命令指定撤销具体的迁移脚本。

sequelize-cli db:migrate:undo 20201212030431-create-message.js

那么如何迁移单个指定的文件呢？一般情况下我们要迁移的文件都应该是放在一个单独的文件夹下面的，然后通过下面命令指定迁移目录即可。

在表中添加字段

如何在不影响表原有的情况下添加新的字段？例如我们给users表中增加一个age字段。

创建迁移文件。

sequelize-cli migration:create --name UserAddAge

创建之后找到迁移脚本文件，然后在up和down中增加如下代码。

'use strict';

module.exports = {
  up: async (queryInterface, Sequelize) => {
    /**
     * Add altering commands here.
     *
     * Example:
     * await queryInterface.createTable('users', { id: Sequelize.INTEGER });
     */
    await queryInterface.addColumn(
      'users',
      'age', {
        type: Sequelize.TINYINT
      }
    )
  },

  down: async (queryInterface, Sequelize) => {
    /**
     * Add reverting commands here.
     *
     * Example:
     * await queryInterface.dropTable('users');
     */
    await queryInterface.removeColumn(
      'users',
      'age'
    )
  }
};

addColumn这个API的第一个参数是你要添加列的表名，age是添加的字段，type是数据类型。

removeColumn这个API是删除列。

添加代码之后再执行db:migrate命令发现已经有了age字段了。

如果我们撤销的话，也不会影响原有的users表结构，只会把users表中的age字段删除。

撤销最近一次迁移：db:migrate:undo

种子文件seeder

比如往表里面添加测试数据的时候我们就可以使用种子文件来实现。

创建种子文件

命令：sequelize-cli seed:create --name userTest

添加测试数据

'use strict';

module.exports = {
  up: async (queryInterface, Sequelize) => {
    /**
     * Add seed commands here.
     *
     * Example:
     * await queryInterface.bulkInsert('People', [{
     *   name: 'John Doe',
     *   isBetaMember: false
     * }], {});
    */
    await queryInterface.bulkInsert('users', [
      {
        username: '张三',
        age: 20
      },
      {
        username: '李四',
        age: 21
      }
    ])
  },

  down: async (queryInterface, Sequelize) => {
    /**
     * Add commands to revert seed here.
     *
     * Example:
     * await queryInterface.bulkDelete('People', null, {});
     */
    await queryInterface.bulkDelete('users', null, {});
  }
};

up函数里面的bulkInsertAPI第一个参数是要操作的表名，第二个参数是要插入的数据，是一个数组对象的格式。

down函数里面的bulkDeleteAPI是用来删除数据的，这里是将users表的数据清空。

运行种子文件

命令：sequelize-cli db:seed:all

指定运行种子文件：db:seed 种子文件
运行所有种子文件：db:seed:all

撤销种子文件

命令：sequelize-cli db:seed:undo

指定撤销种子文件：db:seed:undo 种子文件
撤销所有种子文件：db:seed:undo:all

如果哪天测试数据被我玩坏了，用这个命令就可以很方便的还原。

种子文件添加、撤销默认没有进行记录，因此我们需要手动添加记录，方便以后查看、溯源。

官方文档告诉我们需要在config/config.json配置文件中添加配置。

通过JSON的方式存储。

"development": {
    "username": "root",
    "password": "root",
    "database": "c4az6_development",
    "host": "127.0.0.1",
    "dialect": "mysql",
    "seederStorage": "json",
    "seederStoragePath": "userTestDataLog.json"
}

通过数据库存储。

  "development": {
    "username": "root",
    "password": "root",
    "database": "c4az6_development",
    "host": "127.0.0.1",
    "dialect": "mysql",
    "seederStorage": "sequelize",
    "seederStorageTableName": "userTestDataLog"
  },

注意：migration迁移的记录默认使用数据库存储，seeder种子文件生成的记录默认是没有存储的，需要手动在config/config.json中配置，要么使用JSON文件方式并且配置存储路径进行存储，要么使用数据库的方式存储。

码农公寓