Prisma は、Node.js および TypeScript アプリケーションでのデータベースとの対話を容易にする最新の ORM (オブジェクト リレーショナル マッピング) です。 Prisma の最も重要な機能の 1 つは移行システムです。これにより、データベース スキーマとアプリケーションのデータ モデルの同期を維持できます。この投稿では、移行を使用した Prisma ワークフローについて説明します。

移行とは何ですか?

移行は、体系的かつバージョン管理された方法でデータベース スキーマへの変更を制御および適用する方法です。これらを使用すると、テーブルの作成や変更など、データベースの構造変更を増分的かつ元に戻せる方法で定義できます。

移行を伴う Prisma ワークフロー

Prisma での移行の一般的なワークフローには次の手順が含まれます:

1. インストールと初期構成
2. スキーマ定義
3. 移行の作成
4. 移行アプリケーション
5. 移行管理

ステップ 1: インストールと初期構成

まず、プロジェクトに Prisma をインストールして初期化する必要があります:

npm install @prisma/client
npx prisma init

このコマンドは、データ モデルを定義する schema.prisma ファイルを含む prism ディレクトリを作成します。

ステップ 2: スキーマの定義

schema.prisma ファイルでは、データベース テーブルを表すモデルを定義します。たとえば、モデル User:
を定義してみましょう。

model User {
  id    Int     @id @default(autoincrement())
  email String  @unique
  name  String?
}

ここでは、id、電子メール、名前の列を持つ User テーブルを定義しています。

ステップ 3: 移行の作成

スキーマを定義または変更した後、これらの変更をデータベースに反映する移行を作成します。

npx prisma migrate dev --name init

merge dev コマンドは新しい移行を作成し、変更をデータベースに適用します。 --name パラメーターを使用すると、上記の例の init など、移行にわかりやすい名前を付けることができます。

ステップ 4: 移行アプリケーション

移行は、merge dev コマンドを使用するとデータベースに自動的に適用されます。これにより、データベースが schema.prisma.

実稼働環境で移行を適用する場合は、次のコマンドを使用します:

npx prisma migrate deploy

このコマンドは、保留中のすべての移行を運用データベースに適用します。

ステップ 5: 移行管理

Prisma は、データベースに適用されたすべての移行の履歴を保持します。これは、変更を追跡し、必要に応じて移行を元に戻すのに役立ちます。移行履歴を表示するには、
を使用できます。

npx prisma migrate status

このコマンドは、どの移行が適用され、どの移行が保留中であるかを含む、移行の現在のステータスを表示します。

実践例

User モデルに新しいフィールドを追加し、この変更に対する移行を作成する方法の実践的な例を見てみましょう。

1. フィールドを schema.prisma の User モデルに追加します:
   

   model User {
     id        Int     @id @default(autoincrement())
     email     String  @unique
     name      String?
     birthdate DateTime?
   }
   
   

2. 新しい移行を作成:
   

   npx prisma migrate dev --name add-birthdate-to-user
   
   

3. 移行を適用:

   merge dev コマンドはすでにデータベースに移行を適用しています。これで、データベースの User テーブルに新しい生年月日フィールドが追加されます。

4. 移行ステータスを確認する:
   

   npx prisma migrate status
   
   

   このコマンドは、add-birthdate-to-user の移行が正常に適用されたことを示します。

結論

移行を使用した Prisma のワークフローは、データベース スキーマへの変更を管理する効率的かつ安全な方法です。スキーマの定義、移行の作成、変更の適用、移行履歴の管理という明確な一連のステップを通じて、データベースとアプリケーションのデータ モデルの同期を維持することができ、ソフトウェアの開発とメンテナンスが容易になります。

Prisma を使用すると、データベース管理が簡素化されるだけでなく、すべての変更が追跡可能で元に戻せることを保証する強力なツールも得られ、より堅牢で機敏な開発プロセスに貢献します。