概要

Drizzleは、Node.jsアプリケーション向けの軽量で強力なORMであり、アプリケーションのデータベース操作を簡潔に行えることが特徴です。その中でもカスタム型の機能は、特定のデータ型をアプリケーションのニーズに合わせて柔軟に管理できる強力なツールです。通常のプリミティブ型だけでは対応できない、特定のデータフォーマットや変換処理が必要な場面で活躍します。 本記事では、Drizzle ORMでカスタム型を定義する方法を詳しく解説し、アプリケーション固有のデータ要件に合わせたデータベース管理の手法について紹介します。

Drizzle ORMにおけるカスタム型とは？

Drizzle ORMのカスタム型は、データベースからデータを取得する際や保存する際に特定の処理を適用できるユーザー定義の型です。これにより、データのフォーマットやアプリケーション内の型仕様に沿って、データの入出力が行えます。例えば、日時データをアプリケーション固有のフォーマットに変換したり、JSONデータをオブジェクトとして扱ったりすることが可能です。

カスタム型の使用例

カスタム型を使用すると、以下のようなデータを柔軟に操作できます。

  1. 日時のフォーマット変換
    日付をISO形式や特定の文字列フォーマットで扱う。
  2. JSONオブジェクトの保存と読み込み
    オブジェクトをJSON形式で保存し、取り出した際には自動的にオブジェクトに変換する。
  3. 暗号化データの保存
    特定のデータを暗号化してデータベースに保存し、取り出した際に復号化する。 このような処理をあらかじめ定義することで、データの入出力がシームレスかつ安全に行えるようになります。

Drizzle ORMでのカスタム型の定義方法

Drizzle ORMでカスタム型を作成するには、customType関数を使用します。この関数を使用すると、特定のデータ型の処理方法を定義でき、データの入出力時にカスタム処理を適用できます。

基本的なカスタム型の定義

以下の例では、文字列型のデータを大文字に変換して保存し、読み込む際に小文字に変換するカスタム型を作成します。

import { customType } from 'drizzle-orm';
// カスタム型を定義
const upperCaseStringType = customType({
    dataType() {
        return 'text';
    },
    toDatabase(value) {
        return value.toUpperCase();
    },
    fromDatabase(value) {
        return value.toLowerCase();
    }
});

コードの説明

  1. dataTypeメソッド
    カスタム型が使用するデータベースのデータ型を指定します。ここではtextを指定していますが、その他のデータ型も使用可能です。
  2. toDatabaseメソッド
    データベースに保存する際のデータ変換処理を指定します。この例では、入力された文字列をすべて大文字に変換して保存します。
  3. fromDatabaseメソッド
    データベースから読み込んだデータに対する変換処理を指定します。ここでは、データベースから取得した文字列を小文字に変換しています。 このように、データの保存形式と取得形式を分けることで、アプリケーションの要件に応じたデータ操作が可能になります。

カスタム型の使用例

日時データのカスタム型

例えば、日時データをISOフォーマットで保存し、読み込む際にはJavaScriptのDateオブジェクトとして扱いたい場合、次のようにカスタム型を定義できます。

const dateType = customType({
    dataType() {
        return 'timestamp';
    },
    toDatabase(value) {
        return value.toISOString();
    },
    fromDatabase(value) {
        return new Date(value);
    }
});

説明

  • 保存時にはtoISOString()を使ってISOフォーマットに変換します。
  • 取得時にはDateオブジェクトに変換することで、JavaScriptで日付操作が行いやすくなります。

JSONデータのカスタム型

次に、JSONデータをオブジェクトとして保存し、取り出す際には自動的にJavaScriptのオブジェクトに変換するカスタム型を作成します。

const jsonType = customType({
    dataType() {
        return 'json';
    },
    toDatabase(value) {
        return JSON.stringify(value);
    },
    fromDatabase(value) {
        return JSON.parse(value);
    }
});

このカスタム型を使用することで、複雑なデータ構造を持つオブジェクトをデータベースに保存し、再利用する際にデシリアライズされた形で取り出すことができます。

カスタム型を使用したデータベース操作

カスタム型を定義したら、Drizzle ORMでのデータベース操作に活用できます。以下は、上記のカスタム型を使用してデータを保存・取得する例です。

カスタム型を使ったデータの保存と取得

import { drizzle } from 'drizzle-orm';
import { dbConnection } from './dbConnection';
import { customType } from './schema';
const db = drizzle(dbConnection);
async function saveAndFetchData() {
    // データ保存
    await db.insert(usersTable).values({
        name: 'Alice',
        profile: jsonType.toDatabase({ age: 30, city: 'Tokyo' }), // JSON型を適用
        createdAt: dateType.toDatabase(new Date()) // 日付型を適用
    });
    // データ取得
    const user = await db.select()
        .from(usersTable)
        .where({ name: 'Alice' })
        .execute();
    console.log(user);
}

説明

  1. データの保存
    JSONデータを持つprofileフィールドにjsonTypeを適用し、toDatabaseメソッドを使ってデータベースに保存可能な形式に変換しています。また、createdAtフィールドにはdateTypeを使ってISOフォーマットで保存します。
  2. データの取得
    取得時には、カスタム型のfromDatabaseメソッドが適用され、保存されたデータが元のオブ ジェクトやDate型に戻されて使用可能になります。

カスタム型のメリット

カスタム型を使用することで、次のような利点があります。

  1. 柔軟なデータ操作
    特定のフォーマットや型に変換して保存・取得ができるため、データの整合性が確保されます。
  2. コードの見通しが良くなる
    複雑な変換処理を一か所に集約することで、コードの読みやすさが向上し、メンテナンスも容易になります。
  3. 再利用可能な型定義
    一度定義したカスタム型は、他の部分でも再利用できるため、冗長なコードを削減できます。

注意点

カスタム型を使用する際には、以下の点に注意が必要です。

  • 適切な型の選定
    dataTypeに指定するデータベース型は、保存するデータに適したものを選ぶことが重要です。間違った型を選択すると、データの欠損やエラーの原因になることがあります。
  • 変換処理のパフォーマンス
    複雑な変換処理が必要な場合、パフォーマンスへの影響が考えられるため、処理を最適化することも検討します。
  • データベース依存
    カスタム型の仕様はデータベースの特性に依存する場合があるため、移行時には適切なテストが必要です。

まとめ

Drizzle ORMのカスタム型機能は、データベースに保存されるデータの形式やアプリケーションの特定の要件に合わせたデータ型を柔軟に扱える強力なツールです。日時データのフォーマット変換やJSONデータの取り扱いなど、標準のデータ型では対応が難しいケースでも、カスタム型を利用することで一貫性と柔軟性が保たれたデータ操作が可能になります。

参照:

Custom Types | `Drizzle` ORM