从调库到翻源代码:给wakapi增加SQL Server支持
内容提要
本文分享了将开源项目迁移到SQL Server数据库时遇到的问题和解决方法,包括数据记录工具的局限性、替代品wakapi的发现、SQL语句兼容性、数据库migration中的原生SQL语句和片段、数据类型映射、级联外键约束等。作者总结了解决问题的方法和实践的收获。
延伸解读
SQL方言差异:从布尔值到别名
文章通过多个实例展示了SQL Server与其他数据库的语法差异。例如,SQL Server没有布尔类型,TRUE/FALSE需用1/0表示,且不能直接用于WHERE条件;UPDATE语句中不支持表别名;user等关键词需用双引号或方括号转义。这些细节提醒开发者,在跨数据库迁移时,不能假设标准SQL完全通用,需针对目标数据库调整原生SQL语句。
利用ORM适配器解决标识符引用
面对不同数据库的标识符引用规则(如MySQL用反引号,SQL Server用双引号或方括号),作者没有手动实现转义逻辑,而是复用gorm Dialector接口的QuoteTo方法。通过将clause.Writer接口与strings.Builder结合,调用适配器内置的引用逻辑,确保同一套代码在不同数据库下生成正确的SQL。这体现了DRY原则,也降低了对数据库细节的依赖。
数据类型映射与自定义GormDBDataType
SQL Server的timestamp类型用于乐观锁,每表只能有一个,而其他数据库用它表示时间戳。作者通过为CustomTime类型实现GormDBDataType接口,根据当前Dialector动态返回列类型:SQL Server下用datetimeoffset,其他数据库用timestamp,并支持通过timeScale标签指定精度。这种方法解决了同一Go类型在不同数据库中映射为不同列类型的问题,具有可复用性。
级联外键与Upsert的兼容性处理
SQL Server不允许级联外键造成循环或多重路径,而wakapi中Summary与SummaryItem的多个相同外键触发了此限制。作者通过只保留一个外键约束、其余字段标记gorm:"-"来避免递归。此外,SQL Server不支持ON CONFLICT DO NOTHING,gorm的SQL Server适配器因bug未能生成MERGE INTO,作者最终采用逐条插入并忽略重复键错误的方式规避。这些方案虽不完美,但保证了功能可用。
Q&A
为什么选择wakapi替代wakatime?
wakatime免费用户只能保存14天数据,且没有官方可自部署的后端;wakapi重新实现了wakatime的后端API,可以完全自己部署,数据掌握在自己手中,并且兼容wakatime的客户端插件。
在wakapi中增加SQL Server支持时,主要遇到了哪些SQL语句兼容性问题?
主要问题包括:SQL Server不支持TRUE/FALSE常量(需用1/0代替);不支持UPDATE语句中的表别名;不支持JOIN USING语法(需改用JOIN ON);不支持LIMIT OFFSET(需改用OFFSET FETCH);以及关键字如user需用引号转义。
如何解决gorm中不同数据库列类型映射的问题?
通过实现GormDBDataTypeInterface接口,在自定义类型(如CustomTime)的GormDBDataType方法中根据Dialector类型返回不同的数据库列类型。例如,对于SQL Server返回datetimeoffset,其他数据库返回timestamp。同时使用自定义tag(如timeScale)来指定精度。
SQL Server中级联外键约束报错的原因是什么?如何解决?
原因是在Summary和SummaryItem之间定义了多个相同的级联外键,导致SQL Server检测到级联循环而报错。解决方法是在Summary结构体中只保留一个字段的外键约束tag,其他字段使用gorm:"-"来忽略外键生成。
gorm的SQL Server适配器在upsert时有什么bug?如何规避?
bug是gorm的SQL Server适配器在生成upsert语句时,错误地检查主键是否存在,而忽略了unique index,导致无法生成MERGE INTO语句,而是生成普通的INSERT INTO,从而在重复键时插入失败。规避方法是手动逐条插入,并捕获重复键错误进行忽略。
如何重用gorm Dialector中的引号转义逻辑?
通过调用Dialector的QuoteTo方法,传入一个strings.Builder作为clause.Writer,将标识符转义后写入builder,最后从builder获取字符串。这样就能利用各数据库适配器已有的转义逻辑,确保兼容性。