就像你使用Git / SVN来管理源代码的更改一样,你可以使用迁移来跟踪数据库的更改. 通过迁移,你可以将现有的数据库转移到另一个状态,反之亦然:这些状态转换将保存在迁移文件中,它们描述了如何进入新状态以及如何还原更改以恢复旧状态.

你将需要Sequelize CLI. CLI支持迁移和项目引导.

命令行界面

安装命令行界面

让我们从安装CLI开始,你可以在 这里 找到说明. 最推荐的方式是这样安装

$ npm install --save sequelize-cli

引导

要创建一个空项目,你需要执行 init 命令

$ npx sequelize-cli init

这将创建以下文件夹

  • config, 包含配置文件,它告诉CLI如何连接数据库
  • models,包含你的项目的所有模型
  • migrations, 包含所有迁移文件
  • seeders, 包含所有种子文件

结构

在继续进行之前,我们需要告诉 CLI 如何连接到数据库. 为此,可以打开默认配置文件 config/config.json. 看起来像这样

{
  "development": {
    "username": "root",
    "password": null,
    "database": "database_development",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "test": {
    "username": "root",
    "password": null,
    "database": "database_production",
    "host": "127.0.0.1",
    "dialect": "mysql"
  },
  "production": {
    "username": "root",
    "password": null,
    "database": "database_test",
    "host": "127.0.0.1",
    "dialect": "mysql"
  }
}

现在编辑此文件并设置正确的数据库凭据和方言.对象的键(例如 "development")用于 model/index.js 以匹配 process.env.NODE_ENV(当未定义时,默认值是 "development").

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

创建第一个模型(和迁移)

一旦你正确配置了CLI配置文件,你就可以首先创建迁移. 它像执行一个简单的命令一样简单.

我们将使用 model:generate 命令. 此命令需要两个选项

  • name, 模型的名称
  • attributes, 模型的属性列表

让我们创建一个名叫 User 的模型

$ npx sequelize-cli model:generate --name User --attributes firstName:string,lastName:string,email:string

这将发生以下事情

  • 在 models 文件夹中创建了一个 user 模型文件
  • 在 migrations 文件夹中创建了一个名字像 XXXXXXXXXXXXXX-create-user.js 的迁移文件

注意: _Sequelize 将只使用模型文件,它是表描述.另一边,迁移文件是该模型的更改,或更具体的是说 CLI 所使用的表. 处理迁移,如提交或日志,以进行数据库的某些更改. _

运行迁移

直到这一步,CLI没有将任何东西插入数据库. 我们刚刚为我们的第一个模型 User 创建了必需的模型和迁移文件. 现在要在数据库中实际创建该表,需要运行 db:migrate 命令.

$ npx sequelize-cli db:migrate

此命令将执行这些步骤

  • 将在数据库中确保一个名为 SequelizeMeta 的表. 此表用于记录在当前数据库上运行的迁移
  • 开始寻找尚未运行的任何迁移文件. 这可以通过检查 SequelizeMeta 表. 在这个例子中,它将运行我们在最后一步中创建的 XXXXXXXXXXXXXX-create-user.js 迁移,.
  • 创建一个名为 Users 的表,其中包含其迁移文件中指定的所有列.

撤消迁移

现在我们的表已创建并保存在数据库中. 通过迁移,只需运行命令即可恢复为旧状态.

你可以使用 db:migrate:undo,这个命令将会恢复最近的迁移.

$ npx sequelize-cli db:migrate:undo

通过使用 db:migrate:undo:all 命令撤消所有迁移,可以恢复到初始状态. 你还可以通过将其名称传递到 --to 选项中来恢复到特定的迁移.

$ npx sequelize-cli db:migrate:undo:all --to XXXXXXXXXXXXXX-create-posts.js

创建第一个种子

假设我们希望在默认情况下将一些数据插入到几个表中. 如果我们跟进前面的例子,我们可以考虑为 User 表创建演示用户.

要管理所有数据迁移,你可以使用 seeders. 种子文件是数据的一些变化,可用于使用样本数据或测试数据填充数据库表.

让我们创建一个种子文件,它会将一个演示用户添加到我们的 User 表中.

$ npx sequelize-cli seed:generate --name demo-user

这个命令将会在 seeders 文件夹中创建一个种子文件.文件名看起来像是 XXXXXXXXXXXXXX-demo-user.js,它遵循相同的 up/down 语义,如迁移文件.

现在我们应该编辑这个文件,将演示用户插入User表.

'use strict';

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

  down: (queryInterface, Sequelize) => {
    return queryInterface.bulkDelete('Users', null, {});
  }
};

