Przejdź do dokumentacji

TWOJE MODELE, ZWIZUALIZOWANE

Prisma do ERD — poradnik

Wizualizuj schema.prisma z modelami, relacjami i mapowanymi nazwami. Poznaj składnię i poprawiaj zgłoszone problemy.

schema.prisma → Diagram EROtwórz Prisma do ERD

Zobacz strukturę swojego schematu Prisma

Wklej schema.prisma do edytora, aby zwizualizować modele, pola skalarne, klucze, enumy, indeksy i relacje. Konwersja odbywa się w przeglądarce i zachowuje czytelne modele, gdy diagnostyka wymaga uwagi.

To narzędzie wizualizuje Twój schemat. Nie łączy się z Twoim źródłem danych, nie uruchamia Prisma Client ani nie stosuje migracji.

Przykłady używają składni źródła danych Prisma 6. W Prisma 7 zachowaj dostawcę w schema.prisma i skonfiguruj adres URL połączenia w prisma.config.ts. Erd Go akceptuje źródło danych zawierające tylko dostawcę; wklej schemat tutaj, a nie plik konfiguracyjny lub dane uwierzytelniające.

Wklej połączony schemat

  1. Otwórz Prisma do ERD i wybierz przykład lub pusty dokument.
  2. Wklej schemat poniżej lub własny kompletny plik schema.prisma. Dostawca źródła danych kontroluje walidację specyficzną dla konektora.
  3. Przejrzyj diagram i diagnostykę, a następnie sprawdź modele, pola i relacje w eksploratorze. Użyj kontrolek układu, aby rozmieścić diagram.
Prisma / Połączony schemat 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 jest częścią przykładu schematu. Wizualizator nie używa go do nawiązywania połączenia z bazą danych.

Modele, pola i mapowane nazwy

Modele, pola i mapowane nazwy
SkładniaZnaczenie
model User { ... }Model z polami skalarnymi i relacyjnymi.
String / Int / Boolean / DateTime / Decimal / Json / BajtySkalarne typy pól; wsparcie konektorów nadal obowiązuje.
String? / Post[]Pole opcjonalne / pole listy.
@id / @@id([a, b])Jednopolowy / złożony klucz podstawowy.
@unique / @@unique([a, b])Jednopolowe / złożone ograniczenie unikalności.
@default(...) / @updatedAt / @db.VarChar(255)Wartości domyślne, aktualizacja metadanych i natywne typy specyficzne dla dostawcy.
@map("user_id") / @@map("users")Zmapowana kolumna / nazwa tabeli bazy danych.
enum Status { ... } / @@index([field])Wartości Enum / indeksy modeli.
@@schema("public")Przynależność do schematu dla zgodnego wieloschematowego źródła danych.
Nie mieszaj typów natywnych i domyślnych funkcji z różnych konektorów. Fragmenty kodu przeznaczone tylko dla modelu są liberalne; kompletne źródło danych umożliwia ścisłą walidację dostawcy.

Relacje i reguły kluczy

Jawna relacja wykorzystuje pole relacji, skalarne pola klucza obcego oraz @relation(fields: [...], references: [...]). Dołącz przeciwne pole relacji w drugim modelu. Odwołaj się do klucza głównego lub globalnie unikalnego klucza o zgodnych typach skalarnych i natywnych.

Jeśli jakikolwiek skalar klucza obcego jest opcjonalny, jego pole relacji posiadającej również musi być opcjonalne. Opcjonalna relacja może mieć wymagane skalary. Właściciel relacji jeden-do-jednego wymaga @unique lub @@unique na swoich polach klucza obcego, a pole odwrotne bez tych skalarów musi być opcjonalne.

Używaj tej samej nazwy relacji w cudzysłowie po obu stronach, aby odróżnić wiele powiązań między tymi samymi modelami lub relację zwrotną. Nazwy mogą zawierać znaki interpunkcyjne. Nazwy pól i odniesienia do kluczy uwzględniają wielkość liter; wymień każde pole klucza raz i uwzględnij każdy element klucza złożonego.

Niejawne relacyjne krawędzie wiele-do-wielu wymagają jednego skalarnego @id na poziomie pola w każdym uczestniczącym modelu. Identyfikatory złożone, na poziomie bloku lub tylko unikalne generują diagnostykę zamiast mylącej relacji wirtualnej. Użyj jawnego modelu łączącego dla dodatkowych pól, kluczy złożonych lub akcji referencyjnych.

Prisma / Relacja jeden do jednego
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?
}
Częściowe indeksy unikalne pojawiają się jako PUQ. Ich unikalność dotyczy tylko pasujących wierszy, więc nie mogą one ustanawiać globalnej tożsamości ani sugerować liczności jeden-do-jednego.

Typy Enum, klucze złożone i mapowania bazodanowe

Użyj @@id i @@unique dla kluczy wielokolumnowych, @map dla nazw pól i @@map dla nazw tabel. W przypadku kompatybilnego dostawcy obsługującego wiele schematów, wymień schematy w źródle danych i przypisz modele za pomocą @@schema. Nazwa modelu pozostaje użyteczna w edytorze, podczas gdy zmapowana tożsamość jest zachowywana dla wyjścia bazy danych.

