Upgrade to V4 - 升级到 V4

Sequelize V4 是一个重要版本，它引入了新的功能和突破性的变化。 大量的 sequelize 代码库已用 ES2015 功能重构。 以下指南列出了从 v3 升级到 v4 的一些更改。查看 修改日志 查看全部详细列表。

突破性变化

  • Node 版本: 要使用新的 ES2015 功能，我们现在至少需要 Node4。从现在开始，我们将支持所有当前的LTS版本的Node。
  • 计数器缓存插件以及因此关联的计数器缓存选项已被删除。 使用 afterCreate 和 afterDelete 钩子可以实现相同的行为。
  • 删除了MariaDB方言。 这只是围绕 MySQL 的一个浅层包装，所以使用 dialect:'mysql 而不是进一步的改变。
  • 删除默认的 REPEATABLE_READ 事务隔离。 隔离级别现在默认为数据库的级别。 在启动事务时明确地传递所需的隔离级别。
  • 删除了对 pool: false 的支持。要使用单个连接，请将 pool.max 设置为1。

  • 删除了对旧连接池配置关键字的支持。

    以前:

    1. pool: {
    2.   maxIdleTime: 30000,
    3.   minConnections: 20,
    4.   maxConnections: 30
    5. }

    现在:

    1. pool: {
    2.   idle: 30000,
    3.   min: 20,
    4.   max: 30
    5. }
  • （MySQL）当数字太大时，BIGINT 现在被转换为字符串。

  • (MySQL) DECIMAL 和 NEWDECIMAL 类型现在以 String 形式返回，除非

    1. dialectOptions: {
    2.   decimalNumbers: true
    3. }

    被指定.

  • 删除了对referencesKey的支持，使用了一个引用对象。

    1. references: {
    2.     key: '',
    3.     model: ''
    4. }

  • classMethods 和 instanceMethods 已被移除。

    以前:

    1. const Model = sequelize.define('Model', {
    2.     ...
    3. }, {
    4.     classMethods: {
    5.         associate: function (model) {...}
    6.     },
    7.     instanceMethods: {
    8.         someMethod: function () { ...}
    9.     }
    10. });

    现在:

    1. const Model = sequelize.define('Model', {
    2.     ...
    3. });
    5. // 类方法
    6. Model.associate = function (models) {
    7.     ...associate the models
    8. };
    10. // 实例方法
    11. Model.prototype.someMethod = function () {..}

  • Model.Instance 和 instance.Model 已被移除。要从一个实例访问模型，只需使用 instance.constructor。 示例类 (Model.Instance) 现在是模型本身。

  • Sequelize 现在使用一个 bluebird 库的独立副本.

    • sequelize返回的 promise 现在是 Sequelize.Promise 而不是 bluebird 的全局 Promise 实例。

    • CLS 补丁不会影响 bluebird 的全局 promise。当与 Promise.all 和其他 bluebird 方法一起使用时，事务不会自动传递给方法。明确地修补 bluebird 实例，可以让 CLS 能够使用 bluebird 方法。

      1. $ npm install --save cls-bluebird
      1. const Promise = require('bluebird');
      2. const Sequelize = require('sequelize');
      3. const cls = require('continuation-local-storage');
      4. const ns = cls.createNamespace('transaction-namespace');
      5. const clsBluebird = require('cls-bluebird');
      6. clsBluebird(ns, Promise);
      7. Sequelize.useCLS(ns);
  • Sequelize.Validator 现在是 validator 库的独立副本
  • DataTypes.DECIMAL 对于 MySQL 和 Postgres 返回的是字符串.
  • DataTypes.DATE 现在使用 DATETIMEOFFSET 而不是 DATETIME2 sql数据类型，以防MSSQL记录时区。要将现有的 DATETIME2 列迁移到 DATETIMEOFFSET 中, 查看 #7201.
  • options.order 现在只接受数组类型或 Sequelize 方法的值。 原限支持的字符串值（即{order:'name DESC'}）已被弃用。

  • 使用 BelongsToMany 关系 add / set / create 设置器现在通过将它们传递为 options.through 来设置属性（以前的第二个参数被用作通过属性，现在它被认为是 through 作为子选项的选项）。

    以前:

    1. user.addProject(project, { status: 'started' })

    现在:

    1. user.addProject(project, { through: { status: 'started' }})

  • DATEONLY 现在以 YYYY-MM-DD 格式而不是 Date 类型返回字符串

  • Model.validate 实例方法默认运行验证钩子。以前你需要传递 { hooks: true }. 您可以通过传递 { hooks: false } 来覆盖此行为。
  • 当验证失败时，来自 Model.validate 实例方法的结果将被拒绝。 验证成功后才能实现。
  • 原始参数 where, order 和 group 比如 where: { $raw: '..', order: [{ raw: '..' }], group: [{ raw: '..' }] } 删除以防止SQL注入攻击。
  • Sequelize.Utils 不再是公共API的一部分，使用它自己承担风险。
  • Hooks 现在应返回 promise。 不支持回调。
  • required 内部的 include 不会传播 include 链。

