tbls で DB ドキュメントを自動出力

ツール導入前の課題

システムの特性上 DB の変更が多いことおよび変更のたびにクライアントツールから出力する必要があることから、ドキュメント管理の手間を減らしたいというニーズがありました。
また、DB の構成はマイグレーションファイルによって管理していたため、マイグレーションファイルとドキュメントの距離を近づけたいという課題もありました。

どのような状態を目指していたか

• DB の変更に合わせて自動でドキュメントを生成できること
• 普段の業務と距離を近づけるために Git で管理できること

• SchemaSpy

• CI との連携のしやすさ
• ドキュメント出力方法がシンプルであるか
• 設定変更のしやすさ

上記の軸で比較したところ、どちらもドキュメントの出力方法はシンプルでしたが、最終的には以下の三点で tbls の方が要件に適していると判断し、導入を決めました。

• Docker イメージが公開されていて環境非依存で動くこと
• シングルバイナリであること
• 設定ファイルが YAML 形式であること

tbls の導入によりドキュメント管理の手間が減ったことで開発業務に集中できるようになりました。
また、ドキュメントを Git 管理できるようになったことで、コードを書きながら DB 全体を確認したいときや特定のテーブルについての情報を得たいときも即座に確認できるようになりました。

tbls はドキュメント生成だけでなく lint も実行できる大変優れたツールです！
ローカルでの実行であれば手軽且つ一切の費用無しで実行できるので、ぜひ一度試してみてはいかがでしょうか。

現在は ER 図が DB 全体に対するものしかないので、Viewpoints を利用したテーブルのグループ化をし、より理解しやすい ER 図とドキュメントの生成を行おうと考えています