Kysely项目在PostgreSQL中处理自定义数据类型的变化

Kysely是一个TypeScript SQL查询构建器，近期在0.27.3版本中对PostgreSQL自定义数据类型的处理方式进行了调整。这一变化影响了开发者在使用addColumn方法时处理PostgreSQL自定义数据类型的方式。

背景

PostgreSQL支持用户定义的数据类型（如vector(3)），这些类型不属于标准SQL类型集。在Kysely 0.27.2及更早版本中，开发者可以直接将这些自定义类型名称作为字符串传递给addColumn方法，虽然这会产生TypeScript类型错误，但在运行时能够正常工作。

变更内容

从0.27.3版本开始，Kysely不仅会在编译时通过TypeScript类型系统阻止这种用法，还会在运行时进行验证。现在，如果尝试直接传递自定义类型名称字符串，会收到"invalid column data type"错误。

正确的使用方法

Kysely团队明确指出，处理自定义数据类型的正确方式是使用sql模板标签。这种方法既符合类型安全的要求，又能确保代码的可维护性。示例如下：

import { sql } from "kysely";

await db.schema
  .createTable("items")
  .addColumn("embedding", sql`vector(3)`)
  .execute();

设计考量

这一变更体现了Kysely团队对类型安全的重视。虽然表面上看是限制了灵活性，但实际上：

1. 强制开发者使用更安全、更明确的方式处理特殊场景
2. 保持了API的一致性
3. 避免了潜在的类型安全问题
4. 使代码意图更加清晰

对开发者的建议

对于从旧版本升级的项目：

1. 检查所有使用自定义PostgreSQL类型的表创建语句
2. 将直接传递类型名称字符串的用法替换为sql模板标签
3. 利用TypeScript的类型检查来捕获潜在问题

这一变更虽然需要一些代码调整，但从长远来看有助于构建更健壮、更易维护的数据库访问层。Kysely团队通过这种方式确保了库的稳定性和可靠性，同时也为开发者提供了处理边缘情况的明确指导。