org.jooq

Interface UpdateResultStep<R extends Record>

All Superinterfaces:

Attachable, AutoCloseable, Query, QueryPart, Serializable, Statement, Update<R>

public interface UpdateResultStep<R extends Record>
extends Update<R>

This type is used for the Update's DSL API.

Example:

 DSLContext create = DSL.using(configuration);

 TableRecord<?> record =
 create.update(table)
       .set(field1, value1)
       .set(field2, value2)
       .returning(field1)
       .fetchOne();
 

This implemented differently for every dialect:

• Firebird and Postgres have native support for UPDATE .. RETURNING clauses
• DB2 allows to execute SELECT .. FROM FINAL TABLE (UPDATE ...)

Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

• They're operating on mutable implementations (as of jOOQ 3.x)
• They're less composable and not easy to get right when dynamic SQL gets complex
• They're less readable
• They might have binary incompatible changes between minor releases

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
Result<R>	fetch() The result holding returned values as specified by the UpdateReturningStep.
R	fetchOne() The record holding returned values as specified by the UpdateReturningStep.
Optional<R>	fetchOptional() The record holding returned values as specified by the UpdateReturningStep.

Methods inherited from interface org.jooq.Query

bind, bind, cancel, close, execute, executeAsync, executeAsync, getBindValues, getParam, getParams, getSQL, getSQL, getSQL, isExecutable, keepStatement, queryTimeout

Methods inherited from interface org.jooq.QueryPart

equals, hashCode, toString

Methods inherited from interface org.jooq.Attachable

attach, configuration, detach

Method Detail

fetch

@Support(value={AURORA_POSTGRES,DB2,FIREBIRD,ORACLE,POSTGRES})
Result<R> fetch()
                                                                         throws DataAccessException

The result holding returned values as specified by the UpdateReturningStep.

Returns:

The returned values as specified by the UpdateReturningStep. Note:

• Not all databases / JDBC drivers support returning several values on multi-row inserts!
• This may return an empty Result in case jOOQ could not retrieve any generated keys from the JDBC driver.

Throws:

DataAccessException - if something went wrong executing the query

See Also:

UpdateQuery.getReturnedRecords()

fetchOne

@Support(value={AURORA_POSTGRES,DB2,FIREBIRD,ORACLE,POSTGRES})
R fetchOne()
                                                                    throws DataAccessException,
                                                                           TooManyRowsException

The record holding returned values as specified by the UpdateReturningStep.

Returns:

The returned value as specified by the UpdateReturningStep. This may return null in case jOOQ could not retrieve any generated keys from the JDBC driver.

Throws:

DataAccessException - if something went wrong executing the query

TooManyRowsException - if the query returned more than one record

See Also:

UpdateQuery.getReturnedRecord()

fetchOptional

@Support(value={AURORA_POSTGRES,DB2,FIREBIRD,ORACLE,POSTGRES})
Optional<R> fetchOptional()
                                                                                   throws DataAccessException,
                                                                                          TooManyRowsException

The record holding returned values as specified by the UpdateReturningStep.

Returns:

The returned value as specified by the UpdateReturningStep.

Throws:

DataAccessException - if something went wrong executing the query

TooManyRowsException - if the query returned more than one record

See Also:

UpdateQuery.getReturnedRecord()