/*
* 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 static org.jooq.SQLDialect.FIREBIRD;
// ...
import static org.jooq.SQLDialect.POSTGRES;
import java.util.Collection;
/**
* This type is used for the {@link Update}'s DSL API.
* <p>
* Example: <code><pre>
* DSLContext create = DSL.using(configuration);
*
* TableRecord<?> record =
* create.update(table)
* .set(field1, value1)
* .set(field2, value2)
* .returning(field1)
* .fetchOne();
* </pre></code>
* <p>
* This implemented differently for every dialect:
* <ul>
* <li>Firebird and Postgres have native support for
* <code>UPDATE .. RETURNING</code> clauses</li>
* <li>DB2 allows to execute
* <code>SELECT .. FROM FINAL TABLE (UPDATE ...)</code></li>
* </ul>
*
* @author Lukas Eder
*/
public interface UpdateReturningStep<R extends Record> extends UpdateFinalStep<R> {
/**
* Configure the <code>UPDATE</code> statement to return all fields in
* <code>R</code>.
*
* @see UpdateResultStep
*/
@Support({ FIREBIRD, POSTGRES })
UpdateResultStep<R> returning();
/**
* Configure the <code>UPDATE</code> statement to return a list of fields in
* <code>R</code>.
*
* @param fields Fields to be returned
* @see UpdateResultStep
*/
@Support({ FIREBIRD, POSTGRES })
UpdateResultStep<R> returning(Field<?>... fields);
/**
* Configure the <code>UPDATE</code> statement to return a list of fields in
* <code>R</code>.
*
* @param fields Fields to be returned
* @see UpdateResultStep
*/
@Support({ FIREBIRD, POSTGRES })
UpdateResultStep<R> returning(Collection<? extends Field<?>> fields);
}