Chuyển đến tài liệu

CÁC MÔ HÌNH CỦA BẠN, ĐƯỢC TRỰC QUAN HÓA

Hướng dẫn Prisma sang ERD

Trực quan hóa schema.prisma với mô hình, mối quan hệ và tên được ánh xạ. Hiểu cú pháp và xử lý chẩn đoán.

schema.prisma → Sơ đồ ERMở Prisma sang ERD

Xem cấu trúc lược đồ Prisma của bạn

Dán schema.prisma vào trình chỉnh sửa để trực quan hóa các mô hình, trường vô hướng, khóa, enum, chỉ mục và mối quan hệ. Quá trình chuyển đổi chạy trong trình duyệt và giữ lại các mô hình có thể đọc được khi cần chú ý đến chẩn đoán.

Công cụ này trực quan hóa lược đồ của bạn. Nó không kết nối với nguồn dữ liệu, chạy Prisma Client, hoặc áp dụng các thay đổi di trú.

Các ví dụ sử dụng cú pháp nguồn dữ liệu Prisma 6. Trong Prisma 7, hãy giữ nhà cung cấp trong schema.prisma và định cấu hình URL kết nối trong prisma.config.ts. Erd Go chấp nhận nguồn dữ liệu chỉ dành cho nhà cung cấp; hãy dán lược đồ vào đây, không phải tệp cấu hình hoặc thông tin xác thực của bạn.

Dán một lược đồ đã kết nối

  1. Mở Prisma sang ERD và chọn một mẫu hoặc một tài liệu trống.
  2. Dán lược đồ bên dưới, hoặc schema.prisma hoàn chỉnh của riêng bạn. Nhà cung cấp nguồn dữ liệu kiểm soát việc xác thực cụ thể cho trình kết nối.
  3. Xem lại sơ đồ và chẩn đoán, sau đó kiểm tra các mô hình, trường và quan hệ trong trình khám phá. Sử dụng các điều khiển bố cục để sắp xếp sơ đồ.
Prisma / Lược đồ Prisma đã kết nối
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 là một phần của ví dụ lược đồ. Trình trực quan hóa không sử dụng nó để thiết lập kết nối cơ sở dữ liệu.

Các mô hình, trường & tên được ánh xạ

Các mô hình, trường & tên được ánh xạ
Cú phápÝ nghĩa
model User { ... }Một mô hình với các trường vô hướng và quan hệ.
String / Int / Boolean / DateTime / Decimal / Json / BytesCác kiểu trường vô hướng; hỗ trợ trình kết nối vẫn được áp dụng.
String? / Post[]Trường tùy chọn / trường danh sách.
@id / @@id([a, b])Khóa chính một trường / tổng hợp.
@unique / @@unique([a, b])Ràng buộc duy nhất một trường / tổng hợp.
@default(...) / @updatedAt / @db.VarChar(255)Các mặc định, cập nhật siêu dữ liệu và các kiểu gốc dành riêng cho nhà cung cấp.
@map("user_id") / @@map("users")Tên cột / bảng cơ sở dữ liệu được ánh xạ.
enum Status { ... } / @@index([field])Các giá trị Enum / chỉ mục mô hình.
@@schema("public")Tư cách thành viên lược đồ cho một nguồn dữ liệu đa lược đồ tương thích.
Không trộn lẫn các kiểu gốc và hàm mặc định từ các trình kết nối khác nhau. Các đoạn mã chỉ dành cho mô hình thì linh hoạt; một nguồn dữ liệu hoàn chỉnh cho phép xác thực nhà cung cấp nghiêm ngặt hơn.

Quan hệ & các quy tắc khóa

Một mối quan hệ rõ ràng sử dụng trường quan hệ, các trường khóa ngoại vô hướng và @relation(fields: [...], references: [...]). Bao gồm một trường quan hệ đối diện trên mô hình kia. Tham chiếu đến một khóa chính hoặc khóa duy nhất toàn cầu với các kiểu vô hướng và kiểu gốc tương thích.

