メインコンテンツへスキップ

暗黙的な多対多リレーションから明示的な多対多リレーションへの変換

問題​

多対多リレーションシップはリレーショナルデータベースの重要な側面であり、あるテーブルの複数のレコードを別のテーブルの複数のレコードに関連付けることができます。Prismaは多対多リレーションシップをモデリングするために、暗黙的と明示的の2つのアプローチを提供します。

ユーザーは、モデル間の暗黙的な多対多リレーションシップから明示的なものに移行する必要がある状況に遭遇することがあります。暗黙的なリレーションを明示的に変換することで、リレーションをより細かく制御し、タイムスタンプやその他のフィールドなど、リレーションに固有の追加データを保存できます。このガイドでは、その変換を行うためのステップバイステップのウォークスルーを提供します。

解決策​

ここでは、Prismaで暗黙的な多対多リレーションを明示的なものに変換するプロセスを説明します。

postsとauthorフィールドを介した暗黙的な多対多リレーションシップを持つ以下のモデルを検討します。

model User {
  id        Int       @id @default(autoincrement())
  name      String
  posts     Post[]
}

model Post {
  id        Int       @id @default(autoincrement())
  title     String
  authors   User[]
}

上記のモデルでは、Userは複数の投稿を持つことができ、Postは複数の作成者を持つことができます。

暗黙的なリレーションを明示的なものに変換するには、リレーションテーブルを作成する必要があります。リレーションテーブルには、多対多リレーションに関与する両方のテーブルを参照する外部キーが含まれます。この例では、UserPostという新しいモデルを作成します。更新されたschema.prismaファイルは次のようになります。

model User {
  id        Int        @id @default(autoincrement())
  name      String
  posts     Post[]
  userPosts UserPost[]
}

model Post {
  id        Int        @id @default(autoincrement())
  title     String
  authors   User[]
  userPosts UserPost[]
}

model UserPost {
  id        Int       @id @default(autoincrement())
  userId    Int
  postId    Int
  user      User      @relation(fields: [userId], references: [id])
  post      Post      @relation(fields: [postId], references: [id])
  createdAt DateTime  @default(now())

  @@unique([userId, postId])
}

Prisma Migrateを使用している場合は、このコマンドを呼び出すことができます。

npx prisma migrate dev --name "added explicit relation"

マイグレーションによりUserPostテーブルが作成され、UserモデルとPostモデルがUserPostモデルと一対多のリレーションを作成します。

既存データを暗黙的リレーションテーブルから新しく作成されたリレーションテーブルへ移行する​

既存のデータを暗黙的リレーションテーブルから新しい明示的リレーションテーブルに移行するには、カスタムマイグレーションスクリプトを作成する必要があります。Prisma Clientを使用してデータベースと対話し、暗黙的リレーションテーブルからデータを読み取り、新しいリレーションテーブルに書き込むことができます。

上記のUserおよびPostモデルを考慮すると、データを移行するために使用できるスクリプトの例を以下に示します。

import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient();

// A `main` function so that you can use async/await
async function main() {
  try {
    // Fetch all users with their related posts
    const users = await prisma.user.findMany({
      include: { posts: true },
    });

    // Iterate over users and their posts, then insert records into the UserPost table
    for (const user of users) {
      for (const post of user.posts) {
        await prisma.userPost.create({
          data: {
            userId: user.id,
            postId: post.id,
          },
        });
      }
    }

    console.log("Data migration completed.");
  } catch (e) {
    console.error(e);
  }
}

main()
  .catch((e) => {
    throw e;
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

データがリレーションテーブルに移行されたら、以下に示すように暗黙のリレーション列（UserモデルのpostsおよびPostモデルのauthor）を削除できます。

model User {
  id        Int        @id @default(autoincrement())
  name      String
  posts     Post[]
  userPosts UserPost[]
}

model Post {
  id        Int        @id @default(autoincrement())
  title     String
  authors   User[]
  userPosts UserPost[]
}

スキーマファイルの変更後、このコマンドを呼び出すことができます。

npx prisma migrate dev --name "removed implicit relation"

上記のコマンドを実行すると、暗黙的なテーブル_PostToUserが削除されます。

これで、Prismaで暗黙的な多対多リレーションを明示的なものに正常に変換できました。

© . All rights reserved.