org.jooq.MergeMatchedSetStep Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
There is a newer version: 3.19.9
/*
 * 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 static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.FIREBIRD_3_0;
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
// ...

import java.util.Map;

/**
 * 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();
 * 
 *
 * @author Lukas Eder
 */
public interface MergeMatchedSetStep {

    /**
     * Set values for UPDATE in the MERGE statement's
     * WHEN MATCHED clause.
     */
    @Support({ CUBRID, FIREBIRD_3_0, HSQLDB })
     MergeMatchedSetMoreStep set(Field field, T value);

    /**
     * Set values for UPDATE in the MERGE statement's
     * WHEN MATCHED clause.
     */
    @Support({ CUBRID, FIREBIRD_3_0, HSQLDB })
     MergeMatchedSetMoreStep set(Field field, Field value);

    /**
     * Set values for UPDATE in the MERGE statement's
     * WHEN MATCHED clause.
     */
    @Support({ CUBRID, FIREBIRD_3_0, HSQLDB })
     MergeMatchedSetMoreStep set(Field field, Select> value);

    /**
     * Set multiple values for UPDATE in the MERGE
     * statement's WHEN MATCHED 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.
     */
    @Support({ CUBRID, FIREBIRD_3_0, HSQLDB })
    MergeMatchedSetMoreStep set(Map map);

    /**
     * Set multiple values for UPDATE in the MERGE
     * statement's WHEN MATCHED clause.
     * 
     * This is the same as calling {@link #set(Map)} with the argument record
     * treated as a Map<Field<?>, Object>, except that the
     * {@link Record#changed()} flags are taken into consideration in order to
     * update only changed values.
     *
     * @see #set(Map)
     */
    @Support({ CUBRID, FIREBIRD_3_0, HSQLDB })
    MergeMatchedSetMoreStep set(Record record);
}