Examples of org.jooq.ExecuteListener

org.jooq.ExecuteListener

An event listener for {@link Query}, {@link Routine}, or {@link ResultSet}render, prepare, bind, execute, fetch steps.

ExecuteListener is a base type for loggers, debuggers, profilers, data collectors that can be hooked into a jOOQ {@link Factory}using the {@link Settings#getExecuteListeners()} property, passingSettings to {@link Factory#Factory(java.sql.Connection,SQLDialect,Settings)}. Advanced ExecuteListeners can also provide custom implementations of {@link Connection}, {@link PreparedStatement} and {@link ResultSet} to jOOQin apropriate methods. For convenience, consider extending {@link DefaultExecuteListener} instead of implementing this interface. Thiswill prevent compilation errors in future versions of jOOQ, when this interface might get new methods.

The following table explains how every type of statement / operation invokes callback methods in the correct order for all registered ExecuteListeners. Find a legend below the table for the various use cases.

Callback method	Use case [1]	Use case [2]	Use case [3]	Use case [4]	Use case [5]	Use case [6]
{@link #start(ExecuteContext)}	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x
{@link #renderStart(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, Nx (for every query)	Yes, 1x
{@link #renderEnd(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, Nx (for every query)	Yes, 1x
{@link #prepareStart(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, Nx (for every query)	Yes, 1x
{@link #prepareEnd(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, Nx (for every query)	Yes, 1x
{@link #bindStart(ExecuteContext)}	Yes, 1x	No	No	Yes, Nx (for every value set)	No	Yes, 1x
{@link #bindEnd(ExecuteContext)}	Yes, 1x	No	No	Yes, Nx (for every value set)	No	Yes, 1
{@link #executeStart(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, 1x	Yes, 1x
{@link #executeEnd(ExecuteContext)}	Yes, 1x	Yes, 1x	No	Yes, 1x	Yes, 1x	Yes, 1x
{@link #fetchStart(ExecuteContext)}	Yes, 1x (Nx for {@link ResultQuery#fetchMany()}	Yes, 1x (Nx for {@link ResultQuery#fetchMany()}	Yes, 1x	No	No	No
{@link #resultStart(ExecuteContext)}	Yes, 1x (Nx for {@link Cursor#fetch(int)}	Yes, 1x (Nx for {@link Cursor#fetch(int)}	Yes, 1x	No	No	No
{@link #recordStart(ExecuteContext)}	Yes, Nx	Yes, Nx	Yes, Nx	No	No	No
{@link #recordEnd(ExecuteContext)}	Yes, Nx	Yes, Nx	Yes, Nx	No	No	No
{@link #resultEnd(ExecuteContext)}	Yes, 1x (Nx for {@link Cursor#fetch(int)}	Yes, 1x (Nx for {@link Cursor#fetch(int)}	Yes, 1x	No	No	No
{@link #fetchEnd(ExecuteContext)}	Yes, 1x (Nx for {@link ResultQuery#fetchMany()}	Yes, 1x (Nx for {@link ResultQuery#fetchMany()}	Yes, 1x	No	No	No
{@link #end(ExecuteContext)}	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x	Yes, 1x

Legend:

Used with {@link ResultQuery} of statement type{@link StatementType#PREPARED_STATEMENT}
Used with {@link ResultQuery} of statement type{@link StatementType#STATIC_STATEMENT}
Used with {@link Factory#fetch(ResultSet)} or with{@link InsertResultStep#fetch()}
Used with {@link Factory#batch(Query)}
Used with {@link Factory#batch(Query[])}
Used with a {@link Routine} standalone call

If nothing is specified, the default is to use {@link LoggerListener} and{@link StopWatchListener} as the only event listeners. @author Lukas Eder


    @Test
    public void run() {
        Tools.title("Displaying execution time using a custom ExecuteListener");


        ExecuteListener listener = new DefaultExecuteListener() {


            @Override
            public void start(ExecuteContext ctx) {


                // Register the start time to the current context

View Full Code Here

        return 0;
    }


    private final int executeCallableStatement() {
        ExecuteContext ctx = new DefaultExecuteContext(configuration, this);
        ExecuteListener listener = new ExecuteListeners(ctx);


        try {
            Connection connection = ctx.connection();


            listener.renderStart(ctx);
            // [#1520] TODO: Should the number of bind values be checked, here?
            ctx.sql(create(configuration).render(this));
            listener.renderEnd(ctx);


            listener.prepareStart(ctx);
            ctx.statement(connection.prepareCall(ctx.sql()));
            // [#1856] TODO: Add Statement flags like timeout here
            listener.prepareEnd(ctx);


            listener.bindStart(ctx);
            using(configuration).bindContext(ctx.statement()).visit(this);
            registerOutParameters(configuration, (CallableStatement) ctx.statement());
            listener.bindEnd(ctx);


            execute0(ctx, listener);


            /* [pro] xx
            xx xxxxxxx xxx xxxxx xx xxxxxxxxx xxxxxx xxxx xxx xxxx xxxxxxxxx
            xx xxx xxxxxxxxxx xx xxxxxxxx xx xxx xxxxxx
            xx [/pro] */
            Utils.consumeResultSets(ctx, listener, results, null);
            fetchOutParameters(ctx);
            return 0;
        }


        // [#3427] ControlFlowSignals must not be passed on to ExecuteListners
        catch (ControlFlowSignal e) {
            throw e;
        }
        catch (RuntimeException e) {
            ctx.exception(e);
            listener.exception(ctx);
            throw ctx.exception();
        }
        catch (SQLException e) {
            ctx.sqlException(e);
            listener.exception(ctx);
            throw ctx.exception();
        }
        finally {
            Utils.safeClose(listener, ctx);
        }

View Full Code Here

    }


    @Override
    public Cursor<Record> fetchLazy(ResultSet rs, Field<?>... fields) {
        ExecuteContext ctx = new DefaultExecuteContext(configuration());
        ExecuteListener listener = new ExecuteListeners(ctx);


        ctx.resultSet(rs);
        return new CursorImpl<Record>(ctx, listener, fields, null, false, true);
    }

View Full Code Here

0 1

TOP

Related Classes of org.jooq.ExecuteListener

org.jooq.academy.section4.Example_4_4_ExecuteListener

org.jooq.impl.AbstractQuery

org.jooq.impl.AbstractRoutine

org.jooq.impl.AbstractStoreQuery

org.jooq.impl.BatchMultiple

org.jooq.impl.BatchSingle

org.jooq.impl.DefaultDSLContext

org.jooq.impl.Factory

org.jooq.impl.InsertQueryImpl

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.