Documentation Drizzle

概要

Drizzle ORMの「Drizzle Kit Check」機能は、コード上で定義されたデータベーススキーマと実際のデータベース構造に差異がある場合、その差分を検出するためのツールです。スキーマ変更の適用漏れや不一致を早期に確認できるため、データベースとコードの整合性を保ちながら開発を進めることができます。本記事では、Drizzle Kit Checkのセットアップ方法や実行手順、効果的な使い方について詳しく説明します。

Drizzle Kit Checkとは

Drizzle Kit Checkは、Drizzle ORMの提供するスキーマ検証ツールで、データベースに保存されているスキーマ構造と、コードベースで定義されたスキーマ構造を比較し、差分を出力します。例えば、コード上でカラムを追加したのにデータベースにその変更が反映されていない場合、Drizzle Kit Checkによってその差分を簡単に確認でき、マイグレーションの適用漏れなどを未然に防げます。

主な特徴

  1. スキーマの整合性チェック
    コードとデータベースが一致しているかどうかを即座に確認できます。

  2. 差分の明示的な検出
    テーブルやカラム、データ型の不一致などが差分として表示され、修正が必要な箇所が明確になります。

  3. マイグレーションの補助
    Drizzle Kit Checkを利用することで、マイグレーションが正しく適用されているかの確認が容易になり、開発者がスムーズにスキーマの同期を保つことができます。

Drizzle Kit Checkのセットアップ

Drizzle Kit Checkを利用するには、Drizzle KitおよびDrizzle ORMをインストールし、データベース接続情報を設定する必要があります。

前提条件

  • Node.jsおよびnpmがインストールされていること
  • Drizzle KitとDrizzle ORMがプロジェクトに追加されていること
  • データベースの接続情報を設定していること

インストール手順

まず、Drizzle ORMとDrizzle Kitをプロジェクトにインストールします。

npm install drizzle-orm drizzle-kit

データベース接続情報の設定

Drizzle Kit Checkを使用するためには、.envファイルにデータベース接続情報を記述します。

DATABASE_URL="your-database-url"

このURL情報に基づき、Drizzle Kit Checkはデータベースに接続してスキーマの状態を取得します。

Drizzle Kit Checkの実行方法

データベース接続情報の設定が完了したら、以下のコマンドを実行してDrizzle Kit Checkを起動し、スキーマの差分を確認します。

npx drizzle-kit check

このコマンドを実行することで、Drizzle Kitはデータベーススキーマとコード上のスキーマを比較し、差分を表示します。

実行結果の例

Drizzle Kit Checkが実行されると、コードとデータベース間の相違点が表示されます。例えば、コード上でテーブルに新しいカラムageを追加しているが、データベースにそのカラムが存在しない場合、以下のように出力されます。

Difference detected:
- Column 'age' is missing in database table 'users'

この出力により、どの部分に不一致があるのかが一目で分かるため、漏れなくマイグレーションが適用されているかを確認する手助けとなります。

使用例 - 差分検出と修正

例えば、usersテーブルにageカラムを追加する変更がコードに含まれているものの、データベースにはまだ適用されていないとします。この場合、Drizzle Kit Checkを実行すると差分が表示され、修正が必要な箇所が明示されます。

  1. コードでの変更
    usersテーブルに新しいカラムageを追加します。

    import { pgTable, serial, text, integer } from 'drizzle-orm/pg-core';
export const users = pgTable('users', {
    id: serial('id').primaryKey(),
    name: text('name').notNull(),
    email: text('email').unique().notNull(),
    age: integer('age'),  // 新しいカラムを追加
});

  2. Drizzle Kit Checkの実行
    上記のようにコードを変更した後、以下のコマンドを実行します。

    npx drizzle-kit check

  3. 差分確認
    差分としてageカラムがデータベースに存在しない旨が表示されます。この場合、マイグレーションを適用し、データベースを更新する必要があります。

  4. マイグレーションの実行
    drizzle-kit pushコマンドを使って変更をデータベースに反映させ、差分がなくなったことを確認します。

Drizzle Kit Checkの活用シーン

Drizzle Kit Checkは、特にチーム開発や頻繁なスキーマ変更があるプロジェクトで有効に活用できます。

  • チームメンバー間での同期確認
    チーム開発では、複数のメンバーが異なるスキーマ変更を行う可能性があり、スキーマの適用漏れや不一致が生じることがあります。Drizzle Kit Checkを使うことで、全員が最新のスキーマ構造で開発できるようになります。
  • 定期的なデータベースとコードの同期確認
    開発が進む中でスキーマ変更が頻繁に発生する場合、Drizzle Kit Checkによりコードとデータベースの整合性を定期的に確認できます。
  • スキーマ変更の管理
    長期的なプロジェクトでスキーマが頻繁に変更される場合、Drizzle Kit Checkを利用して差分をチェックし、マイグレーションの漏れがないよう管理することが重要です。

注意点

  • 頻繁なチェックの実施
    コードやデータベースの変更があった際には、Drizzle Kit Checkを定期的に実行してスキーマにズレがないか確認することが推奨されます。
  • データベース接続情報の管理
    .envファイルに記述した接続情報はセキュリティの観点から厳重に管理し、外部に漏れないように注意します。
  • マイグレーションの適用漏れ防止
    Drizzle Kit Checkはあくまで差分を検出するツールであり、データベース更新は手動で行う必要 があります。差分が確認された場合、適切なマイグレーション手順を取ってデータベースの更新を行いましょう。

まとめ

Drizzle Kit Checkは、データベースとコードのスキーマを簡単に比較し、差分を検出するための便利なツールです。プロジェクトの開発スピードが上がり、スキーマに関するバグが減少することで、データベース管理の効率が大幅に向上します。Drizzle Kit Checkを活用して、常にデータベースとコードの整合性を保ちながら、安定した開発を進めていきましょう。

参照:

`Drizzle` Kit Check - `Drizzle` ORM Documentation
円