ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Javadoc、PHPDocなど、プログラミングソースからドキュメントを生成するソリューションは幾つか存在する。きちんとコメントを書けば、それがドキュメントになってくれるので、手間が減りつつもプログラムの品質は向上すると一石二鳥だ。


ピクチャ 1.png

出力中

 

そして同様の手法をMySQLにも適用しようと言うのがこのソフトウェアだ。

今回紹介するオープンソース・ソフトウェアはmysqldoc、MySQLの構造ドキュメント出力ソフトウェアだ。

mysqldocはターミナル上で利用するソフトウェアで、指定したデータベース(または全て)のテーブルの構造を一覧にしてくれる。カラム名、テーブルタイプ、型、デフォルト値、詳細な説明を一覧にする。


ピクチャ 2.png

HTMLでの出力例

 

テーブルのステータス等も出力される。結果はテキスト(デフォルト)、HTMLまたはXMLで出力が可能だ。SSLを使った接続への対応や、トリガーやユーザファンクションの表示設定等、細かなオプションが多数存在する。

項目はまだそれほど多くはないが、多人数での開発や定期的なメンテナンスで構造の詳細が分からなくなってしまうことはあるだろう。そうした時に一覧で出してくれると便利そうだ。


ピクチャ 3.png

テキストでの出力例

 

 

mysqldoc - Google Code

 http://code.google.com/p/mysqldoc/

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2