EMSql
EMSqlとは？
DBFluteには外だしSQL(OutsideSql)という外部テキストファイルに記載されたSQL文をアプリケーションから実行する機能があります。
DBFluteの外だしSQLでは、ある規約に則ったSQLファイルに限ってそのSQLのパス定義をBehaviorクラスに自動生成し、プログラム上でタイプセーフにどのSQLを実行するのかを指定できるようにする BehaviorQueryPath と呼ばれる機能があります。
BehaviorQueryPath を利用するための手助けを行うのが EMSql です。
EMSqlの外だしSQLファイル作成機能を利用することにより、BehaviorQueryPathに沿ったファイルの作成が行われ、SQLの雛形が出力されます。
設定画面
プロジェクトのプロパティ画面を開き 「EMecha」-「EMSql」 を開くと、SQLファイルの出力先フォルダと利用するデータベースの種類(SQL型)を指定することが出来ます。
データベースの種類を設定しておくことにより、ページングを利用する外だしSQLのファイル作成時に出力される雛形がDBMSに合わせた内容になります。
ファイル出力先(sqlDirectory)のデフォルトはプロジェクトの src/main/resources になっています。
DBFluteの設定に合わせて変更してください。
操作方法
Package Explorer 上で対応する Behavior クラス(Exクラスのソースファイル)を選択して右クリックし 「EMecha」-「New Outside Sql」 を選択するか、
Behavior (Exクラス) を開き、Javaエディター内で右クリックして 「EMecha」-「New Outside Sql」 を選択すると新規外だしSQLファイルの作成画面が起動します。
作成するSQLの種類(SELECT,INSERT,UPDATE等)を選択し、SQL名(SQL Name)に(システムでユニークな) 業務名を入力します。
作成するSQLに合わせてオプションを設定し 完了(Finish) or Enter で新規ファイルが作成されエディタが開かれます。
ExBehavior だけでなく ApplicationBehaviorクラス を選択することも出来ます。
Package Explorer 以外にもナビゲーターやプロジェクトエクスプローラー、型階層、アウトラインなどからでも (Ex)Behavior クラスが選択されていれば同様な操作が行えます。
また、JavaソースだけでなくScalaソースでも同様な操作で外だしSQLファイルを作成することが可能です。