org.jooq.InsertReturningStep Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* 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.Collection;
/**
* 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:
*
* - 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
*/
public interface InsertReturningStep extends InsertFinalStep {
/**
* Configure the INSERT statement to return all fields in
* R.
*
* @see InsertResultStep
*/
@Support
InsertResultStep returning();
/**
* Configure the INSERT statement to return a list of fields in
* R.
*
* @param fields Fields to be returned
* @see InsertResultStep
*/
@Support
InsertResultStep returning(Field... fields);
/**
* Configure the INSERT statement to return a list of fields in
* R.
*
* @param fields Fields to be returned
* @see InsertResultStep
*/
@Support
InsertResultStep returning(Collection> fields);
}