【TypeScript】クエリビルダーの型安全な実装 - 型定義でSQL生成の信頼性を向上

クエリビルダーと型安全の重要性

クエリビルダーは、SQLクエリを動的に生成するための仕組みであり、データベース操作をプログラムコード内で簡潔かつ柔軟に行うことができます。しかし、SQL文の動的生成には誤りが生じやすく、タイプミスや構文エラーによるデータベース操作の失敗が発生しがちです。 TypeScriptの型定義を活用してクエリビルダーを型安全に実装することで、SQLの構文チェックやデータ型の整合性を保証し、エラーを未然に防ぐことが可能になります。

型安全なクエリビルダーの基本構成

TypeScriptを使った型安全なクエリビルダーを実装するには、クエリ構築のためのクラスや関数に対して厳密な型定義を行います。まず、データベースのテーブルや列の情報をTypeScriptで表現し、クエリビルダーが型チェックを活用して適切なSQLを生成できるようにします。

Step 1: テーブルと列の型定義

クエリビルダーを型安全に扱うために、データベースのテーブル構造をTypeScriptの型で表現します。以下に、Userテーブルを例として型定義を示します。

type User = {
  id: number;
  name: string;
  email: string;
  isActive: boolean;
};

この型定義によって、Userテーブルの各列（フィールド）に対応する型が指定され、以降のクエリビルダー処理で活用できます。

Step 2: クエリビルダークラスの作成

次に、型安全なクエリを生成するためのクエリビルダークラスを作成します。この例では、selectメソッドで指定した列をSQLクエリとして生成し、型チェックが行われるように実装します。

class QueryBuilder<T> {
  private table: string;
  private fields: (keyof T)[] = [];
  constructor(table: string) {
    this.table = table;
  }
  select(...fields: (keyof T)[]): QueryBuilder<T> {
    this.fields = fields;
    return this;
  }
  toSQL(): string {
    const columns = this.fields.length ? this.fields.join(", ") : "*";
    return `SELECT ${columns} FROM ${this.table}`;
  }
}

このQueryBuilderクラスでは、selectメソッドで選択する列を指定し、toSQLメソッドでSQLクエリ文字列を生成します。keyof Tを使用することで、Userの型に応じた列名のみが許容され、型安全なクエリビルダーが実現できます。

使用例

定義したQueryBuilderを用いて、以下のようにUserテーブルから特定の列を選択するクエリを生成します。

const userQuery = new QueryBuilder<User>("User")
  .select("id", "name")
  .toSQL();
console.log(userQuery); // 出力: "SELECT id, name FROM User"

このように、指定した列が型に合致しない場合はTypeScriptがエラーを表示し、構文エラーの防止に役立ちます。

WHERE句や条件指定の型安全な実装

クエリビルダーでは、WHERE句やフィルタ条件を設定することも重要です。次に、条件を追加できるwhereメソッドを実装してみます。

class QueryBuilder<T> {
  private table: string;
  private fields: (keyof T)[] = [];
  private conditions: string[] = [];
  constructor(table: string) {
    this.table = table;
  }
  select(...fields: (keyof T)[]): QueryBuilder<T> {
    this.fields = fields;
    return this;
  }
  where<K extends keyof T>(field: K, value: T[K]): QueryBuilder<T> {
    this.conditions.push(`${field} = '${value}'`);
    return this;
  }
  toSQL(): string {
    const columns = this.fields.length ? this.fields.join(", ") : "*";
    const whereClause = this.conditions.length ? ` WHERE ${this.conditions.join(" AND ")}` : "";
    return `SELECT ${columns} FROM ${this.table}${whereClause}`;
  }
}

解説

• ジェネリック型の条件指定
  whereメソッドで使用しているK extends keyof Tは、指定する列が型T（ここではUser型）に存在することを保証します。

• 条件値の型チェック
  valueの型はT[K]としており、指定した列のデータ型に一致する値のみが受け入れられるため、値の整合性が保たれます。

WHERE句付きのクエリ生成

WHERE句を指定してクエリを作成する例を以下に示します。

const userQuery = new QueryBuilder<User>("User")
  .select("id", "name")
  .where("isActive", true)
  .toSQL();
console.log(userQuery); // 出力: "SELECT id, name FROM User WHERE isActive = 'true'"

このコードにより、型に合わない列や条件値を指定するとコンパイルエラーが発生し、開発段階でエラーを発見できます。

型安全なクエリビルダーでのJOIN句の実装

複数のテーブルを結合するJOIN句も、型安全なクエリビルダーでは重要な機能です。JOIN句の実装には、複数のテーブル型をサポートするためにジェネリック型をさらに活用します。

class QueryBuilder<T> {
  private table: string;
  private fields: (keyof T)[] = [];
  private joins: string[] = [];
  private conditions: string[] = [];
  constructor(table: string) {
    this.table = table;
  }
  select(...fields: (keyof T)[]): QueryBuilder<T> {
    this.fields = fields;
    return this;
  }
  join<U>(table: string, condition: string): QueryBuilder<T & U> {
    this.joins.push(`JOIN ${table} ON ${condition}`);
    return this as QueryBuilder<T & U>;
  }
  where<K extends keyof T>(field: K, value: T[K]): QueryBuilder<T> {
    this.conditions.push(`${field} = '${value}'`);
    return this;
  }
  toSQL(): string {
    const columns = this.fields.length ? this.fields.join(", ") : "*";
    const joinClause = this.joins.join(" ");
    const whereClause = this.conditions.length ? ` WHERE ${this.conditions.join(" AND
 ")}` : "";
    return `SELECT ${columns} FROM ${this.table} ${joinClause}${whereClause}`;
  }
}

JOIN句の利用例

このクエリビルダーにJOIN句を追加すると、次のようなクエリが生成可能になります。

type Order = {
  orderId: number;
  userId: number;
  amount: number;
};
const orderQuery = new QueryBuilder<User>("User")
  .select("id", "name", "orderId", "amount")
  .join<Order>("Order", "User.id = Order.userId")
  .where("isActive", true)
  .toSQL();
console.log(orderQuery); 
// 出力: "SELECT id, name, orderId, amount FROM User JOIN Order ON User.id = Order.userId WHERE isActive = 'true'"

JOINするテーブルに応じた型を定義することで、異なるテーブル間の型安全な結合クエリを生成できます。

まとめ

TypeScriptで型安全なクエリビルダーを実装することで、SQL生成時の型チェックが行われ、構文エラーや不正なデータ型のエラーを未然に防ぐことが可能です。ジェネリック型を活用し、複数のテーブルに対応するJOIN句や条件指定も型安全に扱えるクエリビルダーを構築することで、データベースアクセスの信頼性が向上します。型安全なクエリビルダーを取り入れて、安全かつ効率的なデータベース操作を実現しましょう。