运行种子

在上一步中,你创建了一个种子文件. 但它还没有保存到数据库. 为此,我们需要运行一个简单的命令.

$ npx sequelize-cli db:seed:all

这将执行该种子文件,你将有一个演示用户插入 User 表.

注意: _ seeders 执行不会存储在任何使用 SequelizeMeta 表的迁移的地方. 如果你想覆盖这个,请阅读 存储 部分_

撤销种子

Seeders 如果使用了任何存储那么就可以被撤消. 有两个可用的命令

如果你想撤消最近的种子

$ npx sequelize-cli db:seed:undo

如果你想撤消特定的种子

npx sequelize-cli db:seed:undo --seed name-of-seed-as-in-data

如果你想撤消所有的种子

npx sequelize-cli db:seed:undo:all

高级专题

迁移框架

以下框架显示了一个典型的迁移文件.

module.exports = {
  up: (queryInterface, Sequelize) => {
    // 转变为新状态的逻辑
  },
 
  down: (queryInterface, Sequelize) => {
    // 恢复更改的逻辑
  }
}

我们可以使用 migration:generate 生成该文件. 这将在您的迁移文件夹中创建 xxx-migration-skeleton.js.

$ npx sequelize-cli migration:generate --name migration-skeleton

传递的 queryInterface 对象可以用来修改数据库. Sequelize 对象存储可用的数据类型,如 STRING 或 INTEGER. 函数 up或 down 应该返回一个 Promise . 让我们来看一个例子

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.createTable('Person', {
        name: Sequelize.STRING,
        isBetaMember: {
          type: Sequelize.BOOLEAN,
          defaultValue: false,
          allowNull: false
        }
      });
  },
  down: (queryInterface, Sequelize) => {
    return queryInterface.dropTable('Person');
  }
}

以下是在数据库中执行两项更改的迁移示例,使用事务确保在发生故障时成功执行或回滚所有指令:

module.exports = {
    up: (queryInterface, Sequelize) => {
        return queryInterface.sequelize.transaction((t) => {
            return Promise.all([
                queryInterface.addColumn('Person', 'petName', {
                    type: Sequelize.STRING
                }, { transaction: t }),
                queryInterface.addColumn('Person', 'favoriteColor', {
                    type: Sequelize.STRING,
                }, { transaction: t })
            ])
        })
    },

    down: (queryInterface, Sequelize) => {
        return queryInterface.sequelize.transaction((t) => {
            return Promise.all([
                queryInterface.removeColumn('Person', 'petName', { transaction: t }),
                queryInterface.removeColumn('Person', 'favoriteColor', { transaction: t })
            ])
        })
    }
};

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

module.exports = {
  up: (queryInterface, Sequelize) => {
    return queryInterface.createTable('Person', {
      name: Sequelize.STRING,
      isBetaMember: {
        type: Sequelize.BOOLEAN,
        defaultValue: false,
        allowNull: false
      },
      userId: {
        type: Sequelize.INTEGER,
        references: {
          model: {
            tableName: 'users',
            schema: 'schema'
          }
          key: 'id'
        },
        allowNull: false
      },
    });
  },

  down: (queryInterface, Sequelize) => {
    return queryInterface.dropTable('Person');
  }
}

下一个是使用 async/await 的迁移示例,你可以在其中为新列创建唯一索引:

module.exports = {
  async up(queryInterface, Sequelize) {
    const transaction = await queryInterface.sequelize.transaction();
    try {
      await queryInterface.addColumn(
        'Person',
        'petName',
        {
          type: Sequelize.STRING,
        },
        { transaction }
      );
      await queryInterface.addIndex(
        'Person',
        'petName',
        {
          fields: 'petName',
          unique: true,
        },
        { transaction }
      );
      await transaction.commit();
    } catch (err) {
      await transaction.rollback();
      throw err;
    }
  },

  async down(queryInterface, Sequelize) {
    const transaction = await queryInterface.sequelize.transaction();
    try {
      await queryInterface.removeColumn('Person', 'petName', { transaction });
      await transaction.commit();
    } catch (err) {
      await transaction.rollback();
      throw err;
    }
  },
};

