解决golang-migrate在Google Cloud Spanner模拟器中的外键约束问题

在使用golang-migrate进行数据库迁移时，开发者可能会遇到一个特定于Google Cloud Spanner模拟器的外键约束问题。当迁移脚本包含外键关系但未明确指定删除操作时，系统会抛出"ON DELETE NO ACTION is not supported"的错误。

问题现象

当运行包含如下SQL的迁移脚本时：

CREATE TABLE primary_table (
  id STRING(36) NOT NULL,
  first_name STRING(1024) NOT NULL,
  created_at TIMESTAMP NOT NULL,
  updated_at TIMESTAMP NOT NULL,
) PRIMARY KEY(id);

CREATE TABLE secondary_table (
  id STRING(36) NOT NULL,
  first_name STRING(1024) NOT NULL,
  created_at TIMESTAMP NOT NULL,
  updated_at TIMESTAMP NOT NULL,
  CONSTRAINT fk_primary_table_id FOREIGN KEY(id) REFERENCES primary_table(id),
) PRIMARY KEY(id);

迁移会失败并显示错误信息："Foreign key referential action ON DELETE NO ACTION is not supported"，尽管SQL语句中并未显式包含"ON DELETE NO ACTION"子句。

问题根源

这个问题源于Google Cloud Spanner模拟器的特定行为。在Spanner中，外键约束必须明确指定删除操作（如CASCADE、SET NULL等），而默认的NO ACTION行为不被支持。这与许多传统关系型数据库的行为不同，后者通常允许NO ACTION作为默认选项。

解决方案

1. 升级模拟器版本：将Google Cloud Spanner模拟器升级到1.5.13或更高版本可以解决此问题。新版本模拟器对外键约束的处理更加灵活。

2. 显式指定删除操作：如果无法升级模拟器，可以在SQL中明确指定支持的删除操作，例如：

CONSTRAINT fk_primary_table_id FOREIGN KEY(id) REFERENCES primary_table(id) ON DELETE CASCADE

支持的删除操作包括：

• CASCADE：级联删除
• SET NULL：设置为NULL（如果列允许NULL值）
• RESTRICT：限制删除（类似于NO ACTION但语义更明确）

最佳实践

1. 明确指定外键行为：即使在某些环境中NO ACTION是默认行为，也建议显式指定所有外键约束的行为，以提高代码的可读性和可移植性。

2. 测试环境一致性：确保开发和测试环境使用的Spanner模拟器版本与生产环境一致，避免因版本差异导致的行为不一致。

3. 版本控制：将数据库迁移工具和模拟器的版本信息纳入项目的版本控制，便于团队协作和问题排查。

总结

Google Cloud Spanner作为分布式数据库，其外键约束实现与传统关系型数据库有所不同。开发者在使用golang-migrate等工具进行数据库迁移时，应当注意这些差异，特别是当使用模拟器进行本地开发时。通过升级工具链或明确指定外键行为，可以避免此类兼容性问题，确保迁移过程顺利进行。