org.jooq.InsertOnDuplicateStep 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 static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
import static org.jooq.SQLDialect.DUCKDB;
// ...
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.Collection;
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 InsertOnDuplicateStep extends InsertReturningStep {
/**
* Add a ON CONFLICT ON CONSTRAINT clause to this INSERT statement.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, DUCKDB, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
InsertOnConflictDoUpdateStep onConflictOnConstraint(Constraint constraint);
/**
* Add a ON CONFLICT ON CONSTRAINT clause to this INSERT statement.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, DUCKDB, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
InsertOnConflictDoUpdateStep onConflictOnConstraint(Name constraint);
/**
* Add a ON CONFLICT ON CONSTRAINT clause to this INSERT statement.
*/
@NotNull @CheckReturnValue
@Support
InsertOnConflictDoUpdateStep onConflictOnConstraint(UniqueKey constraint);
/**
* Add an ON CONFLICT clause to this INSERT statement.
*
* Only {@link SQLDialect#POSTGRES} and {@link SQLDialect#SQLITE} have
* native support for this clause. The other dialects can emulate it using
* MERGE, if table meta data is available.
*/
@NotNull @CheckReturnValue
@Support
InsertOnConflictWhereIndexPredicateStep onConflict(Field... keys);
/**
* Add an ON CONFLICT clause to this INSERT statement.
*
* Only {@link SQLDialect#POSTGRES} and {@link SQLDialect#SQLITE} have
* native support for this clause. The other dialects can emulate it using
* MERGE, if table meta data is available.
*/
@NotNull @CheckReturnValue
@Support
InsertOnConflictWhereIndexPredicateStep onConflict(Collection> keys);
/**
* Add an ON CONFLICT DO NOTHING clause to this INSERT statement.
*
* Only {@link SQLDialect#POSTGRES} and {@link SQLDialect#SQLITE} have
* native support for this clause. The other dialects can emulate it using
* MERGE, if table meta data is available.
*/
@NotNull @CheckReturnValue
@Support
InsertReturningStep onConflictDoNothing();
/**
* Add an ON DUPLICATE KEY UPDATE clause to this INSERT statement.
*
* This will try to INSERT a record. If there is a primary key
* or unique key in this INSERT statement's affected table that
* matches the value being inserted, then the UPDATE clause is
* executed instead.
*
* MySQL natively implements this type of clause. jOOQ can
* emulate this clause using a MERGE statement on some other
* databases. The conditions for a RDBMS to emulate this clause are:
*
* - The
INSERT statement's table is a
* {@link Table} with a {@link Table#getPrimaryKey()}
* - The RDBMS supports the
MERGE clause (see
* {@link DSLContext#mergeInto(Table)}).
*
*
* H2 supports this clause in MySQL mode.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, DUCKDB, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
InsertOnDuplicateSetStep onDuplicateKeyUpdate();
/**
* Add an ON DUPLICATE KEY IGNORE clause to this INSERT statement.
*
* This will try to INSERT a record. If there is a primary key
* or unique key in this INSERT statement's affected table that
* matches the value being inserted, then the INSERT statement
* is ignored.
*
* This clause is not actually supported in this form by any database, but
* can be emulated as such:
*
*
* Dialect
* Emulation
*
*
* {@link SQLDialect#MYSQL} and {@link SQLDialect#MARIADB}
* INSERT IGNORE INTO …
*
* {@link SQLDialect#POSTGRES_9_5} and {@link SQLDialect#SQLITE}
* INSERT INTO … ON CONFLICT DO NOTHING
*
* {@link SQLDialect#DB2}
* {@link SQLDialect#HSQLDB}
* {@link SQLDialect#ORACLE}
* {@link SQLDialect#SQLSERVER}
* {@link SQLDialect#SYBASE}
* MERGE INTO [dst]
* USING ([values])
* ON [dst.key] = [values.key]
* WHEN NOT MATCHED THEN INSERT ..
*
* All the others
* INSERT INTO [dst] ( ... )
* SELECT [values]
* WHERE NOT EXISTS (
* SELECT 1
* FROM [dst]
* WHERE [dst.key] = [values.key]
* )
*
*/
@NotNull @CheckReturnValue
@Support
InsertReturningStep onDuplicateKeyIgnore();
}