/*
 * 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;

import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

This type is used for the 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.


Referencing XYZ*Step types directly from client code

It is usually not recommended to reference any XYZ*Step types
directly from client code, or assign them to local variables. When writing
dynamic SQL, creating a statement's components dynamically, and passing them
to the DSL API statically is usually a better choice. See the manual's
section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.

Drawbacks of referencing the XYZ*Step types directly:

They're operating on mutable implementations (as of jOOQ 3.x)
They're less composable and not easy to get right when dynamic SQL gets
complex
They're less readable
They might have binary incompatible changes between minor releases

Author:
Lukas Eder/**
 * This type is used for the {@link Insert}'s DSL API.
 * <p>
 * Example: <code><pre>
 * DSLContext create = DSL.using(configuration);
 *
 * TableRecord&lt;?&gt; record =
 * create.insertInto(table, field1, field2)
 *       .values(value1, value2)
 *       .returning(field1)
 *       .fetchOne();
 * </pre></code>
 * <p>
 * This implemented differently for every dialect:
 * <ul>
 * <li>DB2 allows to execute
 * <code>SELECT .. FROM FINAL TABLE (INSERT ...)</code></li>
 * <li>HSQLDB, and Oracle JDBC drivers allow for retrieving any table column as
 * "generated key" in one statement</li>
 * <li>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.</li>
 * <li>Sybase and SQLite allow for retrieving IDENTITY values as
 * <code>@@identity</code> or <code>last_inserted_rowid()</code> values. Those
 * values are fetched in a separate <code>SELECT</code> statement. If other
 * fields are requested, another statement is issued. Client code must assure
 * transactional integrity between these statements.</li>
 * </ul>
 * <p>
 * <h3>Referencing <code>XYZ*Step</code> types directly from client code</h3>
 * <p>
 * It is usually not recommended to reference any <code>XYZ*Step</code> types
 * directly from client code, or assign them to local variables. When writing
 * dynamic SQL, creating a statement's components dynamically, and passing them
 * to the DSL API statically is usually a better choice. See the manual's
 * section about dynamic SQL for details: <a href=
 * "https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql">https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql</a>.
 * <p>
 * Drawbacks of referencing the <code>XYZ*Step</code> types directly:
 * <ul>
 * <li>They're operating on mutable implementations (as of jOOQ 3.x)</li>
 * <li>They're less composable and not easy to get right when dynamic SQL gets
 * complex</li>
 * <li>They're less readable</li>
 * <li>They might have binary incompatible changes between minor releases</li>
 * </ul>
 *
 * @author Lukas Eder
 */
public interface InsertResultStep<R extends Record> extends Insert<R> {

    
The result holding returned values as specified by the InsertReturningStep. 
Throws:
DataAccessException – if something went wrong executing the query
See Also:
InsertQuery.getReturnedRecords()
Returns:
The returned values as specified by the 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.
        /**
     * The result holding returned values as specified by the
     * {@link InsertReturningStep}.
     *
     * @return The returned values as specified by the
     *         {@link InsertReturningStep}. Note:
     *         <ul>
     *         <li>Not all databases / JDBC drivers support returning several
     *         values on multi-row inserts!</li><li>This may return an empty
     *         <code>Result</code> in case jOOQ could not retrieve any generated
     *         keys from the JDBC driver.</li>
     *         </ul>
     * @throws DataAccessException if something went wrong executing the query
     * @see InsertQuery#getReturnedRecords()
     */
    @NotNull
    @Support
    Result<R> fetch() throws DataAccessException;

    
The record holding returned values as specified by the InsertReturningStep. 
Throws:
DataAccessException – if something went wrong executing the query
TooManyRowsException – if the query returned more than one record
See Also:
InsertQuery.getReturnedRecord()
Returns:
The returned value as specified by the InsertReturningStep. This may return null in
        case jOOQ could not retrieve any generated keys from the JDBC
        driver./**
     * The record holding returned values as specified by the
     * {@link InsertReturningStep}.
     *
     * @return The returned value as specified by the
     *         {@link InsertReturningStep}. This may return <code>null</code> 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()
     */
    @Nullable
    @Support
    R fetchOne() throws DataAccessException, TooManyRowsException;


    
The record holding returned values as specified by the InsertReturningStep. 
Throws:
DataAccessException – if something went wrong executing the query
TooManyRowsException – if the query returned more than one record
See Also:
InsertQuery.getReturnedRecord()
Returns:
The returned value as specified by the InsertReturningStep/**
     * 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()
     */
    @NotNull
    @Support
    Optional<R> fetchOptional() throws DataAccessException, TooManyRowsException;

}