使用Sequelize sync({alter:true})在Snowflake现有表加列时出错

我用Sequelize结合snowflake-sdk在Snowflake里建表、写数据都没问题，但想修改现有表结构时，用官网说的sync({alter: true})方法报错了。

最初建TEST_BG表没加address列，后来在模型里添了这个列，执行的代码如下：

// 创建表模型
const Test = sequelize.define(
  "TEST_BG",
  {
    firstName: DataTypes.TEXT,
    lastName: DataTypes.TEXT,
    favoriteColor: DataTypes.TEXT,
    age: DataTypes.INTEGER,
    occupation: DataTypes.TEXT,
    address: DataTypes.TEXT, // 新增的列
  },
  {
    timestamps: false,
  }
);

(async () => {
  console.log("连接已成功建立。");
  await Test.sync({ alter: true }).then(() => {
    console.log("表结构修改完成");
  });
})();

执行后弹出SQL编译错误：

Executing (default): SHOW FULL COLUMNS FROM "TEST_BG";

DatabaseError [SequelizeDatabaseError]: SQL compilation error:
syntax error line 1 at position 5 unexpected 'FULL'.
    at Query.formatError (C:\projects\snowflake\node-poc\node_modules\sequelize\lib\dialects\snowflake\query.js:207:16)
    at Query.run (C:\projects\snowflake\node-poc\node_modules\sequelize\lib\dialects\snowflake\query.js:57:18)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async C:\projects\snowflake\node-poc\node_modules\sequelize\lib\sequelize.js:314:16
    at async SnowflakeQueryInterface.describeTable (C:\projects\snowflake\node-poc\node_modules\sequelize\lib\dialects\abstract\query-interface.js:166:20)
    at async Promise.all (index 0)
    at async TEST_BG.sync (C:\projects\snowflake\node-poc\node_modules\sequelize\lib\model.js:947:26)
    at async Sequelize.sync (C:\projects\snowflake\node-poc\node_modules\sequelize\lib\sequelize.js:376:9)
    at async C:\projects\snowflake\node-poc\src\main.ts:47:3

问题出在Sequelize生成的SQL语句上：SHOW FULL COLUMNS FROM "TEST_BG"。Snowflake的SQL语法根本不支持SHOW FULL COLUMNS这种写法，正确查看表列的语句是DESCRIBE TABLE "TEST_BG"或者SHOW COLUMNS IN TABLE "TEST_BG"。

本质是Sequelize的Snowflake方言适配器没做好适配，处理alter同步逻辑时用了通用SQL的写法，没考虑Snowflake的语法规则。

1. 手动执行ALTER语句 #

直接绕开自动同步，自己写Snowflake兼容的修改语句：

await sequelize.query(`ALTER TABLE "TEST_BG" ADD COLUMN address TEXT`);

2. 升级Sequelize及Snowflake方言包 #

检查你用的Sequelize和对应的Snowflake方言包版本，更新到最新版，说不定官方已经修复了这个语法适配的bug，之后再试sync({alter: true})。

3. 用Sequelize Migrations迁移工具（推荐生产环境使用） #

Migrations是更规范可靠的表结构变更方式，步骤如下：

• 生成迁移文件：

npx sequelize-cli migration:generate --name add-address-to-test-bg

• 打开生成的迁移文件，编写变更逻辑：

'use strict';

module.exports = {
  async up(queryInterface, Sequelize) {
    // 新增address列
    await queryInterface.addColumn('TEST_BG', 'address', {
      type: Sequelize.TEXT
    });
  },

  async down(queryInterface, Sequelize) {
    // 回滚操作：删除address列
    await queryInterface.removeColumn('TEST_BG', 'address');
  }
};

• 执行迁移：

npx sequelize-cli db:migrate

内容的提问来源于stack exchange，提问作者Bhushan Goel