/*
 * 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.skife.jdbi.v2.tweak;

import org.skife.jdbi.v2.Handle;

Interface used to receive sql logging events.
/**
 * Interface used to receive sql logging events.
 */
public interface SQLLog
{
    
Called when a transaction is started
/**
     * Called when a transaction is started
     */
    void logBeginTransaction(Handle h);

    
Called when a transaction is committed
/**
     * Called when a transaction is committed
     */
    void logCommitTransaction(long time, Handle h);

    
Called when a transaction is committed
/**
     * Called when a transaction is committed
     */
    void logRollbackTransaction(long time, Handle h);

    
Called when a handle is opened from a DBI instance
/**
     * Called when a handle is opened from a DBI instance
     */
    void logObtainHandle(long time, Handle h);

    
Called when a handle is closed
/**
     * Called when a handle is closed
     */
    void logReleaseHandle(Handle h);

    
Called to log typical sql statements
Params:
sql – the actual sql being exected/**
     * Called to log typical sql statements
     * @param sql the actual sql being exected
     */
    void logSQL(long time, String sql);

    
Called to log a prepared batch execution
Params:
sql – The sql for the prepared batch
count – the number of elements in the prepared batch/**
     * Called to log a prepared batch execution
     * @param sql The sql for the prepared batch
     * @param count the number of elements in the prepared batch
     */
    void logPreparedBatch(long time, String sql, int count);

    
Factory method used to obtain a SQLLog.BatchLogger which will be used to log
a specific batch statement.
Returns:
an instance of BatchLogger which will be used to log this batch/**
     * Factory method used to obtain a SQLLog.BatchLogger which will be used to log
     * a specific batch statement.
     *
     * @return an instance of BatchLogger which will be used to log this batch
     */
    BatchLogger logBatch();

    
Called when a transaction is checkpointed
Params:
name – the checkpoint name/**
     * Called when a transaction is checkpointed
     * @param name the checkpoint name
     */
    void logCheckpointTransaction(Handle h, String name);

    
Called when a transaction checkpoint is released
Params:
name – the checkpoint name/**
     * Called when a transaction checkpoint is released
     * @param name the checkpoint name
     */
    void logReleaseCheckpointTransaction(Handle h, String name);

    
Called when a transaction checkpoint is rolled back to
/**
     * Called when a transaction checkpoint is rolled back to
     */
    void logRollbackToCheckpoint(long time, Handle h, String checkpointName);

    
Instances of this are used to log batch statements. SQLLog#logBatch will return one of these.
A new one will be requested for each batch execution.
/**
     * Instances of this are used to log batch statements. SQLLog#logBatch will return one of these.
     * A new one will be requested for each batch execution.
     */
    public interface BatchLogger
    {
        
Called once for each statement in the batch
Params:
sql – sql for the statement/**
         * Called once for each statement in the batch
         * @param sql sql for the statement
         */
        void add(String sql);

        
Called when all statements have been passed to add()
/**
         * Called when all statements have been passed to add()
         */
        void log(long time);
    }
}