HN 日本語サマリー

← 一覧へ戻る
プログラミング

Show HN: Bun-sqlgen – Bunのためのタイプセーフな生SQL、ORM不要

Show HN: Bun-sqlgen – Type-safe raw SQL for Bun, no ORM (github.com)

17 pointsby ilbert8 コメント

要約

`bun-sqlgen`は、ORMを使用せずにBun環境でタイプセーフな生SQLクエリを可能にするツールです。スキーマに対してリアルタイムでクエリをチェックし、不正なカラム名やSQLエラーをビルド時に検出し、本番環境での障害を防ぎます。タグ付けされたクエリは呼び出し元で完全に型付けされ、null安全な結果を提供し、手書きの型定義やジェネリクスを不要にします。

全文翻訳

bun-sqlgen

あなたのBun.sqlクエリのための型ジェネレーター

Bunアプリケーションで型安全なSQLステートメントを持つためにORMは必要ありません。@ilbertt/bun-sqlgenは、クエリをスキーマに対して検証し、その結果の型を生成するコード生成ツールです。コード生成時にはデータベースを実行する必要はありません。なぜなら、マイグレーションはインメモリのWasm Postgres(PGlite)に対して実行されるからです。

インストール

bun add @ilbertt/bun-sqlgen

クイックスタート

  1. スキーマの真の情報源はマイグレーションです — 任意のフォルダに配置してください:

    -- db/migrations/0001_init.sql
    CREATE TABLE users (
      id           bigint PRIMARY KEY GENERATED ALWAYS AS IDENTITY,
      email        text NOT NULL,
      display_name text
    );
    
  2. クライアントをwithTypesでラップし、各クエリに名前をタグ付けしてください:

    import { withTypes } from '@ilbertt/bun-sqlgen';
    import { SQL } from 'bun';
    
    const sql = withTypes(new SQL('postgres://localhost/example'));
    
    export async function getUser(id: number) {
      const [user] = await sql.GetUser`
        SELECT id, email, display_name FROM users WHERE id = ${id}
      `;
      return user; // { id: string; email: string; display_name: string | null }
    }
    
  3. 型を生成してください:

    bun bun-sqlgen generate 'src/**/*.ts' --migrations db/migrations
    

    これにより src/queries.gen.ts が書き込まれます — コミットしてください。これが配置されると、user.whatever はコンパイルエラーになり、user.display_name.length は possibly-null としてフラグ付けされます。これらはすべてプレーンな tsc で行われます。

    同じファイルはスキーマも記述します — 各テーブルとビューには、そのカラム、インデックス名、制約名が含まれます:

    import type { DatabaseTables } from '@ilbertt/bun-sqlgen';
    
    type UserRow = DatabaseTables['users']['columns']; // { id: string; email: string; … }
    type UserIndex = DatabaseTables['users']['indexes']; // 'users_pkey' | 'users_email_idx'
    

例

実行可能なプロジェクトは examples/ フォルダにあります。

貢献

開発セットアップと規約は CONTRIBUTING.md にあります。