org.seasar.doma
注釈型 Script

@Target(value=METHOD)
@Retention(value=RUNTIME)
public @interface Script

SQLスクリプトの実行を示します。

このアノテーションが注釈されるメソッドは、Daoインタフェースのメンバでなければいけません。

注釈されるメソッドは次の制約を満たす必要があります。

• パラメータは受け取らない。
• 戻り値の型は void である。

例:

 @Dao(config = AppConfig.class)
 public interface EmployeeDao {
 
     @Script
     void createTables();
 }
 

注釈されるメソッドは、次の例外をスローすることがあります。

• ScriptFileNotFoundException スクリプトファイルが見つからなかった場合
• ScriptException スクリプトファイルの実行中に例外が発生した場合
• JdbcException 上記以外でJDBCに関する例外が発生した場合

導入されたバージョン:

1.7.0

作成者:

taedium

任意要素の概要

String	blockDelimiter SQLのブロックの区切り文字です。
boolean	haltOnError スクリプトの実行中にエラーが発生した場合、即座に処理を終了するかどうかを示します。

blockDelimiter

public abstract String blockDelimiter

SQLのブロックの区切り文字です。

SQLのブロックとはステートメントの集合です。一般的に、プロシージャーやトリガーの定義の終了を示すために使用されます。

空文字が指定されている場合、 Dialect.getScriptBlockDelimiter() の値が使用されます。

デフォルト:

""

haltOnError

public abstract boolean haltOnError

スクリプトの実行中にエラーが発生した場合、即座に処理を終了するかどうかを示します。

デフォルト:

true