org.dbflute.hook

インタフェース SqlStringFilter

既知の実装クラスのリスト:

CallbackContext.InheritableSqlStringFilter, QueryTraceableSqlStringFilter, SimpleTraceableSqlStringFilter

public interface SqlStringFilter

The filter of SQL string.
This filter is called back before executing the SQL.

 context.setSqlStringFilter(new SqlStringFilter() {
     public String filterSelectCB(BehaviorCommandMeta meta, String executedSql) {
         // You can filter your SQL string here.
     }
     ...
 });
 

This filter does not have all SQL call-back point. For example, you cannot filter SQL of sequence next value.

作成者:

jflute

メソッドのサマリー

修飾子とタイプ	メソッドと説明
default String	filterEntityUpdate(BehaviorCommandMeta meta, String executedSql) Filter the executed SQL of entity update, insert and delete.
default String	filterOutsideSql(BehaviorCommandMeta meta, String executedSql) Filter the executed SQL of outside-SQL.
default String	filterProcedure(BehaviorCommandMeta meta, String executedSql) Filter the executed SQL of procedure call.
default String	filterQueryUpdate(BehaviorCommandMeta meta, String executedSql) Filter the executed SQL of query update, insert and delete (by condition-bean).
default String	filterSelectCB(BehaviorCommandMeta meta, String executedSql) Filter the executed SQL of select by condition-bean.
default boolean	inheritsExistingFilter() Does it inherit the existing filter?

メソッドの詳細

filterSelectCB

default String filterSelectCB(BehaviorCommandMeta meta,
                              String executedSql)

Filter the executed SQL of select by condition-bean.

パラメータ:

meta - The meta information of the behavior command. (NotNull)

executedSql - The string of actually-executed SQL. (NotNull)

戻り値:

The filtered SQL string. (NullAllowed: if null, means no filter)

filterEntityUpdate

default String filterEntityUpdate(BehaviorCommandMeta meta,
                                  String executedSql)

Filter the executed SQL of entity update, insert and delete. (contains batch)

パラメータ:

meta - The meta information of the behavior command. (NotNull)

executedSql - The string of actually-executed SQL. (NotNull)

戻り値:

The filtered SQL string. (NullAllowed: if null, means no filter)

filterQueryUpdate

default String filterQueryUpdate(BehaviorCommandMeta meta,
                                 String executedSql)

Filter the executed SQL of query update, insert and delete (by condition-bean).

パラメータ:

meta - The meta information of the behavior command. (NotNull)

executedSql - The string of actually-executed SQL. (NotNull)

戻り値:

The filtered SQL string. (NullAllowed: if null, means no filter)

filterOutsideSql

default String filterOutsideSql(BehaviorCommandMeta meta,
                                String executedSql)

Filter the executed SQL of outside-SQL.
Called after filtering by outside-SQL filter.

パラメータ:

meta - The meta information of the behavior command. (NotNull)

executedSql - The string of actually-executed SQL. (NotNull)

戻り値:

The filtered SQL string. (NullAllowed: if null, means no filter)

filterProcedure

default String filterProcedure(BehaviorCommandMeta meta,
                               String executedSql)

Filter the executed SQL of procedure call.

パラメータ:

meta - The meta information of the behavior command. (NotNull)

executedSql - The string of actually-executed SQL. (NotNull)

戻り値:

The filtered SQL string. (NullAllowed: if null, means no filter)

inheritsExistingFilter

default boolean inheritsExistingFilter()

Does it inherit the existing filter?

戻り値:

The determination, true or false.