org.jooq.InsertResultStep Maven / Gradle / Ivy
/*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* ASL 2.0 and offer limited warranties, support, maintenance, and commercial
* database integrations.
*
* For more information, please visit: http://www.jooq.org/licenses
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import java.util.Optional;
import org.jooq.exception.DataAccessException;
import org.jooq.exception.TooManyRowsException;
/**
* This type is used for the {@link 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
*/
public interface InsertResultStep extends Insert {
/**
* The result holding returned values as specified by the
* {@link InsertReturningStep}.
*
* @return The returned values as specified by the
* {@link 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 InsertQuery#getReturnedRecords()
*/
@Support
Result fetch() throws DataAccessException;
/**
* The record holding returned values as specified by the
* {@link InsertReturningStep}.
*
* @return The returned value as specified by the
* {@link 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
* @throws TooManyRowsException if the query returned more than one record
* @see InsertQuery#getReturnedRecord()
*/
@Support
R fetchOne() throws DataAccessException, TooManyRowsException;
/**
* The record holding returned values as specified by the
* {@link InsertReturningStep}.
*
* @return The returned value as specified by the
* {@link InsertReturningStep}
* @throws DataAccessException if something went wrong executing the query
* @throws TooManyRowsException if the query returned more than one record
* @see InsertQuery#getReturnedRecord()
*/
@Support
Optional fetchOptional() throws DataAccessException, TooManyRowsException;
}