跳转到文档

你的模型,可视化

Prisma 转 ERD使用指南

以模型、关系和映射名称展示 schema.prisma,理解语法并处理诊断信息。

schema.prisma → ER 图打开 Prisma 转 ERD

查看 Prisma 模式的结构

将 schema.prisma 粘贴到编辑器中以可视化模型、标量字段、键、枚举、索引和关系。转换在浏览器中运行,当诊断需要关注时仍会保留可读的模型。

此工具可可视化您的模式。它不会连接到您的数据源、运行 Prisma Client 或应用迁移。

这些示例使用了 Prisma 6 的数据源语法。在 Prisma 7 中,请将 provider 保留在 schema.prisma 中,并在 prisma.config.ts 中配置连接 URL。Erd Go 可接受仅包含 provider 的数据源;请在此处粘贴 schema,而不是您的配置文件或凭据。

粘贴连接的架构

  1. 打开 Prisma 转 ERD 并选择示例或空白文档。
  2. 在下方粘贴架构,或粘贴你自己的完整 schema.prisma。数据源提供程序控制特定于连接器的验证。
  3. 查看图表和诊断信息,然后在资源管理器中检查模型、字段和关系。使用布局控件排列图表。
Prisma / 已连接的 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])
}
DATABASE_URL 是架构示例的一部分。可视化工具不使用它来建立数据库连接。

模型、字段与映射名称

模型、字段与映射名称
语法含义
模型 User { ... }具有标量和关系字段的模型。
字符串 / 整数 / 布尔值 / 日期时间 / 十进制 / JSON / 字节标量字段类型;连接器支持仍然适用。
字符串? / Post[]可选字段 / 列表字段。
@id / @@id([a, b])单字段/复合主键。
@unique / @@unique([a, b])单字段/复合唯一约束。
@default(...) / @updatedAt / @db.VarChar(255)默认值、更新元数据和提供程序特定的本地类型。
@map("user_id") / @@map("users")映射的列 / 数据库表名。
枚举 Status { ... } / @@index([field])枚举值/模型索引。
@@schema("public")兼容的多模式数据源的模式成员。
请勿混用来自不同连接器的原生类型和默认函数。仅模型的代码片段是宽松的;完整的 数据源 启用更严格的提供程序验证。

关系与键规则

显式关系使用关系字段、标量外键字段以及 @relation(fields: [...], references: [...])。在另一模型上包含一个反向关系字段。引用具有兼容标量和原生类型的主键或全局唯一键。

如果任何外键标量是可选的,则其所属的关系字段也必须是可选的。可选关系可以具有必需的标量。一对一所有者在其外键字段上需要 @unique 或 @@unique,并且没有这些标量的反向字段必须是可选的。

在两侧使用相同的带引号的关系名称来区分同一模型之间的多个链接或自关系。名称可能包含标点符号。字段名和键引用区分大小写;每列一个键字段,并包含每个复合键成员。

隐式关系多对多边缘要求每个参与模型上有一个标量字段级 @id。复合、块级或仅唯一标识符会产生诊断结果,而不是产生误导性的虚拟关系。对于附加字段、复合键或引用操作,请使用显式连接模型。

Prisma / 一对一关系
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?
}
部分唯一索引显示为 PUQ。它们的唯一性仅适用于匹配的行,因此它们无法建立全局身份或暗示“一对一”基数。

枚举、复合键与数据库映射

对于多列键,请使用 @@id 和 @@unique,对于字段名使用 @map,对于表名使用 @@map。对于兼容的多架构提供程序,请在数据源中列出架构并使用 @@schema 分配模型。模型名称在编辑器中依然有用,同时映射的标识会保留用于数据库输出。

下面的 PostgreSQL 示例具有复合主键和租户范围的唯一电子邮件。对此键的显式关系必须按相同顺序提供 tenantId 和 accountId,并具有兼容的字段类型。

Prisma / 映射的复合键架构
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无枚举块、Json 字段或标量列表。支持多架构声明。
MongoDB使用 relationMode = "prisma",_id 映射,以及匹配的 ObjectId 标量/原生类型。复合类型块属于此连接器。

探索、导出与保存

  1. 按模型、字段、映射名称、枚举或关系搜索资源管理器。选择一个关系以在关系检查器中查看其字段、引用、基数和引用操作;从那里聚焦任一端点。
  2. 使用诊断位置跳转到需要注意的源。调整 ERD 上的布局和显示首选项。
  3. 将图表导出为 PNG、图像支持的 SVG 或 PDF,用于文档或演示文稿。
  4. 登录以保存 Prisma 文件及其源和渲染器上下文。在共享只读公共链接之前保存编辑。共享的查看者不会收到源编辑访问权限。

对 Prisma 架构进行故障排除

对 Prisma 架构进行故障排除
症状检查什么
关系有警告检查匹配的相反字段和关系名、兼容的标量/原生类型、全局唯一的引用键,以及仅在所有端上的字段/引用。
一对一关系有警告使所属的外键组全局唯一,并将反向关系设为可选。如果所属标量可为空,则其关系也应设为可选。
复合键未显示为全局唯一检查缺失、重复、可选或大小写不同的字段名。部分唯一谓词显示为 PUQ,而不是全局 UQ。
缺少隐式多对多边每个模型都需要一个标量子字段级 @id。对于复合标识符或关系属性,请使用显式的连接模型。
图表渲染时出错可读字段被故意保留。在将模式视为对其数据库提供程序有效的之前,请修复诊断。
保存的布局未反映新编辑在共享或重新加载前保存当前源和渲染器上下文;公开查看者将看到保存的版本。
源编辑已禁用检查文档所有权、登录状态以及云端加载是否完成。可恢复的加载错误提供“重试”和“打开文件”。

使用正确的提供程序生成 Prisma

将本指南复制为 AI 提示词,说出您的 Prisma 版本和提供商,然后说明您的模型和业务规则。要求助手在更改架构的同时保留现有的 @map 和 @@map 名称。

将返回的 Prisma 粘贴到编辑器中,并在用于其他地方之前检查诊断信息。渲染出的图表不能替代提供商验证或迁移评审。

AI request / Prisma AI 请求
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.