¶Sequelize Migration

Sequelize 2 之後，增加了 cli 的功能
透過一次又一次的維護檔，確保移植時有相同的建構過程

migration 就是拿來變動資料表的。
所以，會有幾種動作在這裡處理。

• 變動資料表
• 變動欄位
• 變動資料表關聯

¶指令

要新增一次的 migration ，只要下這個指令，並且想好 migration message 。

$ sequelize migration:create --name <migration message>

就會產生檔案 migrations/20180703032321-<migration message>.js

sequelize db:migrate

執行檔案裡的 up()

sequelize db:migrate:undo

執行檔案裡的 down()

¶檔案架構

function up, down ，都回傳 promise

1
2
3
4
5
6
7
8
9
10
11

'use strict';

module.exports = {
  up: (queryInterface, Sequelize) => {
    // 要增加內容的動作
  },

  down: (queryInterface, Sequelize) => {
    // 要減少內容的動作
  }
};

下面來介紹一下，up() 和 down() 裡面要怎麼寫

¶資料表 & 資料表欄位

參考 attribute, options 用法

QueryInterface.methods

• 變動資料表
  • 新增資料表 createTable(tableName, attributes, options)
  • 刪除資料表 dropTable(tableName, options)
  • 刪除所有資料表 dropAllTables(options)
  • 重新命名資料表 renameTable(before, after, options)
  • 顯示資料表陣列 showAllTables(options)
    • tableNames 的 datatype Array
  • 顯示資料表 schema describeTable(tableName, options)
• 變動欄位
  • 增加欄位 addColumn(tableName, attributeName, dataTypeOrOptions, options)
  • 刪除欄位 removeColumn(tableName, attributeName, options)
  • 修改欄位設定 changeColumn(tableName, attributeName, dataTypeOrOptions, options)
  • 重新命名欄位 renameColumn(tableName, attrNameBefore, attrNameAfter, options)
• 變動索引(資料表屬性的功能)
  • 建立索引 addIndex(tableName, attributes, options)
  • 移除索引 removeIndex(tableName, indexNameOrAttributes, options)

¶執行 migrate 後要執行 SQL

使用 queryInterface.sequelize.query(SQL 語法) 的用法，可以讓 migration 完成時，也增加當時必要的 SQL 語法。

雖然是 query 的 method ，它卻是一個可以執行 SQL 語法，改變資料庫資料的 method。

up: (queryInterface, Sequelize) => {
  return queryInterface.method(
      //...
    }).then(() => {
      queryInterface.sequelize.query(`UPDATE table SET column=field`)
    })
}

¶資料表關聯

在 queryInterface.createTable / addColumn 中，在 attributes 定義欄位的物件中，寫 reference 決定資料庫變動後，關聯是否存在。

1
2
3
4
5
6
7
8
9
10
11
12
13
14

return queryInterface.addColumn(
  'tableName',
  'fieldName',
  {
    type: Sequelize.INTEGER.UNSIGNED,
    references: {
      model: 'tableName',
      key: 'fieldName'
    },
    onDelete: 'SET NULL',
    onUpdate: 'CASCADE'
    //...
  })
},

¶Hook

當呼叫 add/set 函數時，beforeUpdate/afterUpdate 也會執行
唯一可以執行 beforeDestroy/afterDestroy 的方式，就是設定 associations 屬性 onDelete: ‘cascade’
參考: http://docs.sequelizejs.com/manual/tutorial/hooks.html

呼叫 association 時，設定 hook 選項 ex: onUpdate, onDelete。
預設所有的關聯，更新用 CASCADE ，刪除用 SET NULL ，除了 n:m 關聯，用 CASCADE 刪除。

1. RESTRICT, 同 NO ACTION
2. CASCADE, 同步 update/delete 更新子表 foreign key
3. NO ACTION, 不允許主表 update/delete
4. SET DEFAULT, 子表 foreign key 設為 default (Innodb not use)
5. SET NULL, 子表 foreign key 設為 null

¶Available constraints:

• UNIQUE
• DEFAULT (MSSQL only)
• CHECK (MySQL - Ignored by the database engine )
• FOREIGN KEY
• PRIMARY KEY

UNIQUE

1
2
3
4

queryInterface.addConstraint('Users', ['email'], {
  type: 'unique',
  name: 'custom_unique_constraint_name'
});

CHECK

1
2
3
4
5
6

queryInterface.addConstraint('Users', ['roles'], {
  type: 'check',
  where: {
     roles: ['user', 'admin', 'moderator', 'guest']
  }
});

Default - MSSQL only

1
2
3
4

queryInterface.addConstraint('Users', ['roles'], {
   type: 'default',
   defaultValue: 'guest'
});

Primary Key

1
2
3
4

queryInterface.addConstraint('Users', ['username'], {
   type: 'primary key',
   name: 'custom_primary_constraint_name'
});

Foreign Key

1
2
3
4
5
6
7
8
9
10

queryInterface.addConstraint('Posts', ['username'], {
  type: 'foreign key',
  name: 'custom_fkey_constraint_name',
  references: { //Required field
    table: 'target_table_name',
    field: 'target_column_name'
  },
  onDelete: 'cascade',
  onUpdate: 'cascade'
});