Document Prisma ERD generation
This commit is contained in:
parent
b5e967d8d3
commit
4ec0683f88
9 changed files with 3997 additions and 25 deletions
|
|
@ -39,3 +39,35 @@ export default defineConfig({
|
|||
migrations: { path: 'prisma/migrations' },
|
||||
})
|
||||
```
|
||||
|
||||
## Prisma generators
|
||||
|
||||
`prisma/schema.prisma` bevat twee generators:
|
||||
|
||||
```prisma
|
||||
generator client {
|
||||
provider = "prisma-client-js"
|
||||
}
|
||||
|
||||
generator erd {
|
||||
provider = "prisma-erd-generator"
|
||||
output = "../docs/erd.svg"
|
||||
}
|
||||
```
|
||||
|
||||
`prisma generate` bouwt dus twee artifacts:
|
||||
|
||||
- Prisma Client in `node_modules/@prisma/client`
|
||||
- het ERD-diagram in `docs/erd.svg`
|
||||
|
||||
## Commands
|
||||
|
||||
| Command | Gebruik |
|
||||
|---|---|
|
||||
| `npx prisma db push` | Schema synchroniseren naar de database |
|
||||
| `npx prisma db seed` | Seeddata laden |
|
||||
| `npm run db:erd` | `prisma generate`: Prisma Client en `docs/erd.svg` genereren |
|
||||
| `npm run db:erd:watch` | `prisma/schema.prisma` watchen en ERD opnieuw genereren |
|
||||
| `npm run dev` | Next.js dev server plus ERD watcher starten |
|
||||
|
||||
Belangrijk: `db push` schrijft naar de database, maar genereert geen ERD. Gebruik na schemawijzigingen `npm run db:erd` of laat `npm run dev` de watcher draaien.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue