Module org.jooq

Package org.jooq.tools

Class LoggerListener

java.lang.Object

org.jooq.tools.LoggerListener

All Implemented Interfaces:

Serializable, EventListener, ExecuteListener

public class LoggerListener
extends Object
implements ExecuteListener

A default ExecuteListener that just logs events to java.util.logging, log4j, or slf4j using the JooqLogger

Author:

Lukas Eder

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
LoggerListener()

Method Summary

Modifier and Type	Method	Description
void	bindEnd(ExecuteContext ctx)	Called after bind variables to the PreparedStatement.
void	exception(ExecuteContext ctx)	Called in the event of an exception at any moment of the execution lifecycle.
void	executeEnd(ExecuteContext ctx)	Called after executing a statement.
void	executeStart(ExecuteContext ctx)	Called before executing a statement.
void	fetchEnd(ExecuteContext ctx)	Called after fetching data from a ResultSet.
void	outEnd(ExecuteContext ctx)	Called after fetching out parameter values from a CallableStatement.
void	recordEnd(ExecuteContext ctx)	Called after fetching a record from a ResultSet.
void	renderEnd(ExecuteContext ctx)	Called after rendering SQL from a QueryPart.
void	resultEnd(ExecuteContext ctx)	Called after fetching a set of records from a ResultSet.
void	resultStart(ExecuteContext ctx)	Called before fetching a set of records from a ResultSet.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jooq.ExecuteListener

bindStart, end, fetchStart, outStart, prepareEnd, prepareStart, recordStart, renderStart, start, transformEnd, transformStart, warning

Constructor Details

LoggerListener

public LoggerListener()

Method Details

renderEnd

public 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.

bindEnd

public 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 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.

recordEnd

public 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.

resultStart

public 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.

resultEnd

public 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 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.

executeEnd

public 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.

outEnd

public 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.

exception

public 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.