/*
 * 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
 * ASL 2.0 and offer limited warranties, support, maintenance, and commercial
 * database integrations.
 *
 * For more information, please visit: http://www.jooq.org/licenses
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jetbrains.annotations.*;


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 java.util.Map;

This type is used for the 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
/** * This type is used for the {@link Merge}'s DSL API. * <p> * Example: <code><pre> * 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(); * </pre></code> * <p> * <h3>Referencing <code>XYZ*Step</code> types directly from client code</h3> * <p> * It is usually not recommended to reference any <code>XYZ*Step</code> 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: <a href= * "https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql">https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql</a>. * <p> * Drawbacks of referencing the <code>XYZ*Step</code> types directly: * <ul> * <li>They're operating on mutable implementations (as of jOOQ 3.x)</li> * <li>They're less composable and not easy to get right when dynamic SQL gets * complex</li> * <li>They're less readable</li> * <li>They might have binary incompatible changes between minor releases</li> * </ul> * * @author Lukas Eder */
public interface MergeNotMatchedSetStep<R extends Record> {
Set values for INSERT in the MERGE statement's WHEN NOT MATCHED clause.
/** * Set values for <code>INSERT</code> in the <code>MERGE</code> statement's * <code>WHEN NOT MATCHED</code> clause. */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) <T> MergeNotMatchedSetMoreStep<R> set(Field<T> field, T value);
Set values for INSERT in the MERGE statement's WHEN NOT MATCHED clause.
/** * Set values for <code>INSERT</code> in the <code>MERGE</code> statement's * <code>WHEN NOT MATCHED</INSERT> clause. */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) <T> MergeNotMatchedSetMoreStep<R> set(Field<T> field, Field<T> value);
Set values for INSERT in the MERGE statement's WHEN NOT MATCHED clause.
/** * Set values for <code>INSERT</code> in the <code>MERGE</code> statement's * <code>WHEN NOT MATCHED</INSERT> clause. */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) <T> MergeNotMatchedSetMoreStep<R> set(Field<T> field, Select<? extends Record1<T>> value);
Set a null value for INSERT in the MERGE statement's WHEN NOT MATCHED clause.

This method is convenience for calling set(Field, Object), without the necessity of casting the Java null literal to (T).

/** * Set a <code>null</code> value for <code>INSERT</code> in the * <code>MERGE</code> statement's <code>WHEN NOT MATCHED</INSERT> clause. * <p> * This method is convenience for calling {@link #set(Field, Object)}, * without the necessity of casting the Java <code>null</code> literal to * <code>(T)</code>. */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) <T> MergeNotMatchedSetMoreStep<R> setNull(Field<T> field);
Set multiple values for INSERT in the MERGE statement's WHEN NOT MATCHED clause.

Keys can either be of type String, Name, or Field.

Values can either be of type <T> or Field<T>. jOOQ will attempt to convert values to their corresponding field's type.

/** * Set multiple values for <code>INSERT</code> in the <code>MERGE</code> * statement's <code>WHEN NOT MATCHED</code> clause. * <p> * Keys can either be of type {@link String}, {@link Name}, or * {@link Field}. * <p> * Values can either be of type <code>&lt;T&gt;</code> or * <code>Field&lt;T&gt;</code>. jOOQ will attempt to convert values to their * corresponding field's type. */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) MergeNotMatchedSetMoreStep<R> set(Map<?, ?> map);
Set multiple values for INSERT in the MERGE statement's WHEN NOT MATCHED clause.

This is the same as calling set(Map) with the argument record treated as a Map<Field<?>, Object>.

See Also:
/** * Set multiple values for <code>INSERT</code> in the <code>MERGE</code> * statement's <code>WHEN NOT MATCHED</code> clause. * <p> * This is the same as calling {@link #set(Map)} with the argument record * treated as a <code>Map&lt;Field&lt;?&gt;, Object&gt;</code>. * * @see #set(Map) */
@NotNull @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB }) MergeNotMatchedSetMoreStep<R> set(Record record); }