jOOQ 3.18.7 · org.jooq.impl.AbstractQuery

Modifier and Type	Field and Description
private boolean	keepStatement
private static final JooqLogger	log Hides org.jooq.impl.AbstractQueryPart.log.
private QueryPoolable	poolable
pack-priv transient DefaultRenderContext.Rendered	rendered
private static final Set<SQLDialect>	SET_AUTOCOMMIT_ON_START_TRANSACTION
pack-priv transient PreparedStatement	statement
pack-priv transient int	statementExecutionCount
private int	timeout

Access	Constructor and Description
pack-priv	AbstractQuery(Configuration configuration)

Method Summary

Modifier and Type	Method and Description
public CloseableQuery	bind(String The named parameter name. If this is a number, then this is the same as calling `bind(int, Object)` param, Object The new bind value. value) Implements org.jooq.CloseableQuery.bind. Subclasses may override this for covariant result types Bind a new value to a named parameter.
public CloseableQuery	bind(int The parameter index, starting with 1 index, Object The new bind value. value) Implements org.jooq.CloseableQuery.bind. Subclasses may override this for covariant result types Bind a new value to an indexed parameter.
public final void	cancel() Implements org.jooq.Query.cancel. Cancel the underlying statement.
public final void	close() Implements org.jooq.CloseableQuery.close. Close the underlying statement.
private final void	closeIfNecessary(Param<?> The param that was changed param) Deprecated as a consequence of `Param` being deprecated. Close the statement if necessary.
pack-priv static final Connection	connection(DefaultExecuteContext ctx)
public final int	execute() Implements org.jooq.Query.execute. Execute the query, if it has been created with a proper configuration.
protected int	execute(ExecuteContext ctx, ExecuteListener listener) Default implementation for query execution using a prepared statement.
public final CompletionStage<Integer>	executeAsync() Implements org.jooq.Query.executeAsync. Execute the query in a new `CompletionStage`.
public final CompletionStage<Integer>	executeAsync(Executor executor) Implements org.jooq.Query.executeAsync. Execute the query in a new `CompletionStage` that is asynchronously completed by a task running in the given executor.
private static final DefaultRenderContext.Rendered	getSQL0(DefaultExecuteContext ctx)
public boolean	isExecutable() Implements org.jooq.Query.isExecutable. Default implementation for executable check.
protected boolean	keepResultSet() Default implementation to indicate whether this query should close the `ResultSet` after execution.
public CloseableQuery	keepStatement(boolean Whether to keep the underlying statement open k) Implements org.jooq.CloseableQuery.keepStatement. Subclasses may override this for covariant result types Keep the query's underlying statement open after execution.
protected final boolean	keepStatement()
public CloseableQuery	poolable(boolean p) Implements org.jooq.CloseableQuery.poolable. Subclasses may override this for covariant result types Specify whether any JDBC `java.sql.Statement` created by this query should be `java.sql.Statement#setPoolable(boolean)`.
protected void	prepare(ExecuteContext ctx) Default implementation for preparing a statement.
public CloseableQuery	queryTimeout(int t) Implements org.jooq.CloseableQuery.queryTimeout. Subclasses may override this for covariant result types Specify the query timeout in number of seconds for the underlying JDBC `Statement`.
pack-priv final void	toSQLSemiColon(RenderContext ctx)

Inherited from org.jooq.impl.AbstractAttachableQueryPart:: attach configuration configurationOrDefault configurationOrThrow detach getBindValues getParam getParams getSQL getSQL

keepStatement	back to summary
private boolean keepStatement

log	back to summary
private static final JooqLogger log Hides org.jooq.impl.AbstractQueryPart.log.

poolable	back to summary
private QueryPoolable poolable

rendered	back to summary
pack-priv transient DefaultRenderContext.Rendered rendered

SET_AUTOCOMMIT_ON_START_TRANSACTION	back to summary
private static final Set<SQLDialect> SET_AUTOCOMMIT_ON_START_TRANSACTION

