データベース(MySQL)とドキュメントについて考えてみた

最近の、データベース(MySQL)とドキュメントの管理についてです。

■DDLとER図の作成

MySQL Workbenchを使っています。

http://dev.mysql.com/downloads/workbench/

ER図はpngで出力しています。

■ドキュメントの作成
fuel-dbdocsを使っています。(自作です。。。)
https://github.com/mp-php/fuel-dbdocs
http://madroom-project.blogspot.jp/2013/02/fuelphpmysqlpostgresqlsqlite.html
Jenkinsのビルド時に自動実行しています。自動実行するのは大げさな感じがしますが、見たい時に決まった場所に最新のドキュメントがある。のって大事かなと思います。JenkinsサーバのMySQLも適宜更新しないといけませんが、ユニットテストも実行していれば、そっちの関係で更新されているはずですし。
カラムにはコメントをつけるようにしていこうと思います。

■カラムの追加等
MySQL Workbenchファイルを更新します。
DDLとER図(png)も更新します。
稼働しているサーバで実行するALTER TABLE文は、MySQL Workbenchから出力できます。

MySQL Workbenchでalter tableを自動生成する
http://madroom-project.blogspot.jp/2013/01/mysql-workbenchalter-table.html



これで、MySQL Workbenchファイルで一元管理できるかなと。
Excelドキュメント(嫌いですが)が必要な場合は、後からEclipseのER Masterで生成できます。
http://ermaster.sourceforge.net/
Excelドキュメント(嫌いですが)のフォーマットもカスタマイズ可能です。

この方法で、ずっとネックだった、実際の状態とドキュメントの内容が「ズレる」ことを回避できそうです。