要获得 v3 兼容的效果，您需要在包含的 include 上设置 required。

以前:

  1.   user.findOne({
  2.     include: {
  3.       model: project,
  4.       include: {
  5.         model: task,
  6.         required: true
  7.       }
  8.     }
  9.   });

现在:

  1.   User.findOne({
  2.     include: {
  3.       model: Project,
  4.       required: true,
  5.       include: {
  6.         model: Task,
  7.         required: true
  8.       }
  9.     }
  10.   });
  12.   User.findOne({
  13.     include: {
  14.       model: Project,
  15.       required: true,
  16.       include: {
  17.         model: Task,
  18.         where: {type: 'important'} //其中 required 默认为 true
  19.       }
  20.     }
  21.   });

或者，您可以添加 beforeFind hook 来获得兼容 v3 的行为 -

  1.   function propagateRequired(modelDescriptor) {
  2.     let include = modelDescriptor.include;
  4.     if (!include) return false;
  5.     if (!Array.isArray(include)) include = [include];
  7.     return include.reduce((isRequired, descriptor) => {
  8.       const hasRequiredChild = propogateRequired(descriptor);
  9.       if ((descriptor.where || hasRequiredChild) && descriptor.required === undefined) {
  10.         descriptor.required = true;
  11.       }
  12.       return descriptor.required || isRequired;
  13.     }, false);
  14.   }
  16.   const sequelize = new Sequelize(..., {
  17.     ...,
  18.     define: {
  19.       hooks: {
  20.         beforeFind: propagateRequired
  21.       }
  22.     }
  23.   });

新功能

  • sequelize.sync({ alter: true }) 的初始版本已添加，并使用 ALTER TABLE 命令来同步表。 迁移 仍然是首选，应在生产中使用。
  • 现在支持添加和删除数据库约束。 现有的 primary，foreignKey 和其他约束现在可以使用迁移来添加/删除 - 查看更多.

  • 实例（数据库行）现在是模型的实例，而不是单独类的实例。这意味着你可以替换User.build() 用 new User() 和 sequelize.define(attributes, options) 用

    1. class User extends Sequelize.Model {}
    2. User.init(attributes, options)

    然后，您可以直接在类中定义自定义方法，类方法和 getter / setter。
    这也使得有更多的使用模式，例如用 装饰器.

  • 增加了 DEBUG 支持。 现在可以使用 DEBUG = sequelize * node app.js 为所有 sequelize 操作启用日志记录。 要过滤记录的查询，请使用 DEBUG=sequelize:sql:mssql sequelize:connection* 来记录生成的SQL查询，连接信息等。
  • SQLite 添加了 JSON 数据类型支持。
  • UPSERT 现在使用 MERGE 语句支持 MSSQL。
  • 事务现在完全支持 MSSQL。

  • MSSQL 方言现在支持过滤的索引。

    1. queryInterface.addIndex(
    2.   'Person',
    3.   ['firstname', 'lastname'],
    4.   {
    5.     where: {
    6.       lastname: {
    7.         $ne: null
    8.       }
    9.     }
    10.   }
    11. )