Class CallbackExecuteListener

java.lang.Object

org.jooq.impl.CallbackExecuteListener

All Implemented Interfaces:

Serializable, EventListener, ExecuteListener

public final class CallbackExecuteListener
extends Object
implements ExecuteListener

An ExecuteListener that allows for functional composition.

For example:

ExecuteListener listener = ExecuteListener
  .onExecuteStart(ctx -> something())
  .onExecuteEnd(ctx -> something());

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
CallbackExecuteListener()

Method Summary

Modifier and Type	Method	Description
final void	bindEnd(ExecuteContext ctx)	Called after bind variables to the PreparedStatement.
final void	bindStart(ExecuteContext ctx)	Called before bind variables to the PreparedStatement.
final void	end(ExecuteContext ctx)	Called at the end of the execution lifecycle.
final void	exception(ExecuteContext ctx)	Called in the event of an exception at any moment of the execution lifecycle.
final void	executeEnd(ExecuteContext ctx)	Called after executing a statement.
final void	executeStart(ExecuteContext ctx)	Called before executing a statement.
final void	fetchEnd(ExecuteContext ctx)	Called after fetching data from a ResultSet.
final void	fetchStart(ExecuteContext ctx)	Called before fetching data from a ResultSet into a Result type.
final CallbackExecuteListener	onBindEnd(ExecuteEventHandler newOnBindEnd)
final CallbackExecuteListener	onBindStart(ExecuteEventHandler newOnBindStart)
final CallbackExecuteListener	onEnd(ExecuteEventHandler newOnEnd)
final CallbackExecuteListener	onException(ExecuteEventHandler newOnException)
final CallbackExecuteListener	onExecuteEnd(ExecuteEventHandler newOnExecuteEnd)
final CallbackExecuteListener	onExecuteStart(ExecuteEventHandler newOnExecuteStart)
final CallbackExecuteListener	onFetchEnd(ExecuteEventHandler newOnFetchEnd)
final CallbackExecuteListener	onFetchStart(ExecuteEventHandler newOnFetchStart)
final CallbackExecuteListener	onOutEnd(ExecuteEventHandler newOnOutEnd)
final CallbackExecuteListener	onOutStart(ExecuteEventHandler newOnOutStart)
final CallbackExecuteListener	onPrepareEnd(ExecuteEventHandler newOnPrepareEnd)
final CallbackExecuteListener	onPrepareStart(ExecuteEventHandler newOnPrepareStart)
final CallbackExecuteListener	onRecordEnd(ExecuteEventHandler newOnRecordEnd)
final CallbackExecuteListener	onRecordStart(ExecuteEventHandler newOnRecordStart)
final CallbackExecuteListener	onRenderEnd(ExecuteEventHandler newOnRenderEnd)
final CallbackExecuteListener	onRenderStart(ExecuteEventHandler newOnRenderStart)
final CallbackExecuteListener	onResultEnd(ExecuteEventHandler newOnResultEnd)
final CallbackExecuteListener	onResultStart(ExecuteEventHandler newOnResultStart)
final CallbackExecuteListener	onStart(ExecuteEventHandler newOnStart)
final CallbackExecuteListener	onTransformEnd(ExecuteEventHandler newOnTransformEnd)
final CallbackExecuteListener	onTransformStart(ExecuteEventHandler newOnTransformStart)
final CallbackExecuteListener	onWarning(ExecuteEventHandler newOnWarning)
final void	outEnd(ExecuteContext ctx)	Called after fetching out parameter values from a CallableStatement.
final void	outStart(ExecuteContext ctx)	Called before fetching out parameter values from a CallableStatement.
final void	prepareEnd(ExecuteContext ctx)	Called after preparing / creating the SQL statement.
final void	prepareStart(ExecuteContext ctx)	Called before preparing / creating the SQL statement.
final void	recordEnd(ExecuteContext ctx)	Called after fetching a record from a ResultSet.
final void	recordStart(ExecuteContext ctx)	Called before fetching a record from a ResultSet.
final void	renderEnd(ExecuteContext ctx)	Called after rendering SQL from a QueryPart.
final void	renderStart(ExecuteContext ctx)	Called before rendering SQL from a QueryPart.
final void	resultEnd(ExecuteContext ctx)	Called after fetching a set of records from a ResultSet.
final void	resultStart(ExecuteContext ctx)	Called before fetching a set of records from a ResultSet.
final void	start(ExecuteContext ctx)	Called to initialise an ExecuteListener.
final void	transformEnd(ExecuteContext ctx)	Called before transforming a Query.
final void	transformStart(ExecuteContext ctx)	Called before transforming a Query.
final void	warning(ExecuteContext ctx)	Called in the event of a warning at any moment of the execution lifecycle.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CallbackExecuteListener

