pack-priv abstract Class AbstractDMLQueryAsResultQuery<R extends org.jooq.Record, Q extends org.jooq.impl.AbstractDMLQuery<R>>

Implements org.jooq.QueryPartInternal.accept.

Doc from org.jooq.QueryPartInternal.accept.

This QueryPart can accept a Context object in order to render a SQL string or to bind its variables.

Annotations

@Override

Implements org.jooq.Attachable.attach.

Doc from org.jooq.Attachable.attach.

Attach this object to a new Configuration.

Parameters

configuration:Configuration

A configuration or null, if you wish to detach this Attachable from its previous configuration.

Annotations

@Override

Implements org.jooq.CloseableResultQuery.bind.

Doc from org.jooq.Query.bind.

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

Exceptions

IllegalArgumentException:

if there is no parameter by the given parameter name or index.

DataTypeException:

if value cannot be converted into the parameter's data type

Implements org.jooq.CloseableResultQuery.bind.

Doc from org.jooq.Query.bind.

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

Exceptions

IllegalArgumentException:

if there is no parameter by the given parameter index.

DataTypeException:

if value cannot be converted into the parameter's data type

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

Exceptions

DataAccessException:

If something went wrong cancelling the statement

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

Exceptions

DataAccessException:

If something went wrong closing the statement

Implements org.jooq.CloseableResultQuery.coerce.

Doc from org.jooq.ResultQuery.coerce.

Coerce the result record type of this query to that of a table.

Annotations

@Override

Implements org.jooq.CloseableResultQuery.coerce.

Doc from org.jooq.ResultQuery.coerce.

Coerce the result record type of this query to that of a set of fields.

Annotations

@Override

Overrides org.jooq.impl.AbstractQueryPart.configuration.

Implements org.jooq.Attachable.configuration.

Doc from org.jooq.Attachable.configuration.

Get the currently attached Configuration, or null if no Configuration is attached.

Annotations

@Override

Implements org.jooq.Attachable.detach.

Doc from org.jooq.Attachable.detach.

Detach this object from its current Configuration.

This is the same as calling attach(null).

Annotations

@Override

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

Exceptions

DataAccessException:

If anything goes wrong in the database

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

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

Implements org.jooq.ResultQuery.fetch.

Doc from org.jooq.ResultQuery.fetch.

Execute the query and return the generated result.

The result and its contained records are attached to the original Configuration by default. Use Settings#isAttachRecords() to override this behaviour.

Lifecycle guarantees

In order to keep open ResultSets and fetch records lazily, use fetchLazy() instead and then operate on Cursor.

This method is not affected by Settings#getFetchIntermediateResult().

Returns:Result<R>

The result. This will never be null.

Annotations

@Override

Implements org.jooq.CloseableResultQuery.fetchSize.

Doc from org.jooq.ResultQuery.fetchSize.

Specify the fetch size of the underlying Statement.

Regardless of this setting, fetchLazy() is the only way in jOOQ not to fetch all data in memory. However, you may influence how your JDBC driver interacts with your database through specifying a fetch size.

Dialect-specific remarks:

• MySQL uses Integer#MIN_VALUE as an indicator to fetch resulting rows row-by-row in conjunction with ResultSet#TYPE_FORWARD_ONLY (set in resultSetType(int)) and ResultSet#CONCUR_READ_ONLY (set in resultSetConcurrency(int)). See this page here for details.
• PostgreSQL does not like fetch sizes being combined with Connection#getAutoCommit() == true. For more information, see this page here

Annotations

@Override

Implements org.jooq.AttachableQueryPart.getBindValues.

Doc from org.jooq.AttachableQueryPart.getBindValues.

Retrieve the bind values that will be bound by this Query.

Unlike getParams(), which returns also inlined parameters, this returns only actual bind values that will render an actual bind value as a question mark "?"

Annotations

@Override

Overrides default org.jooq.impl.ResultQueryTrait.getFields.

Doc from org.jooq.impl.ResultQueryTrait.getFields.

Get a list of fields provided a result set.

Annotations

@Override

Exceptions

SQLException:

If something goes wrong when accessing ResultSetMetaData.

Implements org.jooq.impl.ResultQueryTrait.getFields.

Doc from org.jooq.impl.ResultQueryTrait.getFields.

Get a list of fields if we don't have a result set.

Annotations

@Override

Implements org.jooq.AttachableQueryPart.getParam.

Doc from org.jooq.AttachableQueryPart.getParam.

Get a named parameter from the Query, provided its name.

Bind values created with DSL#val(Object) will have their bind index as name.

Annotations

@Override

Implements org.jooq.AttachableQueryPart.getParams.

Doc from org.jooq.AttachableQueryPart.getParams.

Get a Map of named parameters. The Map itself cannot be modified, but the Param elements allow for modifying bind values on an existing Query.

Bind values created with DSL#val(Object) will have their bind index as name.

Annotations

@Override

Implements org.jooq.ResultQuery.getRecordType.

Doc from org.jooq.ResultQuery.getRecordType.

The record type produced by this query.

Annotations

@Override

Implements org.jooq.ResultQuery.getResult.

Doc from org.jooq.ResultQuery.getResult.

Return the result generated by a previous call to execute().

Returns:Result<R>

The result or null if no call to execute() was done previously.

