为 SQL 文件生成 TypeScript

Posted 2023-03-10

【中文标题】为 SQL 文件生成 TypeScript

【英文标题】：TypeScript generation for SQL files

【发布时间】：2018-11-07 08:19:22

【问题描述】：

我很想知道是否有人遇到过可以根据 SQL 查询的预期结果生成 TypeScript 类型定义的工具？也就是说，有没有接受SQL schema和.sql文件并根据查询的预期结果输出.ts文件的CLI？

Such a tool already exists for GraphQL queries 我的团队发现它非常有用，因为它完全消除了与手动类型定义相关的错误。

【问题讨论】：

你的意思是基于SQL查询生成模型吗？

@OPV 见github.com/apollographql/apollo-codegen。它将 GraphQL 文件转换为预期结果的类型定义。

【参考方案1】：

是的，PgTyped 是一个可以做到这一点的新工具。 它允许您为原始 SQL 查询生成 TypeScript 接口。

它的工作原理与 apollo-codegen 类似，但您的 SQL 查询需要使用 sql 标签而不是 gql 标签。

它仅支持 PostgreSQL，仍处于 beta 阶段，但我正在积极研究它，欢迎任何贡献。