Module org.jooq

Package org.jooq

Interface ExecuteContext

All Superinterfaces:

Scope

public interface ExecuteContext
extends Scope

A context object for Query execution passed to registered ExecuteListener's.

This type implements Scope and thus has a lifecycle defined by the query execution.

The Scope.data() map contents are maintained for the entirety of the execution, and are passed along to child Scope types, including e.g.

• BindingScope: When passing bind values or reading results.

Author:

Lukas Eder

See Also:

• ExecuteListener

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	ExecuteContext.BatchMode	The batch mode, which helps interpret the contents of batchQueries().

Method Summary

Modifier and Type	Method	Description
@NotNull ExecuteContext.BatchMode	batchMode()	The batch execution mode.
@NotNull Query @NotNull []	batchQueries()	The jOOQ Query objects that are being executed in batch mode, or empty if the query is unknown or if there was no jOOQ Query.
void	batchQueries(Query... query)	Set the jOOQ batch Query objects that are being executed, if applicable.
int @NotNull []	batchRows()	The number of rows that were affected by the last statement executed in batch mode.
@NotNull String @NotNull []	batchSQL()	The generated SQL statements that are being executed in batch mode, or empty if the query is unknown or if there was no SQL statement.
Connection	connection()	The connection to be used in this execute context.
void	connectionProvider(ConnectionProvider connectionProvider)	Override the Connection that is being used for execution.
ConverterContext	converterContext()	Get a ConverterContext for the scope of this ExecuteContext.
@Nullable RuntimeException	exception()	The RuntimeException being thrown.
void	exception(RuntimeException e)	Override the RuntimeException being thrown.
@NotNull Query @NotNull []	originalBatchQueries()	The original batch Query objects that were available at the ExecuteListener.start(ExecuteContext) of this ExecuteContext.
@Nullable Query	originalQuery()	The original Query that was available at the ExecuteListener.start(ExecuteContext) of this ExecuteContext, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.
Param<?> @NotNull []	params()	The bind values that are being bound to the PreparedStatement.
void	params(Param<?>[] params)	Override the bind values that are being bound to the PreparedStatement.
@Nullable Query	query()	The jOOQ Query that is being executed, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.
void	query(Query query)	Set the jOOQ Query that is being executed, if applicable.
@Nullable Record	record()	The last record that was fetched from the result set, or null if no record has been fetched.
void	record(Record record)	Calling this has no effect.
int	recordLevel()	The 0-based record nesting level for record(), relevant when nested result events are triggered via ExecuteListener.resultStart(ExecuteContext) and ExecuteListener.resultEnd(ExecuteContext), e.g.
@Nullable Result<?>	result()	The last result that was fetched from the result set, or null if no result has been fetched, including when results do not need to be buffered in a Result type, such as all ResultQuery.collect(Collector) or ResultQuery.iterator() based fetches.
void	result(Result<?> result)	Calling this has no effect.
int	resultLevel()	The 0-based result nesting level for result(), relevant when nested result events are triggered via ExecuteListener.resultStart(ExecuteContext) and ExecuteListener.resultEnd(ExecuteContext), e.g.
@Nullable ResultSet	resultSet()	The ResultSet that is being fetched or null if the result set is unknown or if no result set is being fetched.
void	resultSet(ResultSet resultSet)	Override the ResultSet that is being fetched.
@Nullable Routine<?>	routine()	The jOOQ Routine that is being executed or null if the query is unknown or if there was no jOOQ Routine.
int	rows()	The number of rows that were affected by the last statement.
void	rows(int rows)	Calling this has no effect.
@NotNull String @NotNull []	serverOutput()	Any server output collected from this statement when Settings.getFetchServerOutputSize() > 0.
void	serverOutput(String[] output)	Any server output collected from this statement when Settings.getFetchServerOutputSize() > 0.
int	skipUpdateCounts()	The number of user defined update counts that are going to be skipped when a statement batch is executed.
void	skipUpdateCounts(int skip)	Override the number of update counts that are going to be skipped when a statement batch is executed.
@Nullable String	sql()	The SQL that is being executed or null if the SQL statement is unknown or if there was no SQL statement.
void	sql(String sql)	Override the SQL statement that is being executed.
@Nullable SQLException	sqlException()	The SQLException that was thrown by the database.
void	sqlException(SQLException e)	Override the SQLException being thrown.
@Nullable SQLWarning	sqlWarning()	The SQLWarning that was emitted by the database.
void	sqlWarning(SQLWarning e)	Override the SQLWarning being emitted.
@Nullable PreparedStatement	statement()	The PreparedStatement that is being executed or null if the statement is unknown or if there was no statement.
void	statement(PreparedStatement statement)	Override the PreparedStatement that is being executed.
int	statementExecutionCount()	The number of times this particular statement has been executed.
@NotNull Query @NotNull []	transformedBatchQueries()	The transformed batch Query objects that were available at the ExecuteListener.transformEnd(ExecuteContext) event of this ExecuteContext.
@Nullable Query	transformedQuery()	The transformed Query that was available at the ExecuteListener.transformEnd(ExecuteContext) event of this ExecuteContext, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.
@NotNull ExecuteType	type()	The type of database interaction that is being executed.