.sequelizerc 文件

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

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

在某些情况下,你可以使用它.

  • 你想要覆盖到 migrations, models, seeders 或 config 文件夹的路径.
  • 你想要重命名 config.json 成为别的名字比如 database.json

还有更多的, 让我们看一下如何使用这个文件进行自定义配置.

对于初学者,让我们在项目的根目录中创建一个空文件.

$ touch .sequelizerc

现在可以使用示例配置.

const path = require('path');

module.exports = {
  'config': path.resolve('config', 'database.json'),
  'models-path': path.resolve('db', 'models'),
  'seeders-path': path.resolve('db', 'seeders'),
  'migrations-path': path.resolve('db', 'migrations')
}

通过这个配置你告诉CLI:

  • 使用 config/database.json 文件来配置设置
  • 使用 db/models 作为模型文件夹
  • 使用 db/seeders 作为种子文件夹
  • 使用 db/migrations 作为迁移文件夹

动态配置

配置文件是默认的一个名为 config.json 的JSON文件. 但有时你想执行一些代码或访问环境变量,这在JSON文件中是不可能的.

Sequelize CLI可以从“JSON”和“JS”文件中读取. 这可以用.sequelizerc文件设置. 让我们来看一下

首先,你需要在项目的根文件夹中创建一个 .sequelizerc 文件. 该文件应该覆盖 JS 文件的配置路径. 推荐这个

const path = require('path');

module.exports = {
  'config': path.resolve('config', 'config.js')
}

现在,Sequelize CLI将加载 config/config.js 以获取配置选项. 由于这是一个JS文件,你可以执行任何代码并导出最终的动态配置文件.

一个 config/config.js 文件的例子

const fs = require('fs');

module.exports = {
  development: {
    username: 'database_dev',
    password: 'database_dev',
    database: 'database_dev',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: 'database_test',
    password: null,
    database: 'database_test',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOSTNAME,
    dialect: 'mysql',
    dialectOptions: {
      ssl: {
        ca: fs.readFileSync(__dirname + '/mysql-ca-master.crt')
      }
    }
  }
};

使用 Babel

现在你知道如何使用 .sequelizerc 文件了. 现在让我们看看如何用这个文件来使用带有 sequelize-cli 设置的 babel. 这将允许你使用 ES6/ES7 语法编写 migration 和 seeder.

首先安装 babel-register

$ npm i --save-dev babel-register

现在让我们创建 .sequelizerc 文件,它可以包含你可能想要为 sequelize-cli 更改的任何配置,但除此之外我们还希望它为我们的代码库注册 babel. 像这样

$ touch .sequelizerc # Create rc file

现在这个文件中包含 babel-register 配置

require("babel-register");

const path = require('path');

module.exports = {
  'config': path.resolve('config', 'config.json'),
  'models-path': path.resolve('models'),
  'seeders-path': path.resolve('seeders'),
  'migrations-path': path.resolve('migrations')
}

现在 CLI 将能够从 migration/seeder 等运行 ES6/ES7 代码.请记住这取决于你的 .babelrc 配置.请在babeljs.io了解更多相关信息.

使用环境变量

使用CLI,你可以直接访问 config/config.js 内的环境变量. 你可以使用 .sequelizerc 来告诉CLI使用 config/config.js 进行配置. 这在上一节中有所解释.

然后你可以使用正确的环境变量来暴露文件.

module.exports = {
  development: {
    username: 'database_dev',
    password: 'database_dev',
    database: 'database_dev',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: process.env.CI_DB_USERNAME,
    password: process.env.CI_DB_PASSWORD,
    database: process.env.CI_DB_NAME,
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: process.env.PROD_DB_USERNAME,
    password: process.env.PROD_DB_PASSWORD,
    database: process.env.PROD_DB_NAME,
    host: process.env.PROD_DB_HOSTNAME,
    dialect: 'mysql'
  }
};

指定方言选项

有时你想指定一个 dialectOption,如果它是一个通用配置,你可以将其添加到 config/config.json 中. 有时你想执行一些代码来获取 dialectOptions,你应该为这些情况使用动态配置文件.

