ts-sqlx

无 DSL 的 TypeScript SQLx 编译时检查查询。

入门指南

全局安装 ts-sqlx 命令行工具

cargo install ts_sqlx

在项目中安装 TypeScript 定义

npm install ts-sqlx -D

在您的 tsconfig.json 中包含生成的声明文件路径

{
  // default destination of declaration files
  "include": [".ts-sqlx/*"]
}

创建一个 .env 文件，将 DATABASE_URL 设置为您的数据库 URL

DATABASE_URL=postgres://postgres:postgres@localhost:5432/postgres

或者创建一个 .ts-sqlx.json 文件如下

{
  "databases": {
    "default": "postgres://postgres:postgres@localhost:5432/postgres",
    "another": "postgres://postgres:postgres@localhost:5432/postgres"
  },
  // defaults shown below, the rest of these are optional
  "src": ".",
  "dest": ".ts-sqlx",
  "extensions": ["ts", "tsx", "js", "jsx"],
  "ignore_patterns": ["*.d.ts"]
}

在您的项目根目录中运行 ts-sqlx watch 以监视模式，只需一次使用 ts-sqlx run 或使用 ts-sqlx help 获取帮助

查看 示例 了解一个“完整”项目示例

参考资料

• sqlx
• sqlx-ts