为关联到唯一非主键的字段设置默认值的Sequelize问题

问题场景 #

使用Sequelize定义Account和Status两张表，期望Account的status字段关联Status表的非主键字段name，并默认关联name为offline的记录，但执行sequelize.sync()时抛出SQL语法错误。

模型定义代码：

class Account extends Model {
    static associate(models) {
      Account.belongsTo(models.Status, {
        targetKey: 'name',
        foreignKey: { name: 'status', allowNull: false, defaultValue: 'offline' },
      })
    }}

Account.init(
    {
      firstName: { type: DataTypes.STRING, allowNull: false },
      lastName: { type: DataTypes.STRING, allowNull: false },
      email: { type: DataTypes.STRING, allowNull: false, unique: true },
      password: { type: DataTypes.STRING, allowNull: false },
      image: DataTypes.STRING,
      telephone: DataTypes.STRING,
    },
    {
      sequelize,
      tableName: 'accounts',
    },
)

class Status extends Model {}
Status.init(
    {
      name: { type: DataTypes.STRING, allowNull: false, unique: true },
    },
    {
      sequelize,
      tableName: 'statuses',
    },
)

Sequelize生成的错误SQL：

ALTER TABLE "accounts" ALTER COLUMN "status" SET NOT NULL;ALTER TABLE "accounts" ALTER COLUMN "status" SET DEFAULT 'offline' REFERENCES "statuses" ("name") ON DELETE NO ACTION ON UPDATE CASCADE;ALTER TABLE "accounts" ALTER COLUMN "status" TYPE VARCHAR(255);

抛出的错误：

syntax error at or near «REFERENCES»

错误原因 #

PostgreSQL不允许在SET DEFAULT语句后直接跟随REFERENCES外键约束定义。Sequelize错误地将默认值设置和外键约束合并到同一条SQL语句中，违反了PostgreSQL的语法规则。

解决方案 #

1. 修正模型定义 #

将status字段的定义从关联配置中移到Account.init的字段列表里，单独设置默认值、非空约束和外键规则，避免Sequelize生成错误SQL：

class Account extends Model {
    static associate(models) {
      // 关联配置仅指定目标键和外键字段名
      Account.belongsTo(models.Status, {
        targetKey: 'name',
        foreignKey: 'status',
      })
    }
}

Account.init(
    {
      firstName: { type: DataTypes.STRING, allowNull: false },
      lastName: { type: DataTypes.STRING, allowNull: false },
      email: { type: DataTypes.STRING, allowNull: false, unique: true },
      password: { type: DataTypes.STRING, allowNull: false },
      image: DataTypes.STRING,
      telephone: DataTypes.STRING,
      // 单独定义status字段
      status: {
        type: DataTypes.STRING,
        allowNull: false,
        defaultValue: 'offline',
        // 明确指定外键约束
        references: {
          model: 'statuses',
          key: 'name'
        },
        onUpdate: 'CASCADE',
        onDelete: 'NO ACTION'
      }
    },
    {
      sequelize,
      tableName: 'accounts',
    },
)

Status模型保持原有定义不变。

2. 确保初始化数据存在 #

必须先在statuses表中插入name为offline的记录，否则插入Account数据或创建表时会触发外键约束失败：

INSERT INTO "statuses" ("name") VALUES ('offline');

也可以通过Sequelize的seed脚本完成初始化。

3. 手动执行正确的SQL（可选） #

如果自动同步仍然有问题，可以手动执行拆分后的正确SQL语句：

首先添加/修改status字段并设置默认值：

ALTER TABLE "accounts" 
ADD COLUMN "status" VARCHAR(255) NOT NULL DEFAULT 'offline';

然后添加外键约束：

ALTER TABLE "accounts" 
ADD CONSTRAINT "accounts_status_fkey" FOREIGN KEY ("status") 
REFERENCES "statuses" ("name") 
ON DELETE NO ACTION ON UPDATE CASCADE;

内容的提问来源于stack exchange，提问作者Guido Glielmi