org.jooq.StoreQuery Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
import java.util.Collection;
import java.util.Map;
/**
* A query storing objects to the database. This is either an insert or an
* update query.
*
* @param The record type of the table being modified
* @author Lukas Eder
*/
public interface StoreQuery extends Query {
/**
* Add values to the store statement
*
* @param record The record holding values that are stored by the query
*/
@Support
void setRecord(R record);
/**
* Add a value to the store statement
*
* @param field The field
* @param value The value
*/
@Support
void addValue(Field field, T value);
/**
* Add a value to the store statement
*
* @param field The field
* @param value The value. If value is null, this results in
* calling {@link #addValue(Field, Object)} with null as a value.
*/
@Support
void addValue(Field field, Field value);
/**
* Add multiple values to the store statement.
*
* Values can either be of type <T> or
* Field<T>. jOOQ will attempt to convert values to their
* corresponding field's type.
*/
@Support
void addValues(Map, ?> map);
/**
* Configure the INSERT or UPDATE statement to return all fields in
* R.
*
* @see #getReturnedRecords()
*/
@Support
void setReturning();
/**
* Configure the INSERT or UPDATE statement to return the generated
* identity value.
*
* @param identity The table's identity
* @see #getReturnedRecords()
*/
@Support
void setReturning(Identity identity);
/**
* Configure the INSERT or UPDATE statement to return a list of fields in
* R.
*
* @param fields Fields to be returned
* @see #getReturnedRecords()
*/
@Support
void setReturning(Field... fields);
/**
* Configure the INSERT or UPDATE statement to return a list of fields in
* R.
*
* @param fields Fields to be returned
* @see #getReturnedRecords()
*/
@Support
void setReturning(Collection> fields);
/**
* The record holding returned values as specified by any of the
* {@link #setReturning()} methods.
*
* If the insert statement returns several records, this is the same as
* calling getReturnedRecords().get(0)
*
* This implemented differently for every dialect:
*
* - Firebird and Postgres have native support for
*
INSERT .. RETURNING and UPDATE .. RETURNING
* clauses
* - HSQLDB, Oracle, and DB2 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.
*
*
* @return The returned value as specified by any of the
* {@link #setReturning()} methods. This may return
* null in case jOOQ could not retrieve any generated
* keys from the JDBC driver.
* @see #getReturnedRecords()
*/
@Support
R getReturnedRecord();
/**
* The records holding returned values as specified by any of the
* {@link #setReturning()} methods.
*
* This implemented differently for every dialect:
*
* - Firebird and Postgres have native support for
*
INSERT .. RETURNING and UPDATE .. RETURNING
* clauses
* - HSQLDB, Oracle, and DB2 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.
*
*
* @return The returned values as specified by any of the
* {@link #setReturning()} methods. 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.
*
*/
@Support
Result getReturnedRecords();
}