NodeJS 后端开发 - 使用 sequelize/cli 实现 mysql 数据迁移

柔光的暖阳◎ 2022-12-28 00:56 155阅读 0赞

### 文章目录 ###

*  背景
 *  实现
 *   *  安装 sequelize/cli 依赖
     *  初始化
     *  实现数据迁移
 *  参考

# 背景 #

在做后台接口开发时，我们总会遇到新增字段或者修改字段的问题。  
在开发阶段我们可以删表重建，但是上线之后可不能这么搞了。所以数据迁移就很重要了。

所谓的数据迁移原理其实就是将数据复制出来然后再把表删了重新建表同时把数据再复制进去。

这里我用到的`ORM`是`Sequelize`所以下面简单介绍一下`Sequelize`实现数据迁移的过程。

# 实现 #

## 安装 sequelize/cli 依赖 ##

npm install --save-dev sequelize-cli

## 初始化 ##

![在这里插入图片描述][20201213101110568.png]

在项目目录（我这里是`starter`）执行下面的命令

npx sequelize-cli init

会在当前目录下生成相关目录如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0lUeGlhb2Rvbmc_size_16_color_FFFFFF_t_70]

*  `config/config.json`：包含配置文件,它告诉`CLI`如何连接数据库。可直接从项目的数据库配置中复制过来，内容如下：

{ 
      "development": { 
        "username": "root",
        "password": "数据库密码",
        "database": "lin-cms",
        "host": "localhost",
        "dialect": "mysql"
      },
      "test": { 
        "username": "root",
        "password": "数据库密码",
        "database": "lin-cms",
        "host": "localhost",
        "dialect": "mysql"
      },
      "production": { 
        "username": "root",
        "password": "数据库密码",
        "database": "lin-cms",
        "host": "localhost",
        "dialect": "mysql"
      }
    }

*  `migrations`：包含所有迁移文件。数据迁移的主要文件，后面介绍。
 *  `seeders`：包含所有种子文件。使用样本数据或测试数据填充数据库表时可以使用`seeders`文件去实现。比如向用户表中插入用户：

module.exports = { 
      up: (queryInterface, Sequelize) => { 
        return queryInterface.bulkInsert('Users', [{ 
          firstName: 'John',
          lastName: 'Doe',
          email: 'example@example.com',
          createdAt: new Date(),
          updatedAt: new Date()
        }]);
      },
      down: (queryInterface, Sequelize) => { 
        return queryInterface.bulkDelete('Users', null, { });
      }
    };

*  `models`：包含你的项目的所有模型。

## 实现数据迁移 ##

> 目的是要在已经存在的 `goods`表中增加`pay_type`字段，并且不删除表中的数据。

我们先按照上面的步骤完成初始化之后，就可以创建迁移文件了。  
可通过如下命令创建文件：

npx sequelize-cli migration:generate --name migration-good-add-paytype-column

*  `migration-good-add-paytype-column`：是我们的迁移文件名称  
    执行完之后会在`migrations`文件夹下生成文件：  
    ![在这里插入图片描述][20201213103909301.png]

接下来就是在该文件中编写迁移逻辑了，文件内容如下：

'use strict';
    
    module.exports = { 
      up: async (queryInterface, Sequelize) => { 
        /** * Add altering commands here. 更新的操作 * * Example: * await queryInterface.createTable('users', { id: Sequelize.INTEGER }); */
        return queryInterface.sequelize.transaction(t => { 
          return Promise.all([
          // 在 goods 表中增加 string 类型的 pay_type 字段
            queryInterface.addColumn('Goods', 'pay_type', { 
              type: Sequelize.DataTypes.STRING
            }, {  transaction: t }),
            
          ]);
        });
      },
    
      down: async (queryInterface, Sequelize) => { 
        /** * Add reverting commands here. 回退的操作 * * Example: * await queryInterface.dropTable('users'); */
      }
    };

编写完迁移逻辑之后，执行如下命令即可完成数据迁移：

npx sequelize-cli db:migrate

最后我们可以在数据库表中看到已经在现有数据的基础上增加了`pay_type`字段。  
![在这里插入图片描述][20201213104437832.png]

多表依赖可参考文档中的介绍。  
[Sequelize 高级专题][Sequelize]

TIP:  
在新增完字段之后，应该还需要在原有的`Model`对象里面添加，如这里是`model/good.js`需要增加`pay_type`否则添加商品信息该字段没有添加成功。（目前测试是这样）

import sequelize from '../lib/db';
    import { 
        Sequelize
    } from 'sequelize';
    import { 
        GoodParentCategory
    } from './good-category';
    
    // 这是我们用于以下示例的模型的设置
    const Good = sequelize.define('good', { 
        id: { 
            type: Sequelize.INTEGER,
            primaryKey: true,
            autoIncrement: true
        },
        title: { 
            type: Sequelize.STRING(50),
            allowNull: false
        },
         // 新增
        brand:{ 
            type: Sequelize.STRING(50),
            allowNull: false
        },
        image: { 
            type: Sequelize.STRING(100),
            allowNull: false
        },
        category: { 
            type: Sequelize.STRING(10),
            allowNull: false
        },
        stock: { 
            type: Sequelize.INTEGER,
            allowNull: false
        },
        original_price: { 
            type: Sequelize.INTEGER,
            allowNull: false
        },
        price: { 
            type: Sequelize.INTEGER,
            allowNull: false
        },
        // 新增
        pay_type:{ 
            type: Sequelize.STRING(10),
            allowNull: false
        },
        summary: { 
            type: Sequelize.STRING(1000),
            allowNull: false
        },
    });
    GoodParentCategory.hasMany(Good);
    Good.belongsTo(GoodParentCategory);
    
    export { 
        Good
    };

# 参考 #

*  [Sequelize 迁移][Sequelize 1]
 *  [Sequelize 更新数据库表字段][Sequelize 2]
 *  [GitHub - sequelize/cli][GitHub - sequelize_cli]

[20201213101110568.png]: /images/20221120/52d64ed2969546ae830e408692d9e343.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0lUeGlhb2Rvbmc_size_16_color_FFFFFF_t_70]: /images/20221120/6c84df35b9b94493b5522f581412203a.png
[20201213103909301.png]: /images/20221120/5de2c11c9abd4552b5d429b763eb62cd.png
[20201213104437832.png]: /images/20221120/5e39425b32074beea7017040c87dbeb5.png
[Sequelize]: https://www.sequelize.com.cn/other-topics/migrations#%E9%AB%98%E7%BA%A7%E4%B8%93%E9%A2%98
[Sequelize 1]: https://www.sequelize.com.cn/other-topics/migrations
[Sequelize 2]: https://www.onlyling.com/archives/412
[GitHub - sequelize_cli]: https://github.com/sequelize/cli