如何使用 Sequelize CLI 从 Sequelize 模型自动生成迁移？

Question

我有一组 Sequelize 模型。我想使用迁移，而不是 DB Sync。

Sequelize CLI 似乎可以做到这一点，根据this article： "当您使用 CLI 生成模型时，您还将免费获得迁移脚本。"

如何使用 Sequelize CLI 从现有的 Sequelize 模型自动生成迁移？

Answer 1

如果您不想从头开始重新创建模型，可以使用以下 CLI 命令手动生成迁移文件：

sequelize migration:generate --name [name_of_your_migration]

这将生成一个空白的骨架迁移文件。虽然它不会将您的模型结构复制到文件中，但我确实发现它比重新生成所有内容更容易和更清洁。注意：确保从迁移目录的包含目录运行命令；否则 CLI 将为您生成一个新的迁移目录

Answer 2

您不能为现有模型创建迁移脚本。

资源：

• Tutorial video on migrations。

如果采用经典方式，则必须通过 CLI 重新创建模型：

sequelize model:create --name MyUser --attributes first_name:string,last_name:string,bio:text

它将生成这些文件：

models/myuser.js：

"use strict";
module.exports = function(sequelize, DataTypes) {
  var MyUser = sequelize.define("MyUser", {
    first_name: DataTypes.STRING,
    last_name: DataTypes.STRING,
    bio: DataTypes.TEXT
  }, {
    classMethods: {
      associate: function(models) {
        // associations can be defined here
      }
    }
  });
  return MyUser;
};

迁移/20150210104840-create-my-user.js：

"use strict";
module.exports = {
  up: function(migration, DataTypes, done) {
    migration.createTable("MyUsers", {
      id: {
        allowNull: false,
        autoIncrement: true,
        primaryKey: true,
        type: DataTypes.INTEGER
      },
      first_name: {
        type: DataTypes.STRING
      },
      last_name: {
        type: DataTypes.STRING
      },
      bio: {
        type: DataTypes.TEXT
      },
      createdAt: {
        allowNull: false,
        type: DataTypes.DATE
      },
      updatedAt: {
        allowNull: false,
        type: DataTypes.DATE
      }
    }).done(done);
  },
  down: function(migration, DataTypes, done) {
    migration.dropTable("MyUsers").done(done);
  }
};

Answer 3

现在是 2020 年，其中许多答案不再适用于 Sequelize v4/v5/v6 生态系统。

一个好的答案是使用sequelize-auto-migrations，但可能不足以在您的项目中使用。所以这里有更多的颜色......

设置

我的团队使用fork of sequelize-auto-migrations，因为原始 repo 尚未合并几个关键 PR。 #56#57#58#59

$ yarn add github:scimonster/sequelize-auto-migrations#a063aa6535a3f580623581bf866cef2d609531ba

编辑package.json:

"scripts": {
  ...
  "db:makemigrations": "./node_modules/sequelize-auto-migrations/bin/makemigration.js",
  ...
}

流程

注意：确保您使用的是 git（或某些源代码控制）和数据库备份，以便在出现严重问题时可以撤消这些更改。

1. 删除所有旧迁移（如果存在）。
2. 关闭.sync()
3. 创建一个大规模迁移，迁移当前模型中的所有内容 (yarn db:makemigrations --name "mega-migration")。
4. 提交您的01-mega-migration.js 和生成的_current.json。
5. 如果您之前运行过.sync() 或手写迁移，则需要通过将其名称插入到 SequelizeMeta 表中来“伪造”该大型迁移。 INSERT INTO SequelizeMeta Values ('01-mega-migration.js')。
6. 现在您应该可以正常使用它了……
7. 对模型进行更改（添加/删除列、更改约束）
8. 运行$ yarn db:makemigrations --name whatever
9. 提交您的02-whatever.js 迁移以及对_current.json 和_current.bak.json 的更改。
10. 通过正常的 sequelize-cli 运行迁移：$ yarn sequelize db:migrate。
11. 必要时重复 7-10

已知问题

1. 重命名列将变成一对removeColumn 和addColumn。这将丢失生产中的数据。您需要修改 up 和 down 操作以改用 renameColumn。

对于那些不知道如何使用renameColumn 的人来说，sn-p 看起来像这样。 （为rollbackCommands 切换“column_name_before”和“column_name_after”）

{
    fn: "renameColumn",
    params: [
        "table_name",
        "column_name_before",
        "column_name_after",
        {
            transaction: transaction
        }
    ]
}

1. 如果您有很多迁移，向下操作可能无法以顺序一致的方式完美地删除项目。

2. 这个库的维护者没有主动检查它。因此，如果它不适合您开箱即用，您将需要寻找不同的社区分叉或其他解决方案。

