org.jooq.MergeUsingStep 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.YUGABYTEDB;
import java.util.Collection;
import org.jetbrains.annotations.NotNull;
/**
* This type is used for the {@link Merge}'s DSL API.
*
* Example:
* DSLContext create = DSL.using(configuration);
*
* create.mergeInto(table)
* .using(select)
* .on(condition)
* .whenMatchedThenUpdate()
* .set(field1, value1)
* .set(field2, value2)
* .whenNotMatchedThenInsert(field1, field2)
* .values(value1, 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 MergeUsingStep extends MergeKeyStepN {
/**
* Add the USING clause to the SQL standard MERGE
* statement.
*
* Note that {@link SQLDialect#DERBY} supports this clause only with
* ordinary table references, not with derived tables.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB })
MergeOnStep using(TableLike table);
/**
* Add a dummy USING clause to the SQL standard
* MERGE statement
*
* This results in USING(SELECT 1 FROM DUAL) for most RDBMS, or
* in USING(SELECT 1) AS [dummy_table(dummy_field)] in SQL
* Server, where derived tables need to be aliased.
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB })
MergeOnStep usingDual();
/**
* Set the columns for merge (H2-specific syntax).
*
* This statement is available from DSL syntax only. It is known to be
* supported in some way by any of these dialects:
*
*
* H2
* H2 natively supports this special syntax
* https://www.h2database.com/html/commands.html#merge_into
*
*
* HANA
* HANA natively supports this syntax
* http://help.sap.com/saphelp_hanaplatform/helpdata/en/20/fc06a7751910149892c0d09be21a38/content.htm
*
*
* PostgreSQL
* This database can emulate the H2-specific MERGE statement via
* INSERT … ON CONFLICT DO UPDATE
* http://www.postgresql.org/docs/9.5/static/sql-insert.html
*
*
* DB2, Firebird, HSQLDB, Oracle, SQL Server, Sybase SQL Anywhere
* These databases can emulate the H2-specific MERGE statement using a
* standard SQL MERGE statement, without restrictions
* See {@link DSLContext#mergeInto(Table)} for the standard MERGE statement
*
*
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@Deprecated(forRemoval = true, since = "3.14")
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
MergeKeyStepN columns(Field... fields);
/**
* Set the columns for merge (H2-specific syntax).
*
* @see #columns(Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@Deprecated(forRemoval = true, since = "3.14")
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
MergeKeyStepN columns(Collection> fields);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep1 columns(Field field1);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep2 columns(Field field1, Field field2);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep3 columns(Field field1, Field field2, Field field3);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep4 columns(Field field1, Field field2, Field field3, Field field4);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep5 columns(Field field1, Field field2, Field field3, Field field4, Field field5);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep6 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep7 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep8 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep9 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep10 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep11 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep12 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep13 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep14 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep15 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep16 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep17 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep18 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep19 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field field12, Field field13, Field field14, Field field15, Field field16, Field field17, Field field18, Field field19);
/**
* Create a new DSL UPSERT statement ({@link SQLDialect#H2}
* MERGE) or {@link SQLDialect#HANA} UPSERT).
*
* @see DSLContext#mergeInto(Table, Field...)
* @deprecated - [#10045] - 3.14.0 - Use the standard SQL MERGE API instead, via {@link DSLContext#mergeInto(Table)}
*/
@NotNull @CheckReturnValue
@Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, YUGABYTEDB })
@Deprecated(forRemoval = true, since = "3.14")
MergeKeyStep20 columns(Field field1, Field field2, Field field3, Field field4, Field field5, Field field6, Field field7, Field field8, Field field9, Field field10, Field field11, Field