【備忘録】Liam ERDを使ってローカル環境でER図を生成してみた

Liam ERDとは

ER図自動生成ツール。tblsで出力したJSONやPrismaスキーマなどをINPUTにし、ビジュアライズなER図を作成する。

Liam ERD 公式

公式ブログ（Liam ERDの紹介、今後の展望など）

対応形式

tbls連携関連リリース

開発ロードマップ

参考個人ブログ

ローカル環境でのER図作成・公開手順

tblsとPrisma連携の場合の2種の手順を記す。

前提：検証環境・使用ツール

• M1 Mac(Sonoma 14.7.2)
• Microsoft SQL Server 2022(CU13、Ubuntu 22.04 Debian パッケージ)
• tbls(v1.56.1)
• Prisma(v5.19.0)
• Liam ERD CLI(v0.0.18)

tbls連携の場合

※前提1：tblsのインストールが完了していること（brewを使うなど）
※前提2：tbls.ymlが作成済みで、dnsに接続先DBテーブルURLが定義されていること

1. tbls out -t json -o schema.jsonでschema.jsonファイルを生成する
2. npx @liam-hq/cli erd build --format tbls --input schema.jsonでschema.jsonを元にERダイアグラムを作成する
   ※特に指定がない場合は distディレクトリ内に生成ファイルが追加される。出力先を指定したい場合は--output-dir <出力先ファイルの相対パス>オプションを追加する。

コマンド実行時にエラーが発生する可能性あり。私が遭遇したケースの原因と対応方は以下。
・生成されたschema.jsonのreferenced_tableがnullになっている -> 空文字に変更する
・生成されたschema.jsonのreferenced_columnsがnullになっている -> 空配列に変更する

3. npx http-server <2の出力先の相対パス>でhttp-serverに公開する

Prisma連携の場合

※前提：Prismaスキーマファイルが存在していること

1. npx @liam-hq/cli erd build --format prisma --input <Prismaスキーマファイル相対パス>でschema.prismaを元にERダイアグラムを作成する
2. npx http-server <1の出力先の相対パス>でhttp-serverに公開する