Answer 4

您现在可以使用 npm 包 sequelize-auto-migrations 自动生成迁移文件。 https://www.npmjs.com/package/sequelize-auto-migrations

使用 sequelize-cli，初始化你的项目

sequelize init

创建模型并将它们放入模型文件夹中。

安装 sequelize-auto-migrations：

npm install sequelize-auto-migrations

使用

创建初始迁移文件

node ./node_modules/sequelize-auto-migrations/bin/makemigration --name <initial_migration_name>

运行您的迁移：

node ./node_modules/sequelize-auto-migrations/bin/runmigration

您还可以从现有数据库自动生成模型，但这超出了问题的范围。

Answer 5

我创建了一个小型工作“迁移文件生成器”。它使用sequelize db:migrate 创建可以正常工作的文件 - 即使使用外键！

你可以在这里找到它： https://gist.github.com/manuelbieh/ae3b028286db10770c81

我在一个包含 12 种不同模型的应用程序中对其进行了测试：

• 字符串、文本、枚举、整数、布尔值、浮点数作为数据类型

• 外键约束（偶数互易（用户属于团队，团队属于用户为所有者））

• 具有name、method 和unique 属性的索引

Answer 6

截至 2020 年 9 月 16 日，这些答案中的大多数都不太一致！ 试试这个新的 npm 包

Sequelize-mig

它完成了 sequelize-auto-migrations 及其分支及其维护和记录中的大多数已知问题！

它的使用方式与已知的类似

安装：

npm install sequelize-mig -g / yarn global add sequelize-mig

然后像这样使用它

sequelize-mig migration:make -n <migration name>

Answer 7

如果您想在迁移的同时创建模型，请使用以下命令：-

sequelize model:create --name regions --attributes name:string,status:boolean --underscored

--underscored 它用于创建具有下划线的列，例如：- created_at、updated_at 或任何其他具有下划线的列，并支持用户定义的具有下划线的列。

Answer 8

虽然它不会自动生成，但在模型更改时生成新迁移的一种方法是： （假设您使用的是 stock sequelize-cli 文件结构，其中迁移和模型处于同一级别）

1. （与 Manuel Bieh 的建议相同，但使用 require 而不是 import）在您的迁移文件中（如果您没有，您可以通过执行“sequelize migration:create”生成一个）具有以下代码：

   'use strict';
   var models = require("../models/index.js")
   module.exports = {
     up: function(queryInterface, Sequelize) {
       return queryInterface.createTable(models.User.tableName, 
         models.User.attributes);
     },
     down: function(queryInterface, Sequelize) {
       return queryInterface.dropTable('Users');
     }
   };
   

2. 更改用户模型。

3. 从数据库中删除表。
4. 撤消所有迁移：sequelize db:migrate:undo:all
5. 重新迁移以将更改保存在数据库中。 sequelize db:migrate

Answer 9

PaulMest 在此页面中的回答对我非常有用。 我使用了“sequelize-auto-migrations”，但它没有检测到我的更改。 我使用了'sequelize-auto-migrations-v2'，这对我来说是正确的。 您可以通过以下方式安装它：

npm install sequelize-auto-migrations-v2

并通过以下方式使用它：

node ./node_modules/sequelize-auto-migrations-v2/bin/makemigration

Answer 10

我最近尝试了以下似乎效果很好的方法，尽管我不能 100% 确定是否有任何副作用：

'use strict';

import * as models from "../../models";

module.exports = {

  up: function (queryInterface, Sequelize) {

    return queryInterface.createTable(models.Role.tableName, models.Role.attributes)
    .then(() => queryInterface.createTable(models.Team.tableName, models.Team.attributes))
    .then(() => queryInterface.createTable(models.User.tableName, models.User.attributes))

  },

  down: function (queryInterface, Sequelize) {
    ...
  }

};

当使用sequelize db:migrate 运行上述迁移时，我的控制台显示：

Starting 'db:migrate'...
Finished 'db:migrate' after 91 ms
== 20160113121833-create-tables: migrating =======
== 20160113121833-create-tables: migrated (0.518s)

所有表格都在那里，一切（至少似乎）都按预期工作。如果定义正确，即使所有关联都存在。

Answer 11

另一种解决方案是将数据定义放入单独的文件中。

这个想法是将模型和迁移通用的数据写入单独的文件，然后在迁移和模型中都需要它。然后在模型中我们可以添加验证，而迁移已经很好了。

为了不让这篇文章被大量代码弄得乱七八糟，我写了一个 GitHub 要点。

在这里查看：https://gist.github.com/igorvolnyi/f7989fc64006941a7d7a1a9d5e61be47