SuperAPI AI 工具集

sqlc-gen-typescript-dal

编程与开发

查看项目

更新于 10-16 07:15

技能介绍

用途:为 PostgreSQL 项目生成并维护 TypeScript 数据访问层,基于 sqlc 与 tylergannon/sqlc-gen-typescript WASM 插件,运行时使用 postgres.js。

主要能力:配置 sqlc.yaml 插件(含 release WASM URL 与本地 WASM 构建)、生成 DAL、通过 options.overrides 与 ts_type/raw_type/convert 定制类型映射、按 PostgreSQL 方言规则约束查询与 schema(命名参数、可空性、JSON、枚举、bigint 及不支持类型)。

使用方式:先检查仓库中现有 sqlc.yaml、schema 文件、query 文件、生成的 DB 目录、包管理器与 postgres.js 客户端配置。编辑配置前阅读 references/configuration.md;修改 SQL 前阅读 references/postgresql-dialect.md;改动 options.overrides 前阅读 references/type-overrides.md。默认用 release WASM 插件,除非用户明确要求本地开发构建。执行 sqlc generate 生成 DAL,若仓库有 just generate、npm run generate 或 pnpm sqlc 等包装命令则优先使用。应用代码负责把配置好的 postgres Sql 客户端传入生成函数,生成函数不负责连接初始化。最后运行 sqlc 生成与目标仓库的 TypeScript 检查/测试来验证。

限制:仅面向 PostgreSQL,不要为该生成器配置 MySQL、SQLite 或 Bun SQL。运行时使用 postgres npm 包。不要手改生成文件,应修正 schema、query、配置或 override 输入。当 SQL 列为 snake_case 而 TypeScript 字段为 camelCase 时保留 transform: postgres.camel。当前 bigint 策略为 number,选用 int8、bigint、bigserial 或 serial8 时需配置 postgres.js 的 OID 20 解析,且避免用于可能超出 Number.MAX_SAFE_INTEGER 的值。其余细节在资料中未提供。