Annotations

@Override

Implements org.jooq.AttachableQueryPart.getSQL.

Doc from org.jooq.AttachableQueryPart.getSQL.

Retrieve the SQL code rendered by this Query.

Use this method, when you want to use jOOQ for object oriented query creation, but execute the query with some other technology, such as

• JDBC
• Spring Templates
• JPA native queries
• etc...

Note, this is the same as calling getSQL(ParamType). The parameter will depend on your DSLContext's Settings:

[#1520] Note that the query actually being executed might not contain any bind variables, in case the number of bind variables exceeds your SQL dialect's maximum number of supported bind variables. This is not reflected by this method, which will only use the Settings to decide whether to render bind values.

Annotations

@Override

Implements org.jooq.AttachableQueryPart.getSQL.

Doc from org.jooq.AttachableQueryPart.getSQL.

Retrieve the SQL code rendered by this Query.

[#1520] Note that the query actually being executed might not contain any bind variables, in case the number of bind variables exceeds your SQL dialect's maximum number of supported bind variables. This is not reflected by this method, which will only use paramType argument to decide whether to render bind values.

See getSQL() for more details.

Parameters

paramType:ParamType

How to render parameters. This overrides values in Settings#getStatementType()

Returns:String

The generated SQL

Annotations

@Override

Implements org.jooq.CloseableResultQuery.intern.

Doc from org.jooq.ResultQuery.intern.

Specify a set of fields whose values should be interned.

Unlike Result's intern() methods, this already interns values right after fetching them from a JDBC result set. See Result#intern(int...) for more details.

Parameters

fields:Field<?>[]

The fields whose values should be interned

Returns:CloseableResultQuery<R>

The same result query

Annotations

@Override

Implements org.jooq.CloseableResultQuery.intern.

Doc from org.jooq.ResultQuery.intern.

Specify a set of field indexes whose values should be interned.

Unlike Result's intern() methods, this already interns values right after fetching them from a JDBC result set. See Result#intern(int...) for more details.

Parameters

fieldIndexes:int[]

The field indexes whose values should be interned

Returns:CloseableResultQuery<R>

The same result query

Annotations

@Override

Implements org.jooq.CloseableResultQuery.intern.

Doc from org.jooq.ResultQuery.intern.

Specify a set of field names whose values should be interned.

Unlike Result's intern() methods, this already interns values right after fetching them from a JDBC result set. See Result#intern(String...) for more details.

Parameters

fieldNames:String[]

The field names whose values should be interned

Returns:CloseableResultQuery<R>

The same result query

Annotations

@Override

Implements org.jooq.CloseableResultQuery.intern.

Doc from org.jooq.ResultQuery.intern.

Specify a set of field names whose values should be interned.

Unlike Result's intern() methods, this already interns values right after fetching them from a JDBC result set. See Result#intern(Name...) for more details.

Parameters

fieldNames:Name[]

The field names whose values should be interned

Returns:CloseableResultQuery<R>

The same result query

Annotations

@Override

Implements org.jooq.Query.isExecutable.

Doc from org.jooq.Query.isExecutable.

Whether this query is executable in its current state.

DML queries may be incomplete in structure and thus not executable. Calling execute() on such queries has no effect, but beware that getSQL() may not render valid SQL!

Annotations

@Override

Implements org.jooq.CloseableResultQuery.keepStatement.

Doc from org.jooq.Query.keepStatement.

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

keepStatement:boolean

Whether to keep the underlying statement open

Annotations

@Override

Implements org.jooq.CloseableResultQuery.maxRows.

Doc from org.jooq.ResultQuery.maxRows.

Specify the maximum number of rows returned by the underlying Statement.

This is not the same as setting a LIMIT … OFFSET clause onto the statement, where the result set is restricted within the database.

Annotations

@Override

Implements org.jooq.CloseableResultQuery.poolable.

Doc from org.jooq.Query.poolable.

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

Implements org.jooq.CloseableResultQuery.queryTimeout.

Doc from org.jooq.Query.queryTimeout.

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

Annotations

@Override

Implements org.jooq.CloseableResultQuery.resultSetConcurrency.

Doc from org.jooq.ResultQuery.resultSetConcurrency.

Specify the ResultSet concurrency of ResultSet objects created by jOOQ.

This will affect the way you may perceive ResultSet objects obtained from any of these methods:

• ResultQuery#fetchResultSet()
• Cursor#resultSet()
• ExecuteContext#resultSet()

Annotations

@Override

Implements org.jooq.CloseableResultQuery.resultSetHoldability.

Doc from org.jooq.ResultQuery.resultSetHoldability.

Specify the ResultSet holdability of ResultSet objects created by jOOQ.

This will affect the way you may perceive ResultSet objects obtained from any of these methods:

• ResultQuery#fetchResultSet()
• Cursor#resultSet()
• ExecuteContext#resultSet()

Annotations

@Override

Implements org.jooq.CloseableResultQuery.resultSetType.

Doc from org.jooq.ResultQuery.resultSetType.

Specify the ResultSet type of ResultSet objects created by jOOQ.

This will affect the way you may perceive ResultSet objects obtained from any of these methods:

• ResultQuery#fetchResultSet()
• Cursor#resultSet()
• ExecuteContext#resultSet()

Annotations

@Override