org.jooq.ConstraintForeignKeyOnStep 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.11
/**
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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.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 {@link Constraint} construction DSL API that allows for
 * adding ON DELETE and ON UPDATE clauses.
 *
 * @author Lukas Eder
 */
public interface ConstraintForeignKeyOnStep extends ConstraintFinalStep {

    /**
     * Add an ON DELETE NO ACTION clause to the
     * FOREIGN KEY constraint.
     */
    @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintFinalStep onDeleteNoAction();

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

    /**
     * Add an ON DELETE CASCADE clause to the
     * FOREIGN KEY constraint.
     */
    @Support
    ConstraintFinalStep onDeleteCascade();

    /**
     * Add an ON DELETE SET NULL clause to the
     * FOREIGN KEY constraint.
     */
    @Support
    ConstraintFinalStep onDeleteSetNull();

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

    /**
     * Add an ON UPDATE NO ACTION clause to the
     * FOREIGN KEY constraint.
     */
    @Support({ CUBRID, DERBY, FIREBIRD, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    ConstraintFinalStep onUpdateNoAction();

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

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

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

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

}