org.jooq.UpdateResultStep 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 static org.jooq.SQLDialect.FIREBIRD;
import static org.jooq.SQLDialect.POSTGRES;
import org.jooq.exception.DataAccessException;
/**
* This type is used for the {@link Update}'s DSL API.
*
* Example:
* DSLContext create = DSL.using(configuration);
*
* TableRecord record =
* create.update(table)
* .set(field1, value1)
* .set(field2, value2)
* .returning(field1)
* .fetchOne();
*
* This implemented differently for every dialect:
*
* - Firebird and Postgres have native support for
*
UPDATE .. RETURNING clauses
*
*
* @author Lukas Eder
*/
public interface UpdateResultStep extends Insert {
/**
* The result holding returned values as specified by the
* {@link UpdateReturningStep}
*
* This currently only works well for DB2, HSQLDB, MySQL, and Postgres
*
* @return The returned values as specified by the
* {@link UpdateReturningStep}. 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 UpdateQuery#getReturnedRecords()
*/
@Support({ FIREBIRD, POSTGRES })
Result fetch() throws DataAccessException;
/**
* The record holding returned values as specified by the
* {@link UpdateReturningStep}
*
* @return The returned value as specified by the
* {@link UpdateReturningStep}. 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
* @see UpdateQuery#getReturnedRecord()
*/
@Support({ FIREBIRD, POSTGRES })
R fetchOne() throws DataAccessException;
}