Module org.jooq
Package org.jooq

Interface UpdateReturningStep<R extends Record>

  • All Superinterfaces:
    Attachable, AutoCloseable, Flow.Publisher<Integer>, org.reactivestreams.Publisher<Integer>, Query, QueryPart, RowCountQuery, Serializable, Statement, Update<R>, UpdateFinalStep<R>
    All Known Subinterfaces:
    UpdateConditionStep<R>, UpdateFromStep<R>, UpdateLimitStep<R>, UpdateOrderByStep<R>, UpdateSetMoreStep<R>, UpdateWhereStep<R>
    public interface UpdateReturningStep<R extends Record>
extends UpdateFinalStep<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