作成のきっかけ
お仕事でEC-CUBE4系を利用することになり、ドキュメントを作成する必要が出てきたのですが、EC-CUBEの開発ドキュメントをみても3系のものしか見当たらなかったので、自分で作成する必要が出てきました。
条件
下記の条件を満たすものを探していました。
- 既存のDBから生成できる
- Mysqlに対応している
- png, jpgなど画像形式で出力できる
検討した自動作成ツール
社内で同じような経験をした人がいないかと思い、slackで問いかけみると「SchemaSpyを使う」「PhpStormのdiagram機能を利用する」「SequelProでER図を出力する」「MySQL Workbenchのreverse engineeringという機能を利用する」というありがたき知恵をたくさんいただきました。
実際に使ったもの
PhpStormを利用していることと、手っ取り早くできそうだったので「PhpStormのdiagram機能を利用する」を採用することにしました。
ER図を作成する
私が利用しているPhpStormのバージョンは「PhpStorm 2018.3.4」になります
PhpStormからDBを接続する
PhpStormでプロジェクトを作成、もしくはプロジェクトを開いている状態で行います。
- タブの「View > Tool Windows > Database」でツールウィンドウを開いて、DBアイコンを選択します。
- ＋アイコンから「MYSQL」を選択し、ER図を生成したいDB情報を入力します。
- 接続できたらDatabaseのツールウィンドウから追加したDBを選択し、右クリックをし「Diagram > Show Visual」を選択します。
- すると、自動生成してくれて簡単にER図が完成します！（早っ...）
しかもレイアウトまで変更でき（ER図の空いているところ右クリックして「Layout」を選択）、テーブルを選択すると自分でごにょごにょ動かすこともできちゃいます！
（縮小しすぎるとわからないので、拡大した一部を切り取っています...）
例えばこんなのとか
こんなのとか
こんなのとか
色を変えたい...というかたはPhpStormのColorSchemeを変更すると白にもできちゃいます。
（上記のテーマはSolarized Dark, こちらはSolarized Light）
画像として出力したい時は下記のアイコンからの「Export to file」でpng形式で出力可能です。JetBrainsさますばらし！
さいごに
少しでもみなさまのドキュメント作成のお役に立てればと思います。
足をお運びいただきありがとうございました。
※おまけ
テーブル定義書作成についてはこちらを利用させていただきました。
GASを使って、スプレッドシートにMySQLのテーブル定義書を作成する