DBFlute-IntroでDB変更履歴を管理する

目次

  • HistoryHTMLとは
  • 実際にHistoryHTMLを生成する
  • コメントを書こう
  • まとめ

HistoryHTMLとは

スキーマの変更履歴を人が見やすい形にまとめたドキュメントです。
DBFluteが自動生成のためにメタデータを取得するたびに、一つ前のメタデータと内容の比較をしてスキーマ構造に違いがあった部分だけをドキュメントにまとめます。

HistoryHTML | DBFlute

実際にHistoryHTMLを生成する

アプリケーションで、DBFluteを使っている場合は自動で生成されます。 もし使っていない場合は、DBFluteIntroの「Generate Documents」ボタンをクリックしましょう。

f:id:decoch:20190817120259p:plain

するとHistoryHTMLが更新されます

f:id:decoch:20190817120426p:plain
更新前

f:id:decoch:20190817120447p:plain
更新後

このように以前のDB変更からどのような変更がはいったのか確認をすることができます。

コメントを書こう

DBFlute-intro特有の機能として、diffNo のところをクリックするとHistoryHTMLにコメントを追記することができます。 この機能を使うことで、リリース単位でどんなDB変更をしたのか、意図はなんだったのかドキュメントにまとめることができます

f:id:decoch:20190817120516p:plain
クリック時

f:id:decoch:20190817120544p:plain
入力後

dbflute.seasar.org

まとめ

  • DBFluteはHistoryHTMLという機能でDBの履歴を管理できる
  • あとでコメントを追加し、どういった意図でDB変更したのかドキュメントにまとめられる