扩展数据类型

你尝试实现的类型很可能已包含在 DataTypes 中. 如果未包含新数据类型,本手册将说明如何自行编写.

Sequelize 不会在数据库中创建新的数据类型. 本教程介绍如何使 Sequelize 识别新的数据类型,并假设已在数据库中创建了这些新的数据类型.

要扩展 Sequelize 数据类型,请在创建任何实例之前执行此操作. 此示例创建一个虚拟的 NEWTYPE,它复制内置数据类型 Sequelize.INTEGER(11).ZEROFILL.UNSIGNED.

  1. // myproject/lib/sequelize.js
  3. const Sequelize = require('Sequelize');
  4. const sequelizeConfig = require('../config/sequelize')
  5. const sequelizeAdditions = require('./sequelize-additions')
  7. // 添加新数据类型的函数
  8. sequelizeAdditions(Sequelize)
  10. // 在这个例子中,创建并导出Sequelize实例
  11. const sequelize = new Sequelize(sequelizeConfig)
  13. module.exports = sequelize
  1. // myproject/lib/sequelize-additions.js
  3. module.exports = function sequelizeAdditions(Sequelize) {
  5.   DataTypes = Sequelize.DataTypes
  7.   /*
  8.    * 创建新类型
  9.    */
  10.   class NEWTYPE extends DataTypes.ABSTRACT {
  11.     // 强制,在数据库中完整定义新类型
  12.     toSql() {
  13.       return 'INTEGER(11) UNSIGNED ZEROFILL'
  14.     }
  16.     // 可选,验证器功能
  17.     validate(value, options) {
  18.       return (typeof value === 'number') && (! Number.isNaN(value))
  19.     }
  21.     // 可选,sanitizer
  22.     _sanitize(value) {
  23.       // Force all numbers to be positive
  24.       if (value < 0) {
  25.         value = 0
  26.       }
  28.       return Math.round(value)
  29.     }
  31.     // 可选,发送到数据库之前的值字符串
  32.     _stringify(value) {
  33.       return value.toString()
  34.     }
  36.     // 可选,解析从数据库接收的值
  37.     static parse(value) {
  38.       return Number.parseInt(value)
  39.     }
  40.   }
  42.   DataTypes.NEWTYPE = NEWTYPE;
  44.   // 强制,设置 Key
  45.   DataTypes.NEWTYPE.prototype.key = DataTypes.NEWTYPE.key = 'NEWTYPE'
  47.   // 可选, 在stringifier后禁用转义. 不建议.
  48.   // 警告:禁用针对SQL注入的Sequelize保护
  49.   // DataTypes.NEWTYPE.escape = false
  51.   // 为了简便`classToInvokable` 允许你使用没有 `new` 的数据类型
  52.   Sequelize.NEWTYPE = Sequelize.Utils.classToInvokable(DataTypes.NEWTYPE)
  54. }

创建此新数据类型后,你需要在每个数据库方言中映射此数据类型并进行一些调整.