Docタスク

Docタスクとは?

様々なドキュメント(主に SchemaHTML)を自動生成するDBFluteタスクです。

主な実行タイミング

  • 実装開始直前 (開発用DBスキーマの作成後)
  • DB変更の発生
  • DBFluteアップグレード直後
  • 本番運用後のDB変更

実行コマンド

DBFluteクライアント配下の doc.(bat|sh) をコマンドから実行します。

環境構築

DBFluteのセットアップが終わった時点から利用できます。 但し、スキーマのメタデータがないと無意味ですので、実行前にJDBCタスクが必ず(一度は)実行されていることが前提です。

処理概要

Docタスクを実行すると処理が始まります。

1. SchemaXMLを参照

JDBCタスクで出力された SchemaXML (スキーマのメタ情報)を読み込みます。

2. SchemaHTMLを自動生成

取得したメタデータを人が見やすい形にして、[DBFluteクライアント]/output/doc/schema-[client-project].html に出力します。このHTMLファイルを SchemaHTML と言います。このファイルはDocタスク実行のたびに上書きされます。

3. HistoryHTMLを自動生成

スキーマの変更履歴を人が見やすい形にして、[DBFluteクライアント]/output/doc/history-[client-project].html に出力します。このHTMLファイルを HistoryHTML と言います。このファイルはDocタスク実行のたびに上書きされます。@since 0.9.7.1

4. PropertiesHTMLを自動生成

".properties" ファイルを環境ごと言語ごとに見やすい形にして、[DBFluteクライアント]/output/doc/properties-[client-project].html に出力します。このHTMLファイルを PropertiesHTML と言います。このファイルはDocタスク実行のたびに上書きされます。@since 1.0.1

5. Eclipseプロジェクトをリフレッシュ(オプション)

refreshDefinitionMap.dfprop にてリフレッシュ設定がされている場合に、 指定されているEclipseプロジェクトをリフレッシュ(更新)します(@since 0.9.8.4)。 これにより、ファイルシステム上は生成されていてもEclipse上には反映されていないという状態が発生しません。

LoadDataReverse

Docタスクのオプションとして、DB上の(一部の)データをエクセル形式で出力する機能があります(@since 0.9.8.4)。 ReplaceSchema のデータ登録で利用するエクセルデータの土台としても利用できます。

SchemaSyncCheck

Docタスクのオプションとして、二つのスキーマの構造が同期されているかどうかをチェックする機能があります(@since 0.9.8.4)

様々なオプション

DBFluteプロパティを利用することで、様々なオプションが利用可能です。