org.dbflute.hook.SqlLogHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dbflute-runtime Show documentation

The runtime library of DBFlute

There is a newer version: 1.2.8

/*
 * Copyright 2014-2023 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */
package org.dbflute.hook;

/**
 * The handler of SQL log. 

 * This handler is called back before executing the SQL.
 *  * context.setSqlLogHandler(new SqlLogHandler() {
 *     public void handle(SqlLogInfo info) {
 *         // You can get your SQL string here.
 *     }
 * });
 * 
 * @author jflute
 */
public interface SqlLogHandler {

    /**
     * Handle the SQL log. 

     * This is called back per SQL logging.
     * But if the SQL would be not executed, this is not called back,
     * for example, update() that the entity has no modification.
     * And if the command is for batch, this is called back per batch elements in a command.
     * @param info The information of SQL log. (NotNull)
     */
    void handle(SqlLogInfo info);

    /**
     * Does it inherit the existing handler?
     * @return The determination, true or false.
     */
    default boolean inheritsExistingHandler() {
        return true; // inherits as default since 1.1.1
    }
}