![](\"https://github.com/notiz-dev/prisma-dbml-generator/actions/workflows/node.js.yml/badge.svg\"alt=\"Build){kind=icon}
\n \n \n ![\"Total](\"https://img.shields.io/npm/dt/prisma-dbml-generator.svg\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/v/prisma-dbml-generator.svg\")
\n \n \n ![\"License\"](\"https://img.shields.io/npm/l/prisma-dbml-generator.svg\")
\n \n\nAutomatically generate a DBML schema from your Prisma Schema.\n
\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n
\nAutomatically generate a DBML schema from your Prisma Schema.\n
\n\n\n\nUpdates every time `npx prisma generate` runs. Use [dbdiagram.io](https://dbdiagram.io/home) to visualize your `dbml` files as Entity-Relationship Diagram:\n\n\n\n## Getting started\n\n| Prisma | prisma-dbml-generator |\n| -------- | -------------------------------------------------------------------------------- |\n| >=2.29.0 | [0.7.0](https://github.com/notiz-dev/prisma-dbml-generator/releases/tag/v0.7.0) |\n| <2.29.0 | [0.6.0](https://github.com/notiz-dev/prisma-dbml-generator/releases/tag/v0.6.0) |\n\n1. Install this generator:\n\n```bash\nnpm install -D prisma-dbml-generator\n```\n\n2. Add the generator to the `schema.prisma`\n\n```prisma\ngenerator dbml {\n provider = \"prisma-dbml-generator\"\n}\n```\n\n3. Running `npx prisma generate` for the following [schema.prisma](https://github.com/notiz-dev/prisma-dbml-generator/blob/main/prisma/schema.prisma)\n\n```prisma\nmodel User {\n id Int @id @default(autoincrement())\n createdAt DateTime @default(now())\n updatedAt DateTime @updatedAt\n email String @unique\n name String?\n posts Post[]\n profile Profile?\n /// user role\n role Role @default(USER)\n}\n\n/// User profile\nmodel Profile {\n id Int @default(autoincrement()) @id\n bio String?\n user User @relation(fields: [userId], references: [id])\n userId Int @unique\n}\n\nmodel Post {\n id Int @id @default(autoincrement())\n title String @default(\"\")\n content String?\n published Boolean @default(false)\n author User? @relation(fields: [authorId], references: [id])\n authorId Int?\n categories Category[]\n}\n\nmodel Category {\n id Int @id @default(autoincrement())\n name String\n posts Post[]\n}\n\n/// user role\nenum Role {\n ADMIN /// allowed to do everything\n USER\n}\n```\n\ngenerates the following [schema.dbml](https://github.com/notiz-dev/prisma-dbml-generator/blob/main/prisma/dbml/schema.dbml) to `prisma/dbml`\n\n```dbml\n//// ------------------------------------------------------\n//// THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)\n//// ------------------------------------------------------\n\nTable User {\n id Int [pk, increment]\n createdAt DateTime [default: `now()`, not null]\n updatedAt DateTime [not null]\n email String [unique, not null]\n name String\n posts Post\n profile Profile\n role Role [not null, default: 'USER', note: 'user role']\n}\n\nTable Profile {\n id Int [pk, increment]\n bio String\n user User [not null]\n userId Int [unique, not null]\n\n Note: 'User profile'\n}\n\nTable Post {\n id Int [pk, increment]\n title String [not null, default: '']\n content String\n published Boolean [not null, default: false]\n author User\n authorId Int\n categories Category\n}\n\nTable Category {\n id Int [pk, increment]\n name String [not null]\n posts Post\n}\n\nTable CategoryToPost {\n categoriesId Int [ref: > Category.id]\n postsId Int [ref: > Post.id]\n}\n\nEnum Role {\n ADMIN\n USER\n}\n\nRef: Profile.userId - User.id\n\nRef: Post.authorId > User.id\n```\n\n4. [Visualize](https://dbdiagram.io/d) the `schema.dbml`\n\n## Additional Options\n\n| Option | Description | Type | Default |\n| ----------------------- | ----------------------------------------------- | --------- | ------------- |\n| `projectDatabaseType` | Project database type for dbdocs | `string` | `null` |\n| `projectName` | Project name for dbdocs | `string` | `null` |\n| `projectNote` | Project note for dbdocs | `string` | `null` |\n| `projectNotePath` | Project note path to a markdown file for dbdocs | `string` | `null` |\n| `output` | Output directory for the DBML file | `string` | `./dbml` |\n| `outputName` | Name for the DBML file | `string` | `schema.dbml` |\n| `manyToMany` | Create Many-To-Many join table | `boolean` | `true` |\n| `mapToDbSchema` | Use mapped table name | `boolean` | `true` |\n| `includeRelationFields` | Include relation fields | `boolean` | `true` |\n\nUse additional options in the `schema.prisma`\n\n```prisma\ngenerator dbml {\n provider = \"prisma-dbml-generator\"\n output = \"../dbml\"\n outputName = \"awesome.dbml\"\n projectName = \"Project Name\"\n projectDatabaseType = \"PostgreSQL\"\n projectNote = \"Test project description\"\n}\n```\n\n## Development\n\n```bash\nnpm run dev\n\nnpm test\n```\n\n## Helpful\n\n[Prisma Generator](https://github.com/prisma/specs/tree/master/generators)\n","readmeFilename":"README.md","homepage":"https://github.com/notiz-dev/prisma-dbml-generator#readme","repository":{"type":"git","url":"git+https://github.com/notiz-dev/prisma-dbml-generator.git"},"bugs":{"url":"https://github.com/notiz-dev/prisma-dbml-generator/issues"}}