PrismaでCOMMENT ON句を生成するGeneratorを、npmパッケージとして公開しました。
作った経緯
PrismaのようなDBマイグレーションを行っていくようなツールを使っていると、マイグレーション後の実DBを正として、ER図を作りたかったりします。
ER図の作成には、SchemaSpyをずっと使っているのですが、
Prisma自体にはDBのコメントを生成する方法がなく、SchemaSpyでER図を出してもわかりずらいなーと思いました。
下記Issueのコメントにて、schema.prismaに書いたコメントを元に、COMMENT ON句を生成するコードがあって、最初はこれを試していたのですが、、
下記の点に対応したかったので、こちらのコードを元にして修正し、npmパッケージとして公開しました。
- テーブルに対応していない
- 毎回全コメントとなり、差分がわかりずらい
- コメントを消した場合に反映されない(消す考慮は無い)
- VIEWだと別途個別にマイグレーションSQLを書いてつくるので、除外できるように(正規表現で除外する名前を指定)
