新しいプロジェクトは Docker + Rails + PostgreSQL で開発しており、
「rails er 図」で調べると大体 rails-ERD が候補で上がってきます。
プロジェクトには導入されていないので、個人的に毎回追加して bundle install するのも面倒だなーと思っていたら
Schemaspyを見つけました。
Schemaspy で生成されるサンプルドキュメントはこちらで確認できます。
Schemaspy コンテナから ER 図を生成
Schemaspy はDocker イメージが提供されているため、今回の方法を使えば既存のプロジェクトに影響を与えることなく ER 図を生成できます。
イメージはこんな感じです。
Schemaspy コンテナを起動して、プロジェクトの DB コンテナを読み取って ER 図を生成。
Schemaspy コンテナの/outputに出力されます。
Schemaspy コンテナの/outputはホストの/schemaにマウントさせるので、ホスト側のschema/index.htmlをブラウザで開いて ER 図を確認できるようになります。
特にプロジェクト側に何かを追加する必要はないので、プロジェクトに手を加えずに ER 図を出力することができます。
手順
docker pullで schemaspy のイメージを取得。
docker pull schemaspy/schemaspy:snapshot
docker-compose up等でプロジェクトの db コンテナを起動しておきます。
Schemaspy を使って ER 図を生成します。
今回対象の DB は postgreSQL になります。
docker run -v "$PWD/schema:/output" --net="host" -u root:root schemaspy/schemaspy:snapshot -t pgsql -host localhost:5432 -db app_development -u root -p app_dev_password -connprops useSSL\\\\=false -all
# 上記コマンドの説明
docker run -v "[ホスト側のディレクトリ]:/output" --net="host" -u root:root schemaspy/schemaspy:snapshot -t [データベースの種類] -host localhost:[DBの接続ポート] -db [DB名] -u [DBのユーザー名] -p [DBのパスワード] -connprops useSSL\\\\=false -all
ホスト側の$PWD/schemaに出力されるので、
ホスト側のschema/index.htmlをブラウザで開いて ER 図確認します。
出力する際に Graphviz がないために下記のエラーがでますが、Graphviz がなくてもとりあえず ER 図は確認できました。
ERROR - dot -Tpng:cairo clients.2degrees.dot -oclients.2degrees.png -Tcmapx: in label of node inspections
ERROR - dot -Tpng:cairo clients.2degrees.dot -oclients.2degrees.png -Tcmapx: Warning: cell size too small for content
参考
数ステップでテーブル定義書や ER 図を作成できる Schemaspy はすごく便利 | High5’s Menlo Park