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


The step in the Constraint construction DSL API that allows for adding ON DELETE and ON UPDATE clauses.

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/**
 * The step in the {@link Constraint} construction DSL API that allows for
 * adding <code>ON DELETE</code> and <code>ON UPDATE</code> clauses.
 * <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 ConstraintForeignKeyOnStep extends ConstraintEnforcementStep {

    
Add an ON DELETE NO ACTION clause to the
FOREIGN KEY constraint.
 This is the standard action according to the SQL standard. If a given SQLDialect does not support setting this action explicitly, no explicit action will be specified and calling this method is equivalent to not calling any method at all. /**
     * Add an <code>ON DELETE NO ACTION</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     * <p>
     * This is the standard action according to the SQL standard. If a given
     * {@link SQLDialect} does not support setting this action explicitly, no
     * explicit action will be specified and calling this method is equivalent
     * to not calling any method at all.
     */
    @NotNull
    @Support
    ConstraintForeignKeyOnStep onDeleteNoAction();

    
Add an ON DELETE RESTRICT clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON DELETE RESTRICT</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onDeleteRestrict();

    
Add an ON DELETE CASCADE clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON DELETE CASCADE</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support
    ConstraintForeignKeyOnStep onDeleteCascade();

    
Add an ON DELETE SET NULL clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON DELETE SET NULL</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support
    ConstraintForeignKeyOnStep onDeleteSetNull();

    
Add an ON DELETE SET DEFAULT clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON DELETE SET DEFAULT</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, FIREBIRD, H2, HSQLDB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onDeleteSetDefault();

    
Add an ON UPDATE NO ACTION clause to the
FOREIGN KEY constraint.
 This is the standard action according to the SQL standard. If a given SQLDialect does not support setting this action explicitly, no explicit action will be specified and calling this method is equivalent to not calling any method at all. /**
     * Add an <code>ON UPDATE NO ACTION</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     * <p>
     * This is the standard action according to the SQL standard. If a given
     * {@link SQLDialect} does not support setting this action explicitly, no
     * explicit action will be specified and calling this method is equivalent
     * to not calling any method at all.
     */
    @NotNull
    @Support
    ConstraintForeignKeyOnStep onUpdateNoAction();

    
Add an ON UPDATE RESTRICT clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON UPDATE RESTRICT</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onUpdateRestrict();

    
Add an ON UPDATE CASCADE clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON UPDATE CASCADE</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onUpdateCascade();

    
Add an ON UPDATE SET NULL clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON UPDATE SET NULL</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onUpdateSetNull();

    
Add an ON UPDATE SET DEFAULT clause to the
FOREIGN KEY constraint.
/**
     * Add an <code>ON UPDATE SET DEFAULT</code> clause to the
     * <code>FOREIGN KEY</code> constraint.
     */
    @NotNull
    @Support({ CUBRID, FIREBIRD, H2, HSQLDB, MYSQL, POSTGRES, SQLITE })
    ConstraintForeignKeyOnStep onUpdateSetDefault();

}