Methods inherited from interface org.jooq.Scope

configuration, creationTime, data, data, data, dialect, dsl, family, settings

Method Details

converterContext

ConverterContext converterContext()

Get a ConverterContext for the scope of this ExecuteContext.

connection

Connection connection()

The connection to be used in this execute context.

This returns a proxy to the Configuration.connectionProvider() 's supplied connection. This proxy takes care of two things:

• It takes care of properly implementing Settings.getStatementType()
• It takes care of properly returning a connection to ConnectionProvider.release(Connection), once jOOQ can release the connection

type

@NotNull
@NotNull ExecuteType type()

The type of database interaction that is being executed.

See Also:

• ExecuteType

query

@Nullable
@Nullable Query query()

The jOOQ Query that is being executed, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.

This corresponds to transformedQuery().

See Also:

• routine()
• batchQueries()

originalQuery

@Nullable
@Pro
@Nullable Query originalQuery()

The original Query that was available at the ExecuteListener.start(ExecuteContext) of this ExecuteContext, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.

transformedQuery

@Nullable
@Pro
@Nullable Query transformedQuery()

The transformed Query that was available at the ExecuteListener.transformEnd(ExecuteContext) event of this ExecuteContext, or null if the query is unknown, if it is a batch query, or if there was no jOOQ Query.

If no transformation took place (yet), then this is the same as originalQuery().

query

@Pro
void query(Query query)

Set the jOOQ Query that is being executed, if applicable.

This may have no effect, if called at the wrong moment, or if batchMode() is not ExecuteContext.BatchMode.NONE.

See Also:

• ExecuteListener.transformStart(ExecuteContext)
• ExecuteListener.transformEnd(ExecuteContext)

batchMode

@NotNull
@NotNull ExecuteContext.BatchMode batchMode()

The batch execution mode.

batchQueries

@NotNull
@NotNull Query @NotNull [] batchQueries()

The jOOQ Query objects that are being executed in batch mode, or empty if the query is unknown or if there was no jOOQ Query.

If a single Query is executed in non-batch mode, this will return an array of length 1, containing that Query

Refer to batchMode() to decide how to interpret this content.

This corresponds to transformedBatchQueries().

Returns:

The executed Query object(s). This is never null

See Also:

• query()
• routine()

originalBatchQueries

@Pro
@NotNull
@NotNull Query @NotNull [] originalBatchQueries()

The original batch Query objects that were available at the ExecuteListener.start(ExecuteContext) of this ExecuteContext.

transformedBatchQueries

@Pro
@NotNull
@NotNull Query @NotNull [] transformedBatchQueries()

The transformed batch Query objects that were available at the ExecuteListener.transformEnd(ExecuteContext) event of this ExecuteContext.

If no transformation took place (yet), then this is the same as originalBatchQueries().

batchQueries

@Pro
void batchQueries(Query... query)

Set the jOOQ batch Query objects that are being executed, if applicable.

This may have no effect, if called at the wrong moment, or if batchMode() is ExecuteContext.BatchMode.NONE.

See Also:

• ExecuteListener.transformStart(ExecuteContext)
• ExecuteListener.transformEnd(ExecuteContext)

routine

@Nullable
@Nullable Routine<?> routine()

The jOOQ Routine that is being executed or null if the query is unknown or if there was no jOOQ Routine.

See Also:

• routine()

sql

@Nullable
@Nullable String sql()

The SQL that is being executed or null if the SQL statement is unknown or if there was no SQL statement.

sql

void sql(String sql)

Override the SQL statement that is being executed.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.renderEnd(ExecuteContext)
• ExecuteListener.prepareStart(ExecuteContext)

params

Param<?> @NotNull [] params()

The bind values that are being bound to the PreparedStatement.

params

void params(Param<?>[] params)

Override the bind values that are being bound to the PreparedStatement.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.renderEnd(ExecuteContext)
• ExecuteListener.prepareStart(ExecuteContext)

skipUpdateCounts

int skipUpdateCounts()

The number of user defined update counts that are going to be skipped when a statement batch is executed.

This is in addition to any skips added during the rendering of a QueryPart by jOOQ's internals or by user-defined query parts, such as CustomQueryPart.

skipUpdateCounts

void skipUpdateCounts(int skip)

Override the number of update counts that are going to be skipped when a statement batch is executed.

This is in addition to any skips added during the rendering of a QueryPart by jOOQ's internals or by user-defined query parts, such as CustomQueryPart.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.renderEnd(ExecuteContext)
• ExecuteListener.prepareStart(ExecuteContext)

batchSQL

