Soul项目PostgreSQL数据库升级脚本问题分析与解决方案

问题背景

在开源网关项目Soul(现更名为ShenYu)的版本迭代过程中，PostgreSQL数据库升级脚本存在多处问题，这些问题在实际生产环境升级时会导致SQL执行失败。本文将详细分析这些问题的根源，并提供相应的解决方案。

主要问题分析

1. 非空约束字段添加问题

在2.5.1到2.6.0版本的升级脚本中，存在以下典型问题：

ALTER TABLE selector ADD COLUMN match_restful TINYINT(0) NOT NULL
COMMENT 'whether to match restful(0 cache, 1 not cache)';

ALTER TABLE rule ADD COLUMN match_restful TINYINT(0) NOT NULL
COMMENT 'whether to match restful(0 cache, 1 not cache)';

问题分析：

• 当表中已存在数据时，添加NOT NULL约束的新列会导致SQL执行失败
• PostgreSQL中TINYINT(0)的语法不正确，PostgreSQL应使用SMALLINT或BOOLEAN类型
• 这种设计没有考虑已有数据的表升级场景

2. 数据类型与操作不匹配问题

在2.6.0到2.6.1版本的升级脚本中，存在DELETE语句与字段类型不匹配的问题：

问题分析：

• 数据库字段定义为VARCHAR类型，但DELETE语句中的条件值类型不匹配
• 这种类型不匹配会导致SQL执行失败
• 缺乏对PostgreSQL严格类型检查的考虑

3. COLLATE使用不当问题

在discovery_upstream表的升级脚本中，对INT2类型字段使用了COLLATE：

问题分析：

• INT2(SMALLINT)是整数类型，不应该使用COLLATE修饰
• COLLATE通常用于字符类型(如VARCHAR/TEXT)的排序规则设置
• 这种错误使用会导致SQL语法错误

解决方案建议

1. 非空字段添加的正确做法

对于需要添加NOT NULL约束的新列，应采用以下模式：

-- 先添加允许为NULL的列
ALTER TABLE selector ADD COLUMN match_restful SMALLINT;
-- 设置默认值
UPDATE selector SET match_restful = 0 WHERE match_restful IS NULL;
-- 最后添加NOT NULL约束
ALTER TABLE selector ALTER COLUMN match_restful SET NOT NULL;

2. 类型安全的SQL编写原则

• 确保操作语句中的值与字段类型严格匹配
• 对于VARCHAR类型的条件，应使用单引号包裹字符串值
• 考虑使用显式类型转换确保兼容性

3. 整数类型的正确使用

• PostgreSQL中应使用SMALLINT替代TINYINT
• 避免对整数类型使用COLLATE等字符类型特有的修饰符
• 保持与PostgreSQL原生类型的兼容性

最佳实践建议

1. 测试覆盖：升级脚本应在包含数据的测试环境验证通过后再发布
2. 增量式变更：将大的变更拆分为多个小步骤，降低失败风险
3. 回滚方案：为每个升级脚本准备对应的回滚方案
4. 环境适配：针对不同数据库(MySQL/PostgreSQL)提供专门的脚本
5. 文档记录：详细记录每个版本升级的数据库变更内容

总结

数据库升级脚本的质量直接影响系统的稳定性和可靠性。通过分析Soul项目中PostgreSQL升级脚本的具体问题，我们可以得出以下经验：必须充分考虑已有数据的场景、严格遵循目标数据库的语法规范、进行充分的测试验证。这些经验不仅适用于Soul项目，对于任何需要数据库迁移或升级的系统都具有参考价值。