prisma-markdown を使って ER図を自動生成する

はじめに

Prisma を使用してスキーマを管理している Project で ERD （ER図）およびスキーマ定義を簡単に生成できる prisma-markdown を紹介します。

prisma-markdown について

prisma-markdown は Prisma の　schema　ファイルから ERD （ER図）を生成するツールです。

使用方法は簡単で、 npm i -D prisma-markdown 実行後に schema ファイルに以下を記載するだけです。

generator markdown {
  provider = "prisma-markdown"
  output   = "./ERD.md"
  title    = "ER図"
}

その他

コメントタグについて

prisma-markdown にはコメントタグ機能が存在します。 コメントタグを使用する場合、注意する必要があるのは // ではなく /// と記載する点です。 // でコメントを記載しても、生成される Markdown には出力されません。

model Example {
  /// この行は出力される。
  // この行は出力されない。
  id
  title
}

ER図の分割

コメントタグの @namespace および @erd を使うことで ER図を分割して出力することができます。 @namespace と @erd の違いを簡単に記載すると、

• @namespace
  • ER図およびER図下にスキーマ定義を出力
• @erd
  • ER図のみに出力

@erd は有効な @namespace を持つ model 定義が存在しないと有効にならない点だけご注意ください。

Ref