{
    "production": {
        "dialect":"mysql",
        "dialectOptions": {
            "bigNumberStrings": true
        }
    }
}

生产用途

有关在生产环境中使用CLI和迁移设置的一些提示.

  1. 使用环境变量进行配置设置. 这是通过动态配置更好地实现的. 样品生产安全配置可能看起来像
const fs = require('fs');

module.exports = {
  development: {
    username: 'database_dev',
    password: 'database_dev',
    database: 'database_dev',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  test: {
    username: 'database_test',
    password: null,
    database: 'database_test',
    host: '127.0.0.1',
    dialect: 'mysql'
  },
  production: {
    username: process.env.DB_USERNAME,
    password: process.env.DB_PASSWORD,
    database: process.env.DB_NAME,
    host: process.env.DB_HOSTNAME,
    dialect: 'mysql',
    dialectOptions: {
      ssl: {
        ca: fs.readFileSync(__dirname + '/mysql-ca-master.crt')
      }
    }
  }
};

我们的目标是为各种数据库秘密使用环境变量,而不是意外检查它们来源控制.

存储

可以使用三种类型的存储:sequelize,json和none.

  • sequelize : 将迁移和种子存储在 sequelize 数据库的表中
  • json : 将迁移和种子存储在json文件上
  • none : 不存储任何迁移/种子

迁移存储

默认情况下,CLI 将在你的数据库中创建一个名为 SequelizeMeta 的表,其中包含每个执行迁移的条目. 要更改此行为,可以在配置文件中添加三个选项. 使用 migrationStorage 可以选择要用于迁移的存储类型. 如果选择 json,可以使用 migrationStoragePath 指定文件的路径,或者 CLI 将写入 sequelize-meta.json 文件. 如果要将数据保存在数据库中,请使用 sequelize,但是要使用其他表格,可以使用 migrationStorageTableName.你还可以通过提供migrationStorageTableSchema属性为SequelizeMeta表定义不同的 schema.

{
  "development": {
    "username": "root",
    "password": null,
    "database": "database_development",
    "host": "127.0.0.1",
    "dialect": "mysql",

    // 使用不同的存储类型. Default: sequelize
    "migrationStorage": "json",

    // 使用不同的文件名. Default: sequelize-meta.json
    "migrationStoragePath": "sequelizeMeta.json",

    // 使用不同的表名. Default: SequelizeMeta
    "migrationStorageTableName": "sequelize_meta",

    // 为 SequelizeMeta 表使用不同的 schema
    "migrationStorageTableSchema": "custom_schema"
  }
}

注意: 不推荐使用 none 存储作为迁移存储. 如果你决定使用它,请注意将会没有任何移动记录或没有运行的记录.

种子储存

默认情况下,CLI 不会保存任何被执行的种子. 如果你选择更改此行为(!),则可以在配置文件中使用 seederStorage 来更改存储类型. 如果选择 json,可以使用 seederStoragePath 指定文件的路径,或者 CLI 将写入文件 sequelize-data.json. 如果要将数据保存在数据库中,请使用 sequelize,你可以使用 seederStorageTableName 指定表名,否则将默认为SequelizeData.

{
  "development": {
    "username": "root",
    "password": null,
    "database": "database_development",
    "host": "127.0.0.1",
    "dialect": "mysql",
    // 使用不同的存储空间. Default: none
    "seederStorage": "json",
    // 使用不同的文件名. Default: sequelize-data.json
    "seederStoragePath": "sequelizeData.json",
    // 使用不同的表名 Default: SequelizeData
    "seederStorageTableName": "sequelize_data"
  }
}

配置连接字符串

作为 --config 选项的替代方法,可以使用定义数据库的配置文件,你可以使用 --url 选项传递连接字符串. 例如:

$ npx sequelize-cli db:migrate --url 'mysql://root:password@mysql_host.com/database_name'

传递方言特定参数

{
    "production": {
        "dialect":"postgres",
        "dialectOptions": {
            // 像 SSL 这样的方言参数
        }
    }
}

程序化使用

Sequelize 有一个 姊妹库,用于以编程方式处理迁移任务的执行和记录.

查询界面

使用 queryInterface 对象描述之前,你可以更改数据库模式. 查看完整的公共方法列表,它支持 QueryInterface API