Poniższy przykład PostgreSQL ma złożony klucz podstawowy i unikalny e-mail w zakresie najemcy. Jawna relacja do tego klucza musi dostarczać tenantId i accountId w tej samej kolejności z kompatybilnymi typami pól.

Prisma / Zmapowany schemat klucza złożonego
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")
}

Dostawcy i odzyskiwalna diagnostyka

Obsługiwani dostawcy źródeł danych to PostgreSQL, MySQL, SQLite, SQL Server, MongoDB i CockroachDB. Konwerter sprawdza tożsamości specyficzne dla konektora, typy natywne, wartości domyślne, reguły relacji i kolizje mapowanych nazw.

Dostawcy relacyjni domyślnie ustawiają relationMode = "foreignKeys". MongoDB używa relationMode = "prisma" i waliduje swoje mapowanie _id oraz wymagania ObjectId. Nie zakładaj, że przykład relacyjny może zostać skopiowany bez zmian do MongoDB.

Napraw brakujące pola relacji przeciwnej, niezgodne typy kluczy obcych, nieprawidłowe cele kluczy i nieobsługiwane kombinacje dostawców, korzystając z diagnostyki. Nieprawidłowe, ale czytelne pola pozostają widoczne, dzięki czemu można naprawić schemat na miejscu.

Dostawcy i odzyskiwalna diagnostyka
DostawcaWskazówki dotyczące konkretnych łączników
PostgreSQL / CockroachDBListy skalarne i deklaracje wielu schematów są obsługiwane; natywne typy i wartości domyślne muszą pasować do wybranego dostawcy.
MySQLBrak list skalarnych ani opcji schematów datasource. Walidacja akcji referencyjnych jest zgodna z wybranym trybem relationMode.
SQLiteBrak natywnych atrybutów typów Prisma @db, list skalarnych ani opcji schematów datasource.
SQL ServerBrak bloków enum, pól Json lub list skalarnych. Obsługiwane są deklaracje wieloschematowe.
MongoDBUżywaj relationMode = "prisma", mapowania _id oraz pasujących typów skalarnych/natywnych ObjectId. Bloki typów złożonych należą do tego łącznika.

Eksploruj, eksportuj i zapisz

  1. Przeszukuj eksplorator według modelu, pola, zamapowanej nazwy, typu wyliczeniowego (enum) lub relacji. Wybierz relację, aby przejrzeć jej pola, referencje, kardynalność i akcje referencyjne w Inspektorze relacji; stamtąd możesz przejść do dowolnego punktu końcowego.
  2. Używaj lokalizacji diagnostycznych, aby przejść do źródła wymagającego uwagi. Dostosuj układ i preferencje wyświetlania na ERD.
  3. Eksportuj diagram jako PNG, SVG z obrazem lub PDF do dokumentu lub prezentacji.
  4. Zaloguj się, aby zapisać plik Prisma wraz z jego źródłem i kontekstem renderowania. Zapisz zmiany przed udostępnieniem publicznego linku tylko do odczytu. Udostępniony widz nie otrzymuje dostępu do edycji źródła.

Rozwiązywanie problemów ze schematem Prisma

Rozwiązywanie problemów ze schematem Prisma
SymptomCo sprawdzić
Relacja ma ostrzeżenieSprawdź pasujące pole przeciwne i nazwę relacji, kompatybilne typy skalarne/natywne, globalnie unikalny klucz referencyjny oraz pola/referencje tylko po stronie właściciela.
Relacja jeden do jednego ma ostrzeżenieUstaw grupę kluczy obcych będącą właścicielem jako unikalną globalnie, a relację odwrotną jako opcjonalną. Jeśli skalarny właściciel dopuszcza wartości null, ustaw jego relację również jako opcjonalną.
Klucz złożony nie jest wyświetlany jako globalnie unikalnySprawdź pod kątem brakujących, powtarzających się, opcjonalnych lub różniących się wielkością liter nazw pól. Częściowy predykat unikalności jest wyświetlany jako PUQ zamiast globalnego UQ.
Brak niejawnej krawędzi wiele-do-wieluKażdy model wymaga jednego skalarnego pola @id na poziomie pola. Użyj jawnego modelu powiązania dla identyfikatorów złożonych lub atrybutów relacji.
Diagram renderuje się z błędami.Czytelne pola są celowo zachowane. Napraw diagnostykę przed uznaniem schematu za prawidłowy dla jego dostawcy bazy danych.
Zapisany układ nie odzwierciedla nowych edycjiZapisz bieżący kontekst źródła i renderera przed udostępnieniem lub przeładowaniem; publiczni widzowie widzą zapisaną wersję.
Edycja źródła jest wyłączonaSprawdź własność dokumentu, logowanie oraz czy ładowanie z chmury zostało zakończone. Naprawialne błędy ładowania udostępniają opcje Ponów próbę i Otwórz pliki.

Generuj Prisma z odpowiednim dostawcą

Skopiuj ten przewodnik jako prompt AI, podaj wersję i dostawcę Prisma, a następnie określ swoje modele i reguły biznesowe. Poproś asystenta o zachowanie istniejących nazw @map i @@map podczas zmiany schematu.

Wklej zwrócony kod Prisma do edytora i przejrzyj diagnostykę przed użyciem go w innym miejscu. Wyrenderowany diagram nie zastępuje walidacji dostawcy ani przeglądu migracji.

AI request / Żądanie 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.