statement	back to summary
pack-priv transient PreparedStatement statement

statementExecutionCount	back to summary
pack-priv transient int statementExecutionCount

timeout	back to summary
private int timeout

AbstractQuery	back to summary
pack-priv AbstractQuery(Configuration configuration)

Method Detail

bind back to summary

bind	back to summary
public CloseableQuery bind(String param, Object value) Implements org.jooq.CloseableQuery.bind. Doc from org.jooq.Query.bind. Subclasses may override this for covariant result types Bind a new value to a named parameter. [#1886] If the bind value with name `param` is inlined ( `Param#isInline()`) or if this query was created with `StatementType#STATIC_STATEMENT` and there is an underlying `PreparedStatement` kept open because of `keepStatement(boolean)`, the underlying `PreparedStatement` will be closed automatically in order for new bind values to have an effect. Parameters param:String The named parameter name. If this is a number, then this is the same as calling `bind(int, Object)` value:Object The new bind value. Annotations @Override

public CloseableQuery bind(String param, Object value)

Implements org.jooq.CloseableQuery.bind.

Doc from org.jooq.Query.bind.

Subclasses may override this for covariant result types

Bind a new value to a named parameter.

[#1886] If the bind value with name param is inlined ( Param#isInline()) or if this query was created with StatementType#STATIC_STATEMENT and there is an underlying PreparedStatement kept open because of keepStatement(boolean), the underlying PreparedStatement will be closed automatically in order for new bind values to have an effect.

Parameters

param:String: The named parameter name. If this is a number, then this is the same as calling bind(int, Object)
value:Object: The new bind value.

Annotations

@Override

bind back to summary

bind	back to summary
public CloseableQuery bind(int index, Object value) Implements org.jooq.CloseableQuery.bind. Doc from org.jooq.Query.bind. Subclasses may override this for covariant result types Bind a new value to an indexed parameter. [#1886] If the bind value at `index` is inlined ( `Param#isInline()`) or if this query was created with `StatementType#STATIC_STATEMENT` and there is an underlying `PreparedStatement` kept open because of `keepStatement(boolean)`, the underlying `PreparedStatement` will be closed automatically in order for new bind values to have an effect. Parameters index:int The parameter index, starting with 1 value:Object The new bind value. Annotations @Override

public CloseableQuery bind(int index, Object value)

Implements org.jooq.CloseableQuery.bind.

Doc from org.jooq.Query.bind.

Subclasses may override this for covariant result types

Bind a new value to an indexed parameter.

[#1886] If the bind value at index is inlined ( Param#isInline()) or if this query was created with StatementType#STATIC_STATEMENT and there is an underlying PreparedStatement kept open because of keepStatement(boolean), the underlying PreparedStatement will be closed automatically in order for new bind values to have an effect.

Parameters

index:int: The parameter index, starting with 1
value:Object: The new bind value.

Annotations

@Override

cancel back to summary

cancel	back to summary
public final void cancel() Implements org.jooq.Query.cancel. Doc from org.jooq.Query.cancel. Cancel the underlying statement. This cancels the query's underlying `Statement` or `PreparedStatement`. If there is no underlying open and running statement, this call is simply ignored. Annotations @Override

public final void cancel()

Implements org.jooq.Query.cancel.

Doc from org.jooq.Query.cancel.

Cancel the underlying statement.

This cancels the query's underlying Statement or PreparedStatement. If there is no underlying open and running statement, this call is simply ignored.

Annotations

@Override

close back to summary

close	back to summary
public final void close() Implements org.jooq.CloseableQuery.close. Doc from org.jooq.CloseableQuery.close. Close the underlying statement. This closes the query's underlying `Statement` or `PreparedStatement` if a previous call to `keepStatement(boolean)` indicated that jOOQ should keep statements open after query execution. If there is no underlying open statement, this call is simply ignored. Annotations @Override

public final void close()

Implements org.jooq.CloseableQuery.close.

Doc from org.jooq.CloseableQuery.close.

Close the underlying statement.

This closes the query's underlying Statement or PreparedStatement if a previous call to keepStatement(boolean) indicated that jOOQ should keep statements open after query execution. If there is no underlying open statement, this call is simply ignored.

Annotations

@Override

closeIfNecessary back to summary

closeIfNecessary	back to summary
private final void closeIfNecessary(Param<?> param) Deprecated as a consequence of `Param` being deprecated. See corresponding docs for further information. Close the statement if necessary. [#1886] If there is an open (cached) statement and its bind values are inlined due to a `StatementType#STATIC_STATEMENT` setting, the statement should be closed. Parameters param:Param<?> The param that was changed

private final void closeIfNecessary(Param<?> param)

Deprecated

as a consequence of Param being deprecated. See corresponding docs for further information.

Close the statement if necessary.

[#1886] If there is an open (cached) statement and its bind values are inlined due to a StatementType#STATIC_STATEMENT setting, the statement should be closed.

Parameters

param:Param<?>: The param that was changed

connection	back to summary
pack-priv static final Connection connection(DefaultExecuteContext ctx)

execute back to summary

execute	back to summary
public final int execute() Implements org.jooq.Query.execute. Doc from org.jooq.Query.execute. Execute the query, if it has been created with a proper configuration. Returns:int A result value, depending on the concrete implementation of `Query`: `Delete` : the number of deleted records `Insert` : the number of inserted records `Merge` : the result may have no meaning `Select` : the number of resulting records `Truncate` : the result may have no meaning `Update` : the number of updated records Annotations @Override

public final int execute()

Implements org.jooq.Query.execute.

Doc from org.jooq.Query.execute.

Execute the query, if it has been created with a proper configuration.

Returns:int

A result value, depending on the concrete implementation of Query:

Delete : the number of deleted records
Insert : the number of inserted records
Merge : the result may have no meaning
Select : the number of resulting records
Truncate : the result may have no meaning
Update : the number of updated records

Annotations

@Override

execute	back to summary
protected int execute(ExecuteContext ctx, ExecuteListener listener) throws SQLException Default implementation for query execution using a prepared statement. Subclasses may override this method.

executeAsync back to summary

executeAsync	back to summary
public final CompletionStage<Integer> executeAsync() Implements org.jooq.Query.executeAsync. Doc from org.jooq.Query.executeAsync. Execute the query in a new `CompletionStage`. The result is asynchronously completed by a task running in an `Executor` provided by the underlying `Configuration#executorProvider()`. Returns:CompletionStage<Integer> A result value, depending on the concrete implementation of `Query`: `Delete` : the number of deleted records `Insert` : the number of inserted records `Merge` : the result may have no meaning `Select` : the number of resulting records `Truncate` : the result may have no meaning `Update` : the number of updated records Annotations @Override

public final CompletionStage<Integer> executeAsync()

Implements org.jooq.Query.executeAsync.

Doc from org.jooq.Query.executeAsync.

Execute the query in a new CompletionStage.

The result is asynchronously completed by a task running in an Executor provided by the underlying Configuration#executorProvider().

Returns:CompletionStage<Integer>

A result value, depending on the concrete implementation of Query:

Delete : the number of deleted records
Insert : the number of inserted records
Merge : the result may have no meaning
Select : the number of resulting records
Truncate : the result may have no meaning
Update : the number of updated records

Annotations

@Override

executeAsync back to summary

executeAsync	back to summary
public final CompletionStage<Integer> executeAsync(Executor executor) Implements org.jooq.Query.executeAsync. Doc from org.jooq.Query.executeAsync. Execute the query in a new `CompletionStage` that is asynchronously completed by a task running in the given executor. Returns:CompletionStage<Integer> A result value, depending on the concrete implementation of `Query`: `Delete` : the number of deleted records `Insert` : the number of inserted records `Merge` : the result may have no meaning `Select` : the number of resulting records `Truncate` : the result may have no meaning `Update` : the number of updated records Annotations @Override

public final CompletionStage<Integer> executeAsync(Executor executor)

Implements org.jooq.Query.executeAsync.

Doc from org.jooq.Query.executeAsync.

Execute the query in a new CompletionStage that is asynchronously completed by a task running in the given executor.

Returns:CompletionStage<Integer>

A result value, depending on the concrete implementation of Query:

Delete : the number of deleted records
Insert : the number of inserted records
Merge : the result may have no meaning
Select : the number of resulting records
Truncate : the result may have no meaning
Update : the number of updated records

Annotations

@Override

getSQL0	back to summary
private static final DefaultRenderContext.Rendered getSQL0(DefaultExecuteContext ctx)

isExecutable	back to summary
public boolean isExecutable() Implements org.jooq.Query.isExecutable. Default implementation for executable check. Subclasses may override this method. Annotations @Override

isExecutable

back to summary

public boolean isExecutable()

Implements org.jooq.Query.isExecutable.

Default implementation for executable check. Subclasses may override this method.

Annotations

@Override

keepResultSet	back to summary
protected boolean keepResultSet() Default implementation to indicate whether this query should close the `ResultSet` after execution. Subclasses may override this method.

keepStatement back to summary

keepStatement	back to summary
public CloseableQuery keepStatement(boolean k) Implements org.jooq.CloseableQuery.keepStatement. Doc from org.jooq.Query.keepStatement. Subclasses may override this for covariant result types Keep the query's underlying statement open after execution. This indicates to jOOQ that the query's underlying `Statement` or `PreparedStatement` should be kept open after execution. If it is kept open, client code is responsible for properly closing it using `CloseableQuery#close()`, e.g. via a `try-with-resources` statement. Parameters k:boolean Whether to keep the underlying statement open Annotations @Override

public CloseableQuery keepStatement(boolean k)

Implements org.jooq.CloseableQuery.keepStatement.

Doc from org.jooq.Query.keepStatement.

Subclasses may override this for covariant result types

Keep the query's underlying statement open after execution.

This indicates to jOOQ that the query's underlying Statement or PreparedStatement should be kept open after execution. If it is kept open, client code is responsible for properly closing it using CloseableQuery#close(), e.g. via a try-with-resources statement.

Parameters

k:boolean: Whether to keep the underlying statement open

Annotations

@Override

keepStatement	back to summary
protected final boolean keepStatement()

poolable back to summary

poolable	back to summary
public CloseableQuery poolable(boolean p) Implements org.jooq.CloseableQuery.poolable. Doc from org.jooq.Query.poolable. Subclasses may override this for covariant result types Specify whether any JDBC `java.sql.Statement` created by this query should be `java.sql.Statement#setPoolable(boolean)`. If this method is not called on jOOQ types, then jOOQ will not specify the flag on JDBC either, resulting in JDBC's default behaviour. Annotations @Override

public CloseableQuery poolable(boolean p)

Implements org.jooq.CloseableQuery.poolable.

Doc from org.jooq.Query.poolable.

Subclasses may override this for covariant result types

Specify whether any JDBC java.sql.Statement created by this query should be java.sql.Statement#setPoolable(boolean).

If this method is not called on jOOQ types, then jOOQ will not specify the flag on JDBC either, resulting in JDBC's default behaviour.

Annotations

@Override

prepare	back to summary
protected void prepare(ExecuteContext ctx) throws SQLException Default implementation for preparing a statement. Subclasses may override this method.

queryTimeout back to summary

queryTimeout	back to summary
public CloseableQuery queryTimeout(int t) Implements org.jooq.CloseableQuery.queryTimeout. Doc from org.jooq.Query.queryTimeout. Subclasses may override this for covariant result types Specify the query timeout in number of seconds for the underlying JDBC `Statement`. Annotations @Override

public CloseableQuery queryTimeout(int t)

Implements org.jooq.CloseableQuery.queryTimeout.

Doc from org.jooq.Query.queryTimeout.

Subclasses may override this for covariant result types

Specify the query timeout in number of seconds for the underlying JDBC Statement.

Annotations