Nếu bất kỳ vô hướng khóa ngoại nào là tùy chọn, trường quan hệ sở hữu nó cũng phải là tùy chọn. Một quan hệ tùy chọn có thể có các vô hướng bắt buộc. Một chủ sở hữu một-một cần @unique hoặc @@unique trên các trường khóa ngoại của nó, và trường nghịch đảo không có các vô hướng đó phải là tùy chọn.

Sử dụng cùng một tên quan hệ trong dấu ngoặc kép ở cả hai phía để phân biệt nhiều liên kết giữa các cùng mô hình hoặc một quan hệ tự thân. Tên có thể chứa dấu câu. Tên trường và tham chiếu khóa phân biệt chữ hoa chữ thường; liệt kê mỗi trường khóa một lần và bao gồm mọi thành viên khóa phức hợp.

Các cạnh quan hệ nhiều-nhiều ngầm định yêu cầu một trường @id cấp vô hướng trên mỗi mô hình tham gia. Các định danh phức hợp, cấp khối hoặc chỉ-duy nhất tạo ra một chẩn đoán thay vì một mối quan hệ ảo gây hiểu lầm. Sử dụng mô hình liên kết rõ ràng cho các trường bổ sung, khóa phức tạp hoặc các hành động tham chiếu.

Prisma / Mối quan hệ một-một
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?
}
Các chỉ mục duy nhất một phần xuất hiện dưới dạng PUQ. Tính duy nhất của chúng chỉ áp dụng cho các hàng khớp, vì vậy chúng không thể thiết lập danh tính toàn cục hoặc ngụ ý bản số một-một.

Enums, khóa phức hợp & ánh xạ cơ sở dữ liệu

Sử dụng @@id và @@unique cho các khóa nhiều cột, @map cho tên trường và @@map cho tên bảng. Đối với nhà cung cấp đa lược đồ tương thích, hãy liệt kê các lược đồ trong nguồn dữ liệu và gán các mô hình bằng @@schema. Tên mô hình vẫn hữu ích trong trình chỉnh sửa trong khi danh tính được ánh xạ được bảo toàn cho đầu ra cơ sở dữ liệu.

Ví dụ về PostgreSQL dưới đây có khóa chính tổng hợp và email duy nhất theo phạm vi đối tượng thuê. Một mối quan hệ rõ ràng với khóa này phải cung cấp tenantId và accountId theo cùng thứ tự với các kiểu trường tương thích.

Prisma / Lược đồ khóa phức hợp được ánh xạ
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")
}

Nhà cung cấp & chẩn đoán có thể khôi phục

Các nhà cung cấp nguồn dữ liệu được hỗ trợ bao gồm PostgreSQL, MySQL, SQLite, SQL Server, MongoDB và CockroachDB. Bộ chuyển đổi kiểm tra các định danh cụ thể của trình kết nối, kiểu gốc, mặc định, quy tắc quan hệ và xung đột tên được ánh xạ.

Các nhà cung cấp quan hệ mặc định là relationMode = "foreignKeys". MongoDB sử dụng relationMode = "prisma" và xác thực ánh xạ _id cũng như các yêu cầu ObjectId của nó. Đừng cho rằng một ví dụ quan hệ có thể được sao chép nguyên trạng sang MongoDB.

Sửa các trường quan hệ đối diện bị thiếu, các loại khóa ngoại không tương thích, các mục tiêu khóa không hợp lệ và các kết hợp nhà cung cấp không được hỗ trợ bằng cách sử dụng chẩn đoán. Các trường không hợp lệ nhưng có thể đọc được vẫn hiển thị để bạn có thể sửa schema tại chỗ.

Nhà cung cấp & chẩn đoán có thể khôi phục
Nhà cung cấpHướng dẫn dành riêng cho trình kết nối
PostgreSQL / CockroachDBCác danh sách vô hướng và khai báo đa lược đồ được hỗ trợ; các kiểu gốc và mặc định phải khớp với nhà cung cấp đã chọn.
MySQLKhông có danh sách vô hướng hoặc tùy chọn lược đồ nguồn dữ liệu. Việc xác thực hành động tham chiếu tuân theo relationMode đã chọn.
SQLiteKhông có thuộc tính kiểu @db gốc của Prisma, danh sách vô hướng hoặc tùy chọn lược đồ nguồn dữ liệu.
SQL ServerKhông có khối enum, trường Json hoặc danh sách vô hướng. Các khai báo đa lược đồ được hỗ trợ.
MongoDBSử dụng relationMode = "prisma", ánh xạ _id và các kiểu vô hướng/nguyên bản ObjectId khớp nhau. Các khối kiểu phức hợp thuộc về trình kết nối này.