@NotNull
@NotNull String @NotNull [] batchSQL()

The generated SQL statements that are being executed in batch mode, or empty if the query is unknown or if there was no SQL statement.

If a single Query is executed in non-batch mode, this will return an array of length 1, containing that Query

Returns:

The generated SQL statement(s). This is never null

See Also:

• query()
• routine()

connectionProvider

void connectionProvider(ConnectionProvider connectionProvider)

Override the Connection that is being used for execution.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.start(ExecuteContext)

statement

@Nullable
@Nullable PreparedStatement statement()

The PreparedStatement that is being executed or null if the statement is unknown or if there was no statement.

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

statement

void statement(PreparedStatement statement)

Override the PreparedStatement that is being executed.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.prepareEnd(ExecuteContext)
• ExecuteListener.bindStart(ExecuteContext)

statementExecutionCount

int statementExecutionCount()

The number of times this particular statement has been executed.

Statements that are prepared by jOOQ can be executed multiple times without being closed if Query.keepStatement(boolean) is activated.

This value will increment as soon as the statement is about to be executed (at the ExecuteListener.executeStart(ExecuteContext) event).

See Also:

• ExecuteListener.executeStart(ExecuteContext)

resultSet

@Nullable
@Nullable ResultSet resultSet()

The ResultSet that is being fetched or null if the result set is unknown or if no result set is being fetched.

resultSet

void resultSet(ResultSet resultSet)

Override the ResultSet that is being fetched.

This may have no effect, if called at the wrong moment.

See Also:

• ExecuteListener.executeEnd(ExecuteContext)
• ExecuteListener.fetchStart(ExecuteContext)

recordLevel

int recordLevel()

The 0-based record nesting level for record(), relevant when nested result events are triggered via ExecuteListener.resultStart(ExecuteContext) and ExecuteListener.resultEnd(ExecuteContext), e.g. in the presence of DSL.multiset(TableLike).

record

@Nullable
@Nullable Record record()

The last record that was fetched from the result set, or null if no record has been fetched.

record

void record(Record record)

Calling this has no effect. It is used by jOOQ internally.

rows

int rows()

The number of rows that were affected by the last statement.

This returns -1:

• if the number of affected rows is not yet available (e.g. prior to the ExecuteListener.executeEnd(ExecuteContext) event).
• if affected rows are not applicable for the given statement (statements that do not produce a JDBC Statement.getUpdateCount().

rows

void rows(int rows)

Calling this has no effect. It is used by jOOQ internally.

batchRows

int @NotNull [] batchRows()

The number of rows that were affected by the last statement executed in batch mode.

If a single Query is executed in non-batch mode, this will return an array of length 1, containing rows()

This returns -1 values if the number of affected rows is not yet available, or if affected rows are not applicable for a given statement.

Returns:

The affected rows. This is never null

See Also:

• rows()

resultLevel

int resultLevel()

The 0-based result nesting level for result(), relevant when nested result events are triggered via ExecuteListener.resultStart(ExecuteContext) and ExecuteListener.resultEnd(ExecuteContext), e.g. in the presence of DSL.multiset(TableLike).

result

@Nullable
@Nullable Result<?> result()

The last result that was fetched from the result set, or null if no result has been fetched, including when results do not need to be buffered in a Result type, such as all ResultQuery.collect(Collector) or ResultQuery.iterator() based fetches.

result

void result(Result<?> result)

Calling this has no effect. It is used by jOOQ internally.

exception

@Nullable
@Nullable RuntimeException exception()

The RuntimeException being thrown.

exception

void exception(RuntimeException e)

Override the RuntimeException being thrown.

This may have no effect, if called at the wrong moment.

If null is being passed, jOOQ will internally translate the "unavailable" exception to an unspecified DataAccessException.

sqlException

@Nullable
@Nullable SQLException sqlException()

The SQLException that was thrown by the database.

sqlException

void sqlException(SQLException e)

Override the SQLException being thrown.

Any SQLException will be wrapped by jOOQ using an unchecked DataAccessException. To have jOOQ throw your own custom RuntimeException, use exception(RuntimeException) instead. This may have no effect, if called at the wrong moment.

If null is being passed, jOOQ will internally translate the "unavailable" exception to an unspecified DataAccessException.

sqlWarning

@Nullable
@Nullable SQLWarning sqlWarning()

The SQLWarning that was emitted by the database.

Note that fetching of warnings can be disabled using Settings.isFetchWarnings(), in case of which this property will be null.

sqlWarning

void sqlWarning(SQLWarning e)

Override the SQLWarning being emitted.

serverOutput

@NotNull
@NotNull String @NotNull [] serverOutput()

Any server output collected from this statement when Settings.getFetchServerOutputSize() > 0.

Returns:

The server output. This is never null.

serverOutput

void serverOutput(String[] output)

Any server output collected from this statement when Settings.getFetchServerOutputSize() > 0.