モデルを視覚化
PrismaからERDへの使い方
モデル、関連、マッピングされた名前を含む schema.prisma を可視化します。構文を理解し、診断内容を修正します。
Prismaスキーマの構造を確認する
schema.prisma をエディターに貼り付けて、モデル、スカラーフィールド、キー、列挙型(enum)、インデックス、リレーションを視覚化します。変換はブラウザ内で実行され、診断の注意が必要な場合でも読みやすいモデルを保持します。
このツールはスキーマを可視化します。データソースへの接続、Prisma Client の実行、マイグレーションの適用は行いません。
例では Prisma 6 の datasource 構文を使用しています。Prisma 7 では、provider を schema.prisma に保持し、接続 URL を prisma.config.ts で設定します。Erd Go は provider のみの datasource を受け入れます。設定ファイルや資格情報ではなく、スキーマをここに貼り付けてください。
接続されたスキーマを貼り付けます
- Prisma から ERD を開き、サンプルまたは空のドキュメントを選択します。
- 以下のスキーマ、または独自の完全な schema.prisma を貼り付けます。データソースプロバイダーがコネクタ固有の検証を制御します。
- 図と診断を確認してから、エクスプローラーでモデル、フィールド、リレーションを調べます。レイアウトコントロールを使用して図を配置します。
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
model User {
id Int @id @default(autoincrement())
email String @unique
posts Post[]
}
model Post {
id Int @id @default(autoincrement())
title String
authorId Int
author User @relation(fields: [authorId], references: [id])
@@index([authorId])
}モデル、フィールド、およびマッピングされた名前
| 構文 | 意味 |
|---|---|
| model User { ... } | スカラーフィールドとリレーションフィールドを持つモデル。 |
| String / Int / Boolean / DateTime / Decimal / Json / Bytes | スカラーフィールド型。コネクタサポートは引き続き適用されます。 |
| String? / Post[] | オプショナルフィールド / リストフィールド。 |
| @id / @@id([a, b]) | 単一フィールド / 複合主キー。 |
| @unique / @@unique([a, b]) | 単一フィールド / 複合ユニーク制約。 |
| @default(...) / @updatedAt / @db.VarChar(255) | デフォルト、更新メタデータ、およびプロバイダー固有のネイティブ型。 |
| @map("user_id") / @@map("users") | マッピングされた列 / データベーステーブル名。 |
| enum Status { ... } / @@index([field]) | 列挙値 / モデルインデックス。 |
| @@schema("public") | 互換性のあるマルチスキーマデータソースのスキーマメンバーシップ。 |
リレーションとキーのルール
明示的なリレーションでは、リレーションフィールド、スカラー外部キーフィールド、および @relation(fields: [...], references: [...]) を使用します。もう一方のモデルに反対側のリレーションフィールドを含めます。互換性のあるスカラー型およびネイティブ型を持つ主キーまたはグローバル一意識キーを参照します。
外部キースカラがオプショナルである場合、それを所有するリレーションフィールドもオプショナルでなければなりません。オプショナルリレーションには、必須のスカラを含めることができます。1対1の所有者は、外部キーフィールドに @unique または @@unique を必要とし、それらのスカラーを持たない逆のフィールドはオプショナルでなければなりません。
同じモデル間の複数のリンクまたは自己リレーションを区別するには、両側で引用符で囲まれた同じリレーション名を使用します。名前には句読点を含めることができます。フィールド名とキー参照は大文字と小文字が区別されます。各キーフィールドを 1 回指定し、複合キーのすべてのメンバーを含めます。
暗黙的なリレーショナルな多対多のエッジでは、参加する各モデルに1つのスカラーフィールドレベルの @id が必要です。複合、ブロックレベル、または一意のみの識別子は、誤解を招く仮想的なリレーションシップではなく、診断結果を生成します。追加のフィールド、複合キー、または参照アクションには、明示的な結合モデルを使用します。
model Profile {
id Int @id @default(autoincrement())
userId Int @unique
user User @relation(fields: [userId], references: [id])
}
model User {
id Int @id @default(autoincrement())
profile Profile?
}列挙型、複合キー、データベースマッピング
複数列キーには @@id および @@unique、フィールド名には @map、テーブル名には @@map を使用します。互換性のあるマルチスキーマプロバイダーの場合、データソースにスキーマをリストし、@@schema でモデルを割り当てます。モデル名はエディタ内で役立つまま維持され、マップされた識別情報はデータベース出力用に保持されます。
以下の PostgreSQL の例には、複合主キーとテナント スコープのユニークな電子メールがあります。このキーへの明示的なリレーションには、互換性のあるフィールド型を持つ tenantId と accountId を同じ順序で指定する必要があります。
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
schemas = ["identity"]
}
enum AccountState {
ACTIVE
DISABLED
@@schema("identity")
}
model Account {
tenantId Int @map("tenant_id")
accountId Int @map("account_id")
email String
state AccountState @default(ACTIVE)
@@id([tenantId, accountId])
@@unique([tenantId, email])
@@map("accounts")
@@schema("identity")
}プロバイダーとリカバリ可能な診断
サポートされているデータソースプロバイダーには、PostgreSQL、MySQL、SQLite、SQL Server、MongoDB、CockroachDBが含まれます。コンバーターは、コネクタ固有の識別子、ネイティブ型、デフォルト、リレーションルール、マッピングされた名前の衝突を確認します。
リレーショナルプロバイダのデフォルトは relationMode = "foreignKeys" です。MongoDB は relationMode = "prisma" を使用し、_id のマッピングと ObjectId の要件を検証します。リレーショナルの例をそのまま変更せずに MongoDB にコピーできるとは仮定しないでください。
診断機能を使用して、欠落している反対側のリレーションフィールド、互換性のない外部キーの型、無効なキーターゲット、およびサポートされていないプロバイダーの組み合わせを修正します。無効だが読み取り可能なフィールドはそのまま表示されるため、その場でスキーマを修復できます。
| プロバイダー | コネクタ固有のガイダンス |
|---|---|
| PostgreSQL / CockroachDB | スカラーリストおよびマルチスキーマ宣言がサポートされています。ネイティブ型とデフォルト値は、選択したプロバイダーと一致させる必要があります。 |
| MySQL | スカラーリストやデータソーススキーマオプションはありません。参照アクションの検証は、選択されたrelationModeに従います。 |
| SQLite | Prisma固有の@db型属性、スカラーリスト、またはデータソーススキーマオプションはありません。 |
| SQL Server | enumブロック、Jsonフィールド、またはスカラーリストはありません。マルチスキーマ宣言はサポートされています。 |
| MongoDB | relationMode = "prisma"、_id マッピング、および一致する ObjectId スカラー/ネイティブ型を使用します。複合型ブロックはこのコネクタに属します。 |
探索、エクスポート、保存
- モデル、フィールド、マップ名、列挙型、またはリレーションでエクスプローラーを検索します。リレーションを選択して、リレーションインスペクターでそのフィールド、参照、カーディナリティ、および参照アクションを確認します。そこからいずれかのエンドポイントに焦点を合わせます。
- 診断ロケーションを使用して、対応が必要なソースにジャンプします。ERD 上でレイアウトや表示設定を調整します。
- ドキュメントやプレゼンテーション用に、図を PNG、画像ベースの SVG、または PDF としてエクスポートします。
- Prisma ファイルをソースおよびレンダラーのコンテキストとともに保存するには、サインインしてください。読み取り専用の公開リンクを共有する前に、編集内容を保存してください。共有されたビューアにはソースの編集アクセス権が付与されません。
Prisma スキーマのトラブルシューティング
| 症状 | 確認すべき事項 |
|---|---|
| リレーションに警告があります | 一致する反対側のフィールドとリレーション名、互換性のあるスカラー/ネイティブ型、グローバルに一意な参照キー、および所有側のみにあるフィールド/参照を確認します。 |
| 一対一のリレーションに警告があります | 所有する外部キーグループをグローバルに一意にし、逆方向の関連をオプショナルにします。所有するスカラーがNULL許容である場合、その関連もオプショナルにします。 |
| 複合キーがグローバルに一意として表示されていません | フィールド名に欠落、重複、オプション、または大文字と小文字の違いがないか確認します。部分一意プレディケートは、グローバルな UQ ではなく PUQ として表示されます。 |
| 暗黙的な多対多のエッジが存在しません | 各モデルには、スカラーのフィールドレベルの @id が1つ必要です。複合識別子またはリレーション属性には、明示的な結合モデルを使用してください。 |
| 図がエラー付きでレンダリングされます | 読み取り可能なフィールドは意図的に保持されます。スキーマをデータベースプロバイダーに対して有効とみなす前に、診断を修復してください。 |
| 保存されたレイアウトに新しい編集が反映されていません | 共有またはリロードする前に、現在のソースおよびレンダラーのコンテキストを保存してください。公開ビューアには保存されたバージョンが表示されます。 |
| ソースの編集は無効です | ドキュメントの所有権、サインイン、およびクラウドの読み込みが完了したかどうかを確認します。リカバリ可能な読み込みエラーの場合は、[再試行] と [ファイルを開く] が提供されます。 |
適切なプロバイダーを指定して Prisma を生成する
このガイドを AI プロンプトとしてコピーし、Prisma のバージョンとプロバイダーを指定してから、モデルとビジネス ルールを記述します。スキーマを変更しながら、既存の @map および @@map 名を維持するようにアシスタントに依頼してください。
返された Prisma をエディターに貼り付け、他の場所で使用する前に診断を確認してください。レンダリングされたダイアグラムは、プロバイダーの検証やマイグレーションのレビューの代わりにはなりません。
Generate a PostgreSQL Prisma schema for User, Project, and Membership.
Use an explicit Membership join model with a composite key.
Include both sides of every relation and compatible foreign-key types.
Preserve these database table names: users, projects, memberships.