2018年7月31日火曜日

DB定義書を簡単に作るツール A5:SQL Mk-2 | ライタス株式会社

DBの定義は、弊社ではイチから作成するケースはかなり稀なのですが、プロダクトの新規開発のご相談を受けたり、モックアップで簡易に作ったり、あるいは、すでにあるプロダクトのドキュメント化を行うなどの場合に、定義書を作成することがあります。

ここ最近は、原点回帰でExcelを指名いただくことが多かったのですが、思うところがあり、DB定義書を作成できるツールを探していたところ、「A5:SQL Mk-2」を発見しました。

https://a5m2.mmatsubara.com/

インストールの方法は、Qiitaに記載があったので、そちらをご参照いただき、ここでは、その使用感をレビューしたいと思います。

https://qiita.com/Esfahan/items/39509da435da4821cdc7

・ライセンスについて

A5:SQL Mk-2のライセンスは、フリーで無保証です。また、参照しているライブラリが明示されており、それぞれのライセンスの状況を確認できます。
とはいえ、開発に寄付を募っているということで、もし気に入っていただけたら、寄付のご協力をお願いします。

・使用感について

まず目を引いたのは、インストールレスであることでした。
初回起動では、レジストリに設定を残すのか、設定ファイルで設定を残すのかの選択が現れ、好感が持てます。
また、標準的なRDBMSに対応しているようで、DB定義書の出力以外にも、ER図へのリバースエンジニアリングなど多様な機能に対応していました。

・使用感(DB定義書)

MS Accessで簡単なDBを作ってDB定義書を出力させてみたところ、ちゃんと出力されてきたので、ざっくりDB定義のスケルトンを作るときには非常に便利かなと思います。
なお、MS Accessの場合は、出力させるときにファイルを閉じておいたほうが安定します。
MS Accessを使う場合は、ODBCドライバーを事前にインストールしておく必要があるので、そこだけ注意が必要かもしれません。
Access 2010以降のODBCドライバーは下記からダウンロードできます。
https://www.microsoft.com/ja-jp/download/details.aspx?id=13255

他のRDBMSは環境を用意する手間を惜しんでやっていませんが、PostgreSQLやMySQLぐらいなら、手が空いた時にやってみたいと思います。

・使用感(ER図)

ER図のリバースエンジニアリングを試してみました。
MS Accessでは、カラムはすべて拾えて来ましたが、リレーションは引っ張ってこれなかったですが、他のRDBMSであれば、引っ張ってこれるかもしれません。
ER図編集画面も、こなれた感じで使いやすそうです。

・使用感(SQL実行)

単なるドキュメント生成ツールかと思いきや、SQLの実行・実行履歴の保存・SQL整形など、細かい機能がそろっています。
結果の比較するツールや、結果のCSVやXMLへエクスポートの機能も備え、いうことなしのレベルでした。むしろSQLの実行環境を用意するために使ってもよいのではと思うほどの出来でした。


といったところで、簡単にレビューしてみました。
もう少し使い込んでみたいと思うので、新たな発見があったらお知らせしたいと思います。