org.jooq.InsertOnDuplicateSetStep 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
*
* 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
* Apache-2.0 license 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.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
// ...
import static org.jooq.SQLDialect.FIREBIRD;
import static org.jooq.SQLDialect.H2;
// ...
import static org.jooq.SQLDialect.HSQLDB;
// ...
import static org.jooq.SQLDialect.MARIADB;
// ...
import static org.jooq.SQLDialect.MYSQL;
// ...
import static org.jooq.SQLDialect.POSTGRES;
// ...
import static org.jooq.SQLDialect.SQLITE;
// ...
// ...
// ...
import static org.jooq.SQLDialect.YUGABYTEDB;
import java.util.Map;
import org.jooq.impl.DSL;
import org.jetbrains.annotations.NotNull;
/**
* This type is used for the {@link Insert}'s DSL API.
*
* Example:
* DSLContext create = DSL.using(configuration);
*
* create.insertInto(table, field1, field2)
* .values(value1, value2)
* .values(value3, value4)
* .onDuplicateKeyUpdate()
* .set(field1, value1)
* .set(field2, value2)
* .execute();
*
*
*
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
*/
public interface InsertOnDuplicateSetStep {
/**
* Set values for UPDATE in the INSERT statement's
* ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep set(Field field, T value);
/**
* Set values for UPDATE in the INSERT statement's
* ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep set(Field field, Field value);
/**
* Set values for UPDATE in the INSERT statement's
* ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep set(Field field, Select> value);
/**
* Set a null value for UPDATE in the
* INSERT statement's ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*
* This method is convenience for calling {@link #set(Field, Object)},
* without the necessity of casting the Java null literal to
* (T).
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep setNull(Field field);
/**
* Set multiple values for UPDATE in the INSERT
* statement's ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*
* Keys can either be of type {@link String}, {@link Name}, or
* {@link Field}.
*
* Values can either be of type <T> or
* Field<T>. jOOQ will attempt to convert values to their
* corresponding field's type.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep set(Map map);
/**
* Set multiple values for UPDATE in the INSERT
* statement's ON DUPLICATE KEY UPDATE or
* ON CONFLICT … DO UPDATE clause.
*
* This is the same as calling {@link #set(Map)} with the argument record
* treated as a Map<Field<?>, Object>.
*
* @see #set(Map)
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep set(Record record);
/**
* Sets all columns from the insert column list to
* {@link DSL#excluded(Field)}.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetMoreStep setAllToExcluded();
}