org.jooq

Interface InsertResultStep<R extends Record>

All Superinterfaces:

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

public interface InsertResultStep<R extends Record>
extends Insert<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:

• 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, another statement is issued. Client code must assure transactional integrity between these statements.

Author:

Lukas Eder

Method Summary

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

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
Result<R> fetch()
                   throws DataAccessException

The result holding returned values as specified by the InsertReturningStep.

Returns:

The returned values as specified by the InsertReturningStep. 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:

InsertQuery.getReturnedRecords()

fetchOne

@Support
R fetchOne()
              throws DataAccessException,
                     TooManyRowsException

The record holding returned values as specified by the InsertReturningStep.

Returns:

The returned value as specified by the InsertReturningStep. 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:

InsertQuery.getReturnedRecord()

fetchOptional

@Support
java.util.Optional<R> fetchOptional()
                                       throws DataAccessException,
                                              TooManyRowsException

The record holding returned values as specified by the InsertReturningStep.

Returns:

The returned value as specified by the InsertReturningStep

Throws:

DataAccessException - if something went wrong executing the query

TooManyRowsException - if the query returned more than one record

See Also:

InsertQuery.getReturnedRecord()