/*
 * 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.POSTGRES;
import static org.jooq.SQLDialect.SQLITE;

import java.util.Collection;

import org.jooq.impl.DSL;

This type is used for the Insert's DSL API. 

Example: 
DSLContext create = DSL.using(configuration);
create.insertInto(table, field1, field2)
      .values(value1, value2)
      .values(value3, value4)
      .onConflict(field1)
      .doUpdate()
      .set(field2, value2)
      .where(field3.eq(value5))
      .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 Insert}'s DSL API.
 * <p>
 * Example: <code><pre>
 * DSLContext create = DSL.using(configuration);
 *
 * create.insertInto(table, field1, field2)
 *       .values(value1, value2)
 *       .values(value3, value4)
 *       .onConflict(field1)
 *       .doUpdate()
 *       .set(field2, value2)
 *       .where(field3.eq(value5))
 *       .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 InsertOnConflictWhereIndexPredicateStep<R extends Record> extends InsertOnConflictDoUpdateStep<R> {

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.
/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    InsertOnConflictDoUpdateStep<R> where(Condition condition);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause, connecting them with each other using Operator.AND. /**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause,
     * connecting them with each other using {@link Operator#AND}.
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    InsertOnConflictDoUpdateStep<R> where(Condition... conditions);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause, connecting them with each other using Operator.AND. /**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause,
     * connecting them with each other using {@link Operator#AND}.
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    InsertOnConflictDoUpdateStep<R> where(Collection<? extends Condition> conditions);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.
/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    InsertOnConflictDoUpdateStep<R> where(Field<Boolean> field);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.

NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also:
condition.condition(SQL)
SQL/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     * <p>
     * <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(SQL)
     * @see SQL
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    @PlainSQL
    InsertOnConflictDoUpdateStep<R> where(SQL sql);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.

NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also:
condition.condition(String)
SQL/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     * <p>
     * <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String)
     * @see SQL
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    @PlainSQL
    InsertOnConflictDoUpdateStep<R> where(String sql);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.

NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also:
condition.condition(String, Object...)
DSL.sql(String, Object...)
SQL/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     * <p>
     * <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String, Object...)
     * @see DSL#sql(String, Object...)
     * @see SQL
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    @PlainSQL
    InsertOnConflictDoUpdateStep<R> where(String sql, Object... bindings);

    
Add a WHERE clause to supply an index predicate to the
INSERT statement's ON CONFLICT ... clause.

NOTE: When inserting plain SQL into jOOQ objects, you must
guarantee syntax integrity. You may also create the possibility of
malicious SQL injection. Be sure to properly use bind variables and/or
escape literals when concatenated into SQL clauses!
See Also:
condition.condition(String, QueryPart...)
DSL.sql(String, QueryPart...)
SQL/**
     * Add a <code>WHERE</code> clause to supply an index predicate to the
     * <code>INSERT</code> statement's <code>ON CONFLICT ...</code> clause.
     * <p>
     * <b>NOTE</b>: When inserting plain SQL into jOOQ objects, you must
     * guarantee syntax integrity. You may also create the possibility of
     * malicious SQL injection. Be sure to properly use bind variables and/or
     * escape literals when concatenated into SQL clauses!
     *
     * @see DSL#condition(String, QueryPart...)
     * @see DSL#sql(String, QueryPart...)
     * @see SQL
     */
    @NotNull
    @Support({ POSTGRES, SQLITE })
    @PlainSQL
    InsertOnConflictDoUpdateStep<R> where(String sql, QueryPart... parts);
}