SQLDelight中保留字列名转义问题的分析与解决

问题背景

在SQLDelight 2.0.2版本中，开发者发现了一个关于SQL保留字列名转义的有趣问题。当定义一个包含SQL保留字作为列名的表时，例如使用"index"作为列名，虽然在表创建语句中已经正确使用了反引号(`)进行转义，但在自动生成的插入对象查询中，转义却被意外丢失了。

问题复现

考虑以下SQLDelight表定义：

CREATE TABLE Examples (
    id TEXT NOT NULL PRIMARY KEY,
    `index` INTEGER NOT NULL
);

insertObject:
INSERT INTO Examples VALUES ?;

insertColumns:
INSERT INTO Examples (id, `index`) VALUES (?, ?);

问题出现在自动生成的Kotlin代码中。对于insertObject查询，生成的SQL语句没有正确转义"index"列名：

public fun insertObject(Examples: Examples) {
    driver.execute(-292_750_836, """INSERT INTO Examples (id, index) VALUES (?, ?)""", 2) {
          bindString(0, Examples.id)
          bindLong(1, Examples.index)
        }
    // ...
}

而手动指定列的insertColumns查询则正确生成了转义：

public fun insertColumns(id: String, index: Long) {
    driver.execute(2_124_028_592, """INSERT INTO Examples (id, `index`) VALUES (?, ?)""", 2) {
          bindString(0, id)
          bindLong(1, index)
        }
    // ...
}

技术分析

这个问题源于SQLDelight编译器在处理对象插入查询时的列名提取逻辑。在内部实现中，编译器使用了it.name来获取列名，这会导致丢失原有的转义信息。正确的做法应该是使用it.node.text，这样可以保留原始SQL中定义的转义符号。

这个问题与之前修复的表名转义问题类似，都是由于没有正确处理SQL中的转义标识符导致的。在SQL语法中，使用反引号(`)或双引号(")可以转义保留字作为标识符，这在定义包含SQL关键字作为列名或表名时非常必要。

解决方案

仓库协作者已经确认了这个问题，并指出了具体的修复位置。修复方案是修改列名提取逻辑，从使用it.name改为使用it.node.text，这样可以确保保留原始SQL中定义的转义信息。

这个修复将确保无论是表定义还是查询生成，所有使用SQL保留字作为标识符的地方都能正确保持转义，从而避免SQL语法错误。

临时解决方案

在官方修复发布前，开发者可以采用以下临时解决方案：

1. 避免在对象插入查询中使用保留字列名
2. 使用显式列名的插入语法（如示例中的insertColumns）
3. 为保留字列名创建别名

总结

SQLDelight作为一款优秀的SQL与Kotlin之间的桥梁工具，在处理SQL特殊语法时需要考虑各种边界情况。这个转义问题的发现和修复，体现了开源社区对细节的关注和对质量的追求。开发者在使用SQLDelight时，应当注意检查生成的SQL语句是否符合预期，特别是在使用SQL保留字作为标识符时。