go-jet/jet 项目中 SQL 构建器的 RETURNING 子句别名处理分析

背景介绍

在数据库操作中，INSERT 语句的 RETURNING 子句是一个非常有用的特性，它允许我们在插入数据后立即返回插入的记录。go-jet/jet 作为一个强大的 SQL 构建器库，为 Go 语言提供了类型安全的 SQL 构建能力。

问题描述

在使用 go-jet/jet 构建 INSERT 语句时，当为表指定别名后，RETURNING 子句会自动为每个返回列添加完整的别名限定（如 t.col_1 AS "t.col_1"）。这种自动添加的完整别名限定在某些情况下可能与应用程序的数据扫描逻辑产生冲突。

技术细节

默认行为分析

go-jet/jet 的默认行为是为 RETURNING 子句中的列生成包含表别名的完整限定名。例如：

INSERT INTO schema.tables AS t (col_1, col_2)
VALUES ($1, $2)
RETURNING t.col_1 AS "t.col_1", t.col_2 AS "t.col_2";

这种设计确保了返回的列名具有明确的命名空间，避免了可能的列名冲突。

用户期望行为

部分用户希望 RETURNING 子句能够省略 AS 别名部分，直接返回列名：

INSERT INTO schema.tables AS t (col_1, col_2)
VALUES ($1, $2)
RETURNING t.col_1, t.col_2;

这种需求通常出现在使用特定 ORM 或数据扫描工具时，这些工具可能期望简单的列名而非完全限定的别名。

解决方案探讨

1. 显式指定列别名

用户可以通过显式地为每列指定简化的别名来解决此问题：

tables.Col1.AS("col_1"),
tables.Col2.AS("col_2")

这种方法提供了最大的灵活性，但需要为每列单独指定。

2. 调整数据模型标记

修改数据结构的 db 标签，使其包含表别名前缀：

type Table struct {
    Col1 pgtype.Date `db:"t.col_1"`
    Col2 pgtype.Time `db:"t.col_2"`
}

3. 不使用表别名

在简单查询中，可以完全省略表别名：

INSERT INTO schema.tables (col_1, col_2)
VALUES ($1, $2)
RETURNING col_1, col_2;

4. 自定义扫描逻辑

实现自定义的扫描逻辑，能够处理带别名的列名。

5. 修改查询引擎

对于有控制权的查询引擎，可以修改其解析逻辑以适应带别名的列名。

技术权衡

每种解决方案都有其优缺点：

1. 显式别名：最灵活但最繁琐
2. 调整标记：需要修改数据结构
3. 省略别名：最简单但可能失去命名空间保护
4. 自定义扫描：需要额外开发工作
5. 修改引擎：适用于长期项目但工作量大

最佳实践建议

对于大多数项目，建议采用以下策略：

• 在简单应用中使用省略别名的方法
• 在复杂应用中采用显式别名或调整数据模型标记
• 对于长期维护的大型项目，考虑修改查询引擎以适应项目需求

结论

go-jet/jet 的当前设计提供了明确的列名限定，确保了查询的清晰性和安全性。虽然它可能不直接满足所有使用场景，但通过提供的多种解决方案，开发者可以根据项目需求选择最适合的方法。理解这些技术细节有助于开发者更好地利用 go-jet/jet 构建健壮的数据库应用。