✨

Prisma Split Schema File

2024/07/08に公開

Node.js

Split your Schema

Prisma v5.15.0 で Schema ファイルの分割ができるようになりました 🎉

機能が追加された理由
これまでは Prisma は、1 つのスキーマファイルしかサポートしていませんでした...
えっ！今までできなかったの？そうです！今までは、1 つのスキーマファイルに DB のモデルを集約していました。

今回
Prisma スキーマファイルを複数のファイルで使用できるようになり、データベーススキーマの管理性と構成性が向上し、大規模なプロジェクトでの作業が容易になりました。
全てのモデルは全てのファイルを参照することができるので、リレーションはファイルを跨ぐことができます。

使い方

prismaSchemaFolderPreview を有効化

schema.prisma

generator client {
  provider        = "prisma-client-js"
  previewFeatures = ["prismaSchemaFolder"] // <= previeFeaturesを追加
}

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

prisma ディレクトリ内に schema ディレクトリを追加

ディレクトリ構造(リバーシの場合)

├── prisma
    └── schema   // <= schemaディレクトリの作成
        ├── games.prisma
        ├── moves.prisma
        ├── schema.prisma
        ├── squares.prisma
        └── turns.prisma

schema ディレクトリに追加ファイルを作成する。

game.prisma

model games {
    id          Int            @id @default(autoincrement())
    started_at  DateTime
    turns       turns[]
    game_result game_results[]
}

model game_results {
    id          Int      @id @default(autoincrement())
    game_id     Int
    winner_disc Int
    end_at      DateTime
    games       games    @relation(fields: [game_id], references: [id])
}

turns.prisma

model turns {
    id         Int      @id @default(autoincrement())
    game_id    Int
    turn_count Int
    next_dixc  Int
    end_at     DateTime
    games      games    @relation(fields: [game_id], references: [id])
    moves      moves[]

    @@unique([game_id, turn_count])
}

複数ファイルのユースケース
プロジェクトが大きくなるにつれて、単一ファイルの Prisma スキーマでは最終的にサイズが大きくなり、効率的に管理ができなくなるという話を見聞きすることがあります。

この機能は、次のような場合に役に立ちます。

スキーマが複雑な場合
- スキーマに大きなモデルや複雑なリレーションがある場合、関連するモデルを別のファイルにすることで、スキーマの理解とナビゲートが容易になります。
大規模なチーム
- 1 つの Prisma スキーマファイルがあり、多くの開発者がコミットしている場合、日中にかなり厄介なマージ競合に遭遇する可能性があります。大きなスキーマを複数のファイルに分割することで、このような苦痛を減らすことができます。

複数ファイルの Prisma スキーマ Tips
この機能を最大化するためにいくつかのパターンがあります。

ドメインごとにファイルを整理
- 関連するモデルごとにファイルにまとめます。ユーザ関連のモデルは「user.prisma」,Post 関連のモデルは「post.prisma」に置く。
明確な命名規則を使用する
- スキーマファイル名は明確かつ簡潔でなければなりません。「myModels.prisma」や「CommentFeatureSchema.prisma」ではなく、「user.prisma」や「post.prisma」のような名前を使用してください。
ビルトインのスキーマファイル
- スキーマファイルはいくつあっても構いませんが、datasource と generator のブロックを定義する場所が必要です。「main.prisma」,「schema.prisma」,「base.prisma」はうまく機能するスキーマファイルです。

参考文献

GitHubで編集を提案

Split your Schema

Discussion