org.jooq

Interface InsertReturningStep<R extends Record>

All Superinterfaces:

Attachable, java.lang.AutoCloseable, Insert<R>, InsertFinalStep<R>, Query, QueryPart, java.io.Serializable

All Known Subinterfaces:

InsertOnConflictWhereStep<R>, InsertOnDuplicateSetMoreStep<R>, InsertOnDuplicateStep<R>, InsertSetMoreStep<R>, InsertValuesStep1<R,T1>, InsertValuesStep10<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10>, InsertValuesStep11<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11>, InsertValuesStep12<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12>, InsertValuesStep13<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13>, InsertValuesStep14<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14>, InsertValuesStep15<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15>, InsertValuesStep16<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16>, InsertValuesStep17<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17>, InsertValuesStep18<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18>, InsertValuesStep19<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19>, InsertValuesStep2<R,T1,T2>, InsertValuesStep20<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20>, InsertValuesStep21<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21>, InsertValuesStep22<R,T1,T2,T3,T4,T5,T6,T7,T8,T9,T10,T11,T12,T13,T14,T15,T16,T17,T18,T19,T20,T21,T22>, InsertValuesStep3<R,T1,T2,T3>, InsertValuesStep4<R,T1,T2,T3,T4>, InsertValuesStep5<R,T1,T2,T3,T4,T5>, InsertValuesStep6<R,T1,T2,T3,T4,T5,T6>, InsertValuesStep7<R,T1,T2,T3,T4,T5,T6,T7>, InsertValuesStep8<R,T1,T2,T3,T4,T5,T6,T7,T8>, InsertValuesStep9<R,T1,T2,T3,T4,T5,T6,T7,T8,T9>, InsertValuesStepN<R>

public interface InsertReturningStep<R extends Record>
extends InsertFinalStep<R>

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

Example:

 DSLContext create = DSL.using(configuration);

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

This implemented differently for every dialect:

• Firebird and Postgres have native support for INSERT .. RETURNING clauses
• DB2 allows to execute SELECT .. FROM FINAL TABLE (INSERT ...)
• HSQLDB, and Oracle JDBC drivers allow for retrieving any table column as "generated key" in one statement
• Derby, H2, Ingres, MySQL, SQL Server only allow for retrieving IDENTITY column values as "generated key". If other fields are requested, a second statement is issued. Client code must assure transactional integrity between the two statements.
• Sybase and SQLite allow for retrieving IDENTITY values as @@identity or last_inserted_rowid() values. Those values are fetched in a separate SELECT statement. If other fields are requested, a second statement is issued. Client code must assure transactional integrity between the two statements.

Author:

Lukas Eder

Method Summary

Modifier and Type	Method and Description
InsertResultStep<R>	returning() Configure the INSERT statement to return all fields in R.
InsertResultStep<R>	returning(java.util.Collection<? extends Field<?>> fields) Configure the INSERT statement to return a list of fields in R.
InsertResultStep<R>	returning(Field<?>... fields) Configure the INSERT statement to return a list of fields in R.

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

returning

@Support
InsertResultStep<R> returning()

Configure the INSERT statement to return all fields in R.

See Also:

InsertResultStep

returning

@Support
InsertResultStep<R> returning(Field<?>... fields)

Configure the INSERT statement to return a list of fields in R.

Parameters:

fields - Fields to be returned

See Also:

InsertResultStep

returning

@Support
InsertResultStep<R> returning(java.util.Collection<? extends Field<?>> fields)

Configure the INSERT statement to return a list of fields in R.

Parameters:

fields - Fields to be returned

See Also:

InsertResultStep