Prismaを使用したデータベース変更に伴う既存データの移行 ~スクリプト編~

はじめに

Prismaを使用したデータベースのスキーマ変更やデータの再構築を行う際に効果的なデータ移行の方法についてご紹介します。今回ではスクリプトを使用した方法に焦点を当てて説明します。

スクリプトファイルを使用したデータ移行

今回はUserテーブルの内容を新しくAccountテーブルに移行させ、関連付けするようにします。

schema.prisma

// 変更前 
model User {
  id       String     @id
  email    String     @unique
  name     String
}

schema.prisma

// 変更後 
model User {
  id          String   @id
  account     Account  @relation(fields: [accountId], references: [id], onDelete: Cascade)
  accountId   tring    @unique
}

// 新たに追加
model Account {
  id       String     @id
  email    String     @unique
  name     String
  user     User?
}

新しくマイグレイトしたファイル下にスクリプトファイルを作成し、PrismaClientを使用してデータ移行を行っていきます。

1. ライブラリのインポート

必要なライブラリをインポートします。次に、Prisma Clientのインスタンスを作成します。

script.ts

import { PrismaClient } from "@prisma/client";
const prisma = new PrismaClient();

このインスタンスを使用してデータベースにクエリを発行します。

2. メインの処理関数の定義

メインの処理を行う非同期関数を定義します。

script.ts

async function main() {
  // 処理内容
}

この関数内で、データベースからデータを取得し、処理を行います。

2.1. トランザクションの使用

メイン処理では、トランザクションを使用して複数の操作をまとめます。

script.ts

await prisma.$transaction(async (tx) => {
  // トランザクション内での処理
});

トランザクションを使用することで、複数のデータベース操作をまとめて、データの整合性を保ちます。

2.2. データの取得と操作

トランザクション内で、データベースから必要なデータを取得し、操作を行います。

script.ts

const users = await tx.user.findMany();
for (const user of users) {
  // データの操作
}

ここでは、既存のユーザー情報を全て取得し、それぞれのユーザーに対して操作を行います。

2.3. データの作成と更新

取得したデータを元に、新しいデータを作成したり、既存のデータを更新します。

script.ts

const accountId = ulid()
await tx.account.create({
  data: {
    id: accountId,
    email: user.email,
    name: user.name,
  },
});

await tx.user.update({
  where: {
    id: user.id,
  },
  data: {
    accountId: accountId,
  },
});

ここでは、新しいアカウントを作成し、ユーザー情報を更新して関連付けます。

3. スクリプトの実行と後処理

最後に、メイン処理を実行し、エラー処理とPrisma Clientの切断処理を行います。

script.ts

main()
  .catch(async (e) => {
    console.error(e);
    process.exit(1);
  })
  .finally(async () => await prisma.$disconnect());

メイン処理の実行後には、エラーが発生した場合の処理やPrisma Clientの切断を行います。

3.1. スクリプトの実行

package.jsonのscriptsに実行用のコマンドを追加します。

package.json

"scripts": {
  "data-migration:script": "tsx ./prisma/migrations/script.ts"
}

3.2 デプロイ時の実行

デプロイ時に上記のコマンドを実行することで、データ移行を完了させます。

スクリプトを使用したデータ移行のメリット

柔軟性

スクリプトを使用すると、必要に応じてデータの再定義や操作を行うことができます。例えば、新しいデータフィールドを追加したり、特定の条件を持つデータのみを移行することが可能です。

データ再定義

スクリプトを使用すると、データの再定義を行うことができます。例えば、既存のデータを新しい形式に変換したり、関連付けを調整したりすることができます。

スクリプトを使用したデータ移行のデメリット

デプロイとスクリプト実行の同時性

スクリプトはデプロイと同時に実行する必要があります。これにより、デプロイのタイミングやスクリプトの自動実行を制御する必要があります。

手動実行の可能性

自動実行されない場合は、デプロイ時にスクリプトを手動で実行する必要があります。これにより、手動作業やデプロイの段階分けが必要になる場合があります。

スクリプトの管理

スクリプトを適切に管理し、バージョン管理や適切な環境で実行する必要があります。また、スクリプトの複雑性が増すと管理が難しくなる可能性があります。

終わりに

データ移行は、データの消失や破損の危険性を伴う重要な作業です。そのため、慎重な実行方針を立てることが不可欠です。適切なバックアップ戦略やテスト環境での検証を行うことで、データ移行に伴うリスクを最小限に抑えることができます。また、スクリプトやクエリの検証、トランザクションの確保なども重要な要素です。データの安全性と正確性を確保しながら、効果的なデータ移行を行うためには、事前の計画と慎重な実行を心がけましょう！