Khám phá, xuất & lưu

  1. Tìm kiếm trình khám phá theo mô hình, trường, tên được ánh xạ, enum hoặc quan hệ. Chọn một quan hệ để xem xét các trường, tham chiếu, bản số và các hành động tham chiếu của nó trong Trình kiểm tra quan hệ; tập trung vào một trong hai điểm cuối từ đó.
  2. Sử dụng các vị trí chẩn đoán để chuyển đến nguồn cần chú ý. Điều chỉnh bố cục và tùy chọn hiển thị trên ERD.
  3. Xuất sơ đồ dưới dạng PNG, SVG có hỗ trợ hình ảnh hoặc PDF cho tài liệu hoặc bài thuyết trình.
  4. Đăng nhập để lưu tệp Prisma cùng với ngữ cảnh nguồn và trình kết xuất của nó. Lưu các chỉnh sửa trước khi chia sẻ liên kết công khai chỉ đọc. Người xem được chia sẻ không nhận được quyền chỉnh sửa nguồn.

Khắc phục sự cố lược đồ Prisma

Khắc phục sự cố lược đồ Prisma
Triệu chứngNhững điều cần kiểm tra
Một quan hệ có cảnh báoKiểm tra trường đối diện khớp nhau và tên mối quan hệ, các kiểu dữ liệu vô hướng/nguyên bản tương thích, khóa được tham chiếu duy nhất toàn cục và các trường/tham chiếu chỉ nằm ở phía sở hữu.
Một quan hệ một-một có cảnh báoLàm cho nhóm khóa ngoại sở hữu là duy nhất trên toàn cục và mối quan hệ nghịch đảo là tùy chọn. Nếu một vô hướng sở hữu có thể nhận giá trị null, hãy làm cho mối quan hệ của nó cũng là tùy chọn.
Một khóa phức hợp không được hiển thị là duy nhất trên toàn cầuKiểm tra các tên trường bị thiếu, lặp lại, tùy chọn hoặc khác biệt về chữ hoa chữ thường. Một vị ngữ duy nhất một phần được hiển thị là PUQ thay vì UQ toàn cục.
Một cạnh nhiều-nhiều ngầm định bị thiếuMỗi mô hình cần một trường cấp độ vô hướng @id. Sử dụng mô hình liên kết rõ ràng cho các định danh phức hợp hoặc các thuộc tính quan hệ.
Sơ đồ hiển thị với các lỗiCác trường có thể đọc được giữ lại một cách có chủ ý. Sửa chữa các chẩn đoán trước khi coi lược đồ là hợp lệ cho nhà cung cấp cơ sở dữ liệu của nó.
Bố cục đã lưu không phản ánh các chỉnh sửa mớiLưu ngữ cảnh nguồn và trình kết xuất hiện tại trước khi chia sẻ hoặc tải lại; người xem công khai thấy phiên bản đã lưu.
Chỉnh sửa nguồn bị vô hiệu hóaKiểm tra quyền sở hữu tài liệu, đăng nhập và liệu quá trình tải trên đám mây đã hoàn tất chưa. Các lỗi tải có thể khôi phục sẽ cung cấp tùy chọn Thử lại (Retry) và Mở tệp (Open files).

Tạo Prisma với nhà cung cấp phù hợp

Sao chép hướng dẫn này dưới dạng lời nhắc AI, đặt tên phiên bản Prisma và nhà cung cấp của bạn, sau đó nêu các mô hình và quy tắc kinh doanh của bạn. Yêu cầu trợ lý giữ nguyên các tên @map và @@map hiện có trong khi thay đổi lược đồ.

Dán Prisma được trả về vào trình chỉnh sửa và xem xét chẩn đoán trước khi sử dụng ở nơi khác. Một sơ đồ được hiển thị không thay thế xác thực nhà cung cấp hoặc đánh giá di chuyển.

AI request / Yêu cầu AI 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.