public CallbackExecuteListener()

Method Details

start

public final void start(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called to initialise an ExecuteListener.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise

Overridable attributes in ExecuteContext:

• ExecuteContext.connectionProvider(ConnectionProvider): The connection provider used for execution. This may be particularly interesting if a Query was de-serialised and is thus lacking the underlying connection

Specified by:

start in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

transformStart

public final void transformStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before transforming a Query.

Users may use this method to replace the ExecuteContext.query(Query) before Settings.isTransformPatterns() pattern transformations are applied, and before any SQL is rendered.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise

Overridable attributes in ExecuteContext:

• ExecuteContext.query(Query): The query that will be rendered and executed. So far, this cannot be used with ExecuteContext.routine() yet.

Specified by:

transformStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

transformEnd

public final void transformEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before transforming a Query.

Users may use this method to replace the ExecuteContext.query(Query) after Settings.isTransformPatterns() pattern transformations are applied, but before any SQL is rendered.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise

Overridable attributes in ExecuteContext:

• ExecuteContext.query(Query): The query that will be rendered and executed. So far, this cannot be used with ExecuteContext.routine() yet.

Specified by:

transformEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

renderStart

public final void renderStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before rendering SQL from a QueryPart.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise

Specified by:

renderStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

renderEnd

public final void renderEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after rendering SQL from a QueryPart.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.

Overridable attributes in ExecuteContext:

• ExecuteContext.sql(String): The rendered SQL statement that is about to be executed. You can modify this statement freely.
• ExecuteContext.params(Param[]): Bind values that are to be bound to the PreparedStatement.

Specified by:

renderEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

prepareStart

public final void prepareStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before preparing / creating the SQL statement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.

Overridable attributes in ExecuteContext:

• ExecuteContext.sql(String): The rendered SQL statement that is about to be executed. You can modify this statement freely.
• ExecuteContext.params(Param[]): Bind values that are to be bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement about to be executed. At this stage, no such statement is available yet, but if provided, the execution lifecycle will skip preparing a statement. This can be used e.g. to implement a transaction-bound prepared statement cache.

  A custom PreparedStatement needs to take into account Settings.getStatementType(), and a default void bind variable markers for StatementType.STATIC_STATEMENT.

  Flags such as Query.queryTimeout(int), Query.poolable(boolean), ResultQuery.maxRows(int) or ResultQuery.largeMaxRows(long), which correspond to mutable flags on a PreparedStatement, are set by jOOQ even if a listener provides the statement.

  Flags such as ResultQuery.resultSetConcurrency(int), ResultQuery.resultSetHoldability(int), ResultQuery.resultSetType(int), which correspond to immutable flags that are set on the statement at statement creation are not set on a statement provided by a listener.

Specified by:

prepareStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

prepareEnd

public final void prepareEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after preparing / creating the SQL statement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine

Overridable attributes in ExecuteContext:

• ExecuteContext.params(Param[]): Bind values that are to be bound to the PreparedStatement.
• ExecuteContext.statement(PreparedStatement): The Statement, PreparedStatement, or CallableStatement that is about to be executed. You can modify this statement freely, or wrap ExecuteContext.statement() with your enriched statement wrapper

Specified by:

prepareEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

bindStart

public final void bindStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before bind variables to the PreparedStatement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine

Overridable attributes in ExecuteContext:

• ExecuteContext.params(Param[]): Bind values that are to be bound to the PreparedStatement.
• ExecuteContext.statement(PreparedStatement): The PreparedStatement, or CallableStatement that is about to be executed. You can modify this statement freely, or wrap ExecuteContext.statement() with your enriched statement wrapper

Note that this method is not called when executing queries of type StatementType.STATIC_STATEMENT

Specified by:

bindStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

bindEnd

public final void bindEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after bind variables to the PreparedStatement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine

Overridable attributes in ExecuteContext:

• ExecuteContext.statement(PreparedStatement): The Statement, PreparedStatement, or CallableStatement that is about to be executed. You can modify this statement freely, or wrap ExecuteContext.statement() with your enriched statement wrapper

Note that this method is not called when executing queries of type StatementType.STATIC_STATEMENT

Specified by:

bindEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

executeStart

public final void executeStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before executing a statement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine

Overridable attributes in ExecuteContext:

• ExecuteContext.statement(PreparedStatement): The Statement, PreparedStatement, or CallableStatement that is about to be executed. You can modify this statement freely, or wrap ExecuteContext.statement() with your enriched statement wrapper

Other attributes in ExecuteContext, affected by this lifecycle phase:

• ExecuteContext.statementExecutionCount() is incremented.

Specified by:

executeStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

executeEnd

public final void executeEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after executing a statement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched or null, if the Query returns no result set, or if a Routine is being executed.
• ExecuteContext.rows(): The number of affected rows if applicable. In case a ResultSet is fetched, this number is only available at the ExecuteListener.fetchEnd(ExecuteContext) event.
• ExecuteContext.serverOutput(): The server output if available. This may be fetched when Settings.getFetchServerOutputSize() > 0

Overridable attributes in ExecuteContext:

• ExecuteContext.resultSet(ResultSet): The ResultSet that is about to be fetched. You can modify this result set freely, or wrap ExecuteContext.resultSet() with your enriched result set wrapper

Specified by:

executeEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

outStart

public final void outStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before fetching out parameter values from a CallableStatement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Note that this method is called only when executing standalone routine calls.

Specified by:

outStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

outEnd

public final void outEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after fetching out parameter values from a CallableStatement.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Note that this method is called only when executing standalone routine calls.

Specified by:

outEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

fetchStart

public final void fetchStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before fetching data from a ResultSet into a Result type.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Overridable attributes in ExecuteContext:

• ExecuteContext.resultSet(ResultSet): The ResultSet that is about to be fetched. You can modify this result set freely, or wrap ExecuteContext.resultSet() with your enriched result set wrapper

In case of multiple ResultSets with ResultQuery.fetchMany(), this is called several times, once per ResultSet

Note that this method is not called when executing queries that do not return a result, or when executing routines.

Specified by:

fetchStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

resultStart

public final void resultStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before fetching a set of records from a ResultSet.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched.
• ExecuteContext.result(): The set of records that are about to be fetched.
• ExecuteContext.resultLevel(): The result nesting level, in case the upcoming ExecuteContext.result() is a DSL.multiset(TableLike) or other type of nested result.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Executions without Result

Not all types of execution produce results of type Result. For example, these do not:

• ResultQuery.iterator()
• ResultQuery.stream()
• ResultQuery.collect(Collector) (including all Collector based fetches, such as e.g. a ResultQuery.fetchMap(Field, Field), ResultQuery.fetchGroups(Field, Field), ResultQuery.fetchSet(Field), and all the overloads)
• Publisher.subscribe(Subscriber)

In any of these cases, no ExecuteListener.resultStart(ExecuteContext) event is fired.

Note that this method is also not called when executing queries that do not return a result, or when executing routines. This is also not called when fetching single records, with Cursor.fetchNext() for instance.

Specified by:

resultStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

recordStart

public final void recordStart(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called before fetching a record from a ResultSet.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched.
• ExecuteContext.record(): The Record that is about to be fetched.
• ExecuteContext.recordLevel(): The record nesting level, in case the upcoming ExecuteContext.record() is a Row or other type of nested record. The level is also increased if a record is contained in a nested ExecuteContext.result().
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Note that this method is not called when executing queries that do not return a result, or when executing routines.

Specified by:

recordStart in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

recordEnd

public final void recordEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after fetching a record from a ResultSet.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched.
• ExecuteContext.record(): The last Record that was fetched.
• ExecuteContext.recordLevel(): The record nesting level, in case the upcoming ExecuteContext.record() is a Row or other type of nested record. The level is also increased if a record is contained in a nested ExecuteContext.result().
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Note that this method is not called when executing queries that do not return a result, or when executing routines.

Specified by:

recordEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

resultEnd

public final void resultEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after fetching a set of records from a ResultSet.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
• ExecuteContext.resultSet(): The ResultSet that is about to be fetched.
• ExecuteContext.record(): The last Record that was fetched.
• ExecuteContext.result(): The set of records that were fetched.
• ExecuteContext.resultLevel(): The result nesting level, in case the upcoming ExecuteContext.result() is a DSL.multiset(TableLike) or other type of nested result.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Executions without Result

Not all types of execution produce results of type Result. For example, these do not:

• ResultQuery.iterator()
• ResultQuery.stream()
• ResultQuery.collect(Collector) (including all Collector based fetches, such as e.g. a ResultQuery.fetchMap(Field, Field), ResultQuery.fetchGroups(Field, Field), ResultQuery.fetchSet(Field), and all the overloads)
• Publisher.subscribe(Subscriber)

In any of these cases, no ExecuteListener.resultEnd(ExecuteContext) event is fired.

Note that this method is also not called when executing queries that do not return a result, or when executing routines. This is also not called when fetching single records, with Cursor.fetchNext() for instance.

Specified by:

resultEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

fetchEnd

public final void fetchEnd(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called after fetching data from a ResultSet.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
  Note that the Statement is already closed!
• ExecuteContext.resultSet(): The ResultSet that was fetched. Note that the ResultSet is already closed!
• ExecuteContext.rows(): The number of affected rows if applicable.
• ExecuteContext.serverOutput(): The server output if available. This may be fetched when Settings.getFetchServerOutputSize() > 0
• ExecuteContext.record(): The last Record that was fetched.
• ExecuteContext.result(): The last set of records that were fetched.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

In case of multiple ResultSets with ResultQuery.fetchMany(), this is called several times, once per ResultSet

Note that this method is not called when executing queries that do not return a result, or when executing routines.

Specified by:

fetchEnd in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

end

public final void end(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called at the end of the execution lifecycle.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
  Note that the Statement is already closed!
• ExecuteContext.resultSet(): The ResultSet that was fetched or null, if no result set was fetched. Note that the ResultSet may already be closed!
• ExecuteContext.rows(): The number of affected rows if applicable.
• ExecuteContext.serverOutput(): The server output if available. This may be fetched when Settings.getFetchServerOutputSize() > 0
• ExecuteContext.record(): The last Record that was fetched or null if no records were fetched.
• ExecuteContext.result(): The last set of records that were fetched or null if no records were fetched.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database or null if no warning was emitted.

Specified by:

end in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

exception

public final void exception(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called in the event of an exception at any moment of the execution lifecycle.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
  Note that the Statement may be closed!
• ExecuteContext.resultSet(): The ResultSet that was fetched or null, if no result set was fetched. Note that the ResultSet may already be closed!
• ExecuteContext.rows(): The number of affected rows if applicable.
• ExecuteContext.serverOutput(): The server output if available. This may be fetched when Settings.getFetchServerOutputSize() > 0
• ExecuteContext.record(): The last Record that was fetched or null if no records were fetched.
• ExecuteContext.result(): The last set of records that were fetched or null if no records were fetched.
• ExecuteContext.exception(): The RuntimeException that is about to be thrown
• ExecuteContext.sqlException(): The SQLException that was thrown by the database

Specified by:

exception in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

warning

public final void warning(ExecuteContext ctx)

Description copied from interface: ExecuteListener

Called in the event of a warning at any moment of the execution lifecycle.

Available attributes from ExecuteContext:

• ExecuteContext.connection(): The connection used for execution
• Scope.configuration(): The execution configuration
• ExecuteContext.query(): The Query object, if a jOOQ query is being executed or null otherwise
• ExecuteContext.routine(): The Routine object, if a jOOQ routine is being executed or null otherwise
• ExecuteContext.sql(): The rendered SQL statement that is about to be executed, or null if the SQL statement is unknown.
• ExecuteContext.params(): The bind values that are bound to the PreparedStatement.
• ExecuteContext.statement(): The PreparedStatement that is about to be executed, or null if no statement is known to jOOQ. This can be any of the following:
  
  
  • A java.sql.PreparedStatement from your JDBC driver when a jOOQ Query is being executed as StatementType.PREPARED_STATEMENT
  • A java.sql.Statement from your JDBC driver wrapped in a java.sql.PreparedStatement when your jOOQ Query is being executed as StatementType.STATIC_STATEMENT
  • A java.sql.CallableStatement when you are executing a jOOQ Routine
  Note that the Statement may be closed!
• ExecuteContext.resultSet(): The ResultSet that was fetched or null, if no result set was fetched. Note that the ResultSet may already be closed!
• ExecuteContext.rows(): The number of affected rows if applicable.
• ExecuteContext.serverOutput(): The server output if available. This may be fetched when Settings.getFetchServerOutputSize() > 0
• ExecuteContext.record(): The last Record that was fetched or null if no records were fetched.
• ExecuteContext.result(): The last set of records that were fetched or null if no records were fetched.
• ExecuteContext.sqlWarning(): The SQLWarning that was emitted by the database
• ExecuteContext.exception(): The RuntimeException that is about to be thrown or null, if no exception is being thrown.
• ExecuteContext.sqlException(): The SQLException that was thrown by the database or null, if no exception is being thrown.

This method is only invoked if a warning appears. Note that fetching of warnings can be disabled using Settings.isFetchWarnings()

Specified by:

warning in interface ExecuteListener

Parameters:

ctx - The context containing information about the execution.

onStart

public final CallbackExecuteListener onStart(ExecuteEventHandler newOnStart)

onTransformStart

public final CallbackExecuteListener onTransformStart(ExecuteEventHandler newOnTransformStart)

onTransformEnd

public final CallbackExecuteListener onTransformEnd(ExecuteEventHandler newOnTransformEnd)

onRenderStart

public final CallbackExecuteListener onRenderStart(ExecuteEventHandler newOnRenderStart)

onRenderEnd

public final CallbackExecuteListener onRenderEnd(ExecuteEventHandler newOnRenderEnd)

onPrepareStart

public final CallbackExecuteListener onPrepareStart(ExecuteEventHandler newOnPrepareStart)

onPrepareEnd

public final CallbackExecuteListener onPrepareEnd(ExecuteEventHandler newOnPrepareEnd)

onBindStart

public final CallbackExecuteListener onBindStart(ExecuteEventHandler newOnBindStart)

onBindEnd

public final CallbackExecuteListener onBindEnd(ExecuteEventHandler newOnBindEnd)

onExecuteStart

public final CallbackExecuteListener onExecuteStart(ExecuteEventHandler newOnExecuteStart)

onExecuteEnd

public final CallbackExecuteListener onExecuteEnd(ExecuteEventHandler newOnExecuteEnd)

onOutStart

public final CallbackExecuteListener onOutStart(ExecuteEventHandler newOnOutStart)

onOutEnd

public final CallbackExecuteListener onOutEnd(ExecuteEventHandler newOnOutEnd)

onFetchStart

public final CallbackExecuteListener onFetchStart(ExecuteEventHandler newOnFetchStart)

onResultStart

public final CallbackExecuteListener onResultStart(ExecuteEventHandler newOnResultStart)

onRecordStart

public final CallbackExecuteListener onRecordStart(ExecuteEventHandler newOnRecordStart)

onRecordEnd

public final CallbackExecuteListener onRecordEnd(ExecuteEventHandler newOnRecordEnd)

onResultEnd

public final CallbackExecuteListener onResultEnd(ExecuteEventHandler newOnResultEnd)

onFetchEnd

public final CallbackExecuteListener onFetchEnd(ExecuteEventHandler newOnFetchEnd)

onEnd

public final CallbackExecuteListener onEnd(ExecuteEventHandler newOnEnd)

onException

public final CallbackExecuteListener onException(ExecuteEventHandler newOnException)

onWarning

public final CallbackExecuteListener onWarning(ExecuteEventHandler newOnWarning)