org.jooq.InsertValuesStep1 Maven / Gradle / Ivy
/*
* 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
*
* https://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
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq;
import java.util.Collection;
import java.util.function.Function;
import org.jetbrains.annotations.NotNull;
/**
* This type is used for the {@link Insert}'s DSL API.
*
* Example:
* using(configuration)
* .insertInto(table, field1)
* .values(field1)
* .values(field1)
* .onDuplicateKeyUpdate()
* .set(field1, value1)
* .set(field2, value2)
* .execute();
*
*
* @author Lukas Eder
*/
public interface InsertValuesStep1 extends InsertOnDuplicateStep {
/**
* Add a single row of values to the insert statement.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 values(T1 value1);
/**
* Add a single row of values to the insert statement.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 values(Field value1);
/**
* Add a single row of values to the insert statement.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 values(Collection values);
/**
* Add a single row of values to the insert statement.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 values(Row1 values);
/**
* Add a single row of values to the insert statement.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 values(Record1 values);
/**
* Add multiple rows of values to the insert statement.
*
* This is equivalent to calling the other values clauses multiple times, but
* allows for dynamic construction of row arrays.
*
* @see Rows#toRowArray(Function)
*/
@NotNull @CheckReturnValue
@Support
@SuppressWarnings("unchecked")
InsertValuesStep1 valuesOfRows(Row1... values);
/**
* Add multiple rows of values to the insert statement.
*
* This is equivalent to calling the other values clauses multiple times, but
* allows for dynamic construction of row arrays.
*
* @see Rows#toRowList(Function)
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 valuesOfRows(Collection> values);
/**
* Add multiple rows of values to the insert statement.
*
* This is equivalent to calling the other values clauses multiple times, but
* allows for dynamic construction of row arrays.
*
* Note: Irrespective of individual {@link Record#changed()}
* flag values, all record values are copied to the VALUES clause
* using {@link Record#intoArray()}, to match insert columns by position, not
* by name. If you prefer omitting unchanged values and adding values by field
* name rather than by index, use {@link InsertSetStep#set(Record...)} instead.
* That syntax is available only if you omit the explicit insert columns list.
*/
@NotNull @CheckReturnValue
@Support
@SuppressWarnings("unchecked")
InsertValuesStep1 valuesOfRecords(Record1... values);
/**
* Add multiple rows of values to the insert statement.
*
* This is equivalent to calling the other values clauses multiple times, but
* allows for dynamic construction of row arrays.
*
* Note: Irrespective of individual {@link Record#changed()}
* flag values, all record values are copied to the VALUES clause
* using {@link Record#intoArray()}, to match insert columns by position, not
* by name. If you prefer omitting unchanged values and adding values by field
* name rather than by index, use {@link InsertSetStep#set(Record...)} instead.
* That syntax is available only if you omit the explicit insert columns list.
*/
@NotNull @CheckReturnValue
@Support
InsertValuesStep1 valuesOfRecords(Collection> values);
/**
* Use a SELECT statement as the source of values for the
* INSERT statement
*
* This variant of the INSERT … SELECT statement expects a
* select returning exactly as many fields as specified previously in the
* INTO clause:
* {@link DSLContext#insertInto(Table, Field)}
*/
@NotNull @CheckReturnValue
@Support
InsertOnDuplicateStep select(Select> select);
}