JDBCタスク

JDBCタスクとは?

スキーマのメタデータを取得するDBFluteタスクです。

DBFluteの自動生成機能(GenerateタスクやDocタスク、Sql2Entityタスク)を利用する前に、必ずこのタスクが実行されている必要があります。

主な実行タイミング

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

実行コマンド

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

環境構築

DBFluteのセットアップが終わった時点から利用できます。 但し、スキーマが存在していないと無意味ですので、実行前にReplaceSchemaタスクなどでスキーマが作成されていることが前提です。

処理概要

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

1. スキーマのメタデータ取得

databaseInfoMap.dfprop に定義されているスキーマに接続して、メタデータを取得します。

2. メタデータのXMLファイルを出力

取得したメタデータをDBFluteクライアント配下の schema/project-schema-[client-project].xml ファイルに出力します。このXMLファイルを SchemaXML と言います。通常、このファイルを直接編集したり、閲覧したりする必要はなく、他のDBFluteタスクが内部的に参照します。

補足

接続したスキーマにテーブルが一件もない場合は、エラーになって処理が中断します。実行前にReplaceSchemaタスクなどでスキーマを作成して下さい。

様々なオプション

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

JDBCタスクのログ

JDBCタスクの処理自体をトレースするログが出力されます。