org.jooq.InsertOnDuplicateStep Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* 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.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq;
import static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.HSQLDB;
// ...
import static org.jooq.SQLDialect.MARIADB;
import static org.jooq.SQLDialect.MYSQL;
// ...
// ...
// ...
/**
* 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();
*
extends InsertReturningStep {
/**
* Add an ON DUPLICATE KEY UPDATE clause to this insert query.
*
* 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 and CUBRID natively implements this type of clause. jOOQ can
* simulate this clause using a MERGE statement on some other
* databases. The conditions for a RDBMS to simulate 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)}).
*
*
* These are the dialects that fulfill the above requirements:
*/
@Support({ CUBRID, HSQLDB, MARIADB, MYSQL })
InsertOnDuplicateSetStep onDuplicateKeyUpdate();
/**
* Add an ON DUPLICATE KEY IGNORE clause to this insert query.
*
* 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 simulated as such:
*
*
* Dialect
* Simulation
*
*
* {@link SQLDialect#MARIADB}
* INSERT IGNORE INTO ..
*
*
* {@link SQLDialect#MYSQL}
* INSERT IGNORE INTO ..
*
*
* {@link SQLDialect#CUBRID}
*
* INSERT INTO .. ON DUPLICATE KEY UPDATE [any-field] = [any-field]
*
*
* {@link SQLDialect#DB2}
* {@link SQLDialect#HSQLDB}
* {@link SQLDialect#ORACLE}
* {@link SQLDialect#SQLSERVER}
* {@link SQLDialect#SYBASE}
* MERGE INTO [dst]
* USING ([values]) src
* ON [dst.key] = [src.key]
* WHEN NOT MATCHED THEN INSERT ..
*
*/
@Support({ CUBRID, HSQLDB, MARIADB, MYSQL })
InsertFinalStep onDuplicateKeyIgnore();
}