Module org.jooq

Package org.jooq

Interface ConstraintForeignKeyOnStep

All Superinterfaces:

Constraint, ConstraintEnforcementStep, ConstraintFinalStep, FieldOrConstraint, Named, QueryPart, Serializable, TableElement

public interface ConstraintForeignKeyOnStep
extends ConstraintEnforcementStep

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

Method Summary

Modifier and Type	Method	Description
@NotNull ConstraintForeignKeyOnStep	onDelete(QOM.ForeignKeyRule rule)	Add an ON DELETE clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onDeleteCascade()	Add an ON DELETE CASCADE clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onDeleteNoAction()	Add an ON DELETE NO ACTION clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onDeleteRestrict()	Add an ON DELETE RESTRICT clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onDeleteSetDefault()	Add an ON DELETE SET DEFAULT clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onDeleteSetNull()	Add an ON DELETE SET NULL clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdate(QOM.ForeignKeyRule rule)	Add an ON UPDATE clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdateCascade()	Add an ON UPDATE CASCADE clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdateNoAction()	Add an ON UPDATE NO ACTION clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdateRestrict()	Add an ON UPDATE RESTRICT clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdateSetDefault()	Add an ON UPDATE SET DEFAULT clause to the FOREIGN KEY constraint.
@NotNull ConstraintForeignKeyOnStep	onUpdateSetNull()	Add an ON UPDATE SET NULL clause to the FOREIGN KEY constraint.

Methods inherited from interface org.jooq.ConstraintEnforcementStep

enforced, notEnforced

Methods inherited from interface org.jooq.Named

$name, getComment, getCommentPart, getName, getQualifiedName, getUnqualifiedName

Methods inherited from interface org.jooq.QueryPart

$replace, $replace, $traverse, $traverse, equals, hashCode, toString

Method Details

onDeleteNoAction

@NotNull
@Support
@NotNull ConstraintForeignKeyOnStep onDeleteNoAction()

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.

onDeleteRestrict

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,H2,HANA,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,POSTGRES,SQLITE,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onDeleteRestrict()

Add an ON DELETE RESTRICT clause to the FOREIGN KEY constraint.

onDeleteCascade

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLDATAWAREHOUSE,SQLITE,SQLSERVER,SYBASE,TERADATA,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onDeleteCascade()

Add an ON DELETE CASCADE clause to the FOREIGN KEY constraint.

onDeleteSetNull

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,FIREBIRD,H2,HANA,HSQLDB,INFORMIX,INGRES,MARIADB,MEMSQL,MYSQL,ORACLE,POSTGRES,SQLITE,SQLSERVER,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onDeleteSetNull()

Add an ON DELETE SET NULL clause to the FOREIGN KEY constraint.

onDeleteSetDefault

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,FIREBIRD,H2,HANA,HSQLDB,INGRES,MEMSQL,MYSQL,POSTGRES,SQLITE,SQLSERVER,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onDeleteSetDefault()

Add an ON DELETE SET DEFAULT clause to the FOREIGN KEY constraint.

onDelete

@NotNull
@Support
@NotNull ConstraintForeignKeyOnStep onDelete(QOM.ForeignKeyRule rule)

Add an ON DELETE clause to the FOREIGN KEY constraint.

Check the specific clause to see if your dialect supports the particular rule.

onUpdateNoAction

@NotNull
@Support
@NotNull ConstraintForeignKeyOnStep onUpdateNoAction()

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.

onUpdateRestrict

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,DB2,DERBY,H2,HANA,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,POSTGRES,SQLITE,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onUpdateRestrict()

Add an ON UPDATE RESTRICT clause to the FOREIGN KEY constraint.

onUpdateCascade

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,FIREBIRD,H2,HANA,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,POSTGRES,SQLITE,SQLSERVER,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onUpdateCascade()

Add an ON UPDATE CASCADE clause to the FOREIGN KEY constraint.

onUpdateSetNull

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,FIREBIRD,H2,HANA,HSQLDB,INGRES,MARIADB,MEMSQL,MYSQL,POSTGRES,SQLITE,SQLSERVER,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onUpdateSetNull()

Add an ON UPDATE SET NULL clause to the FOREIGN KEY constraint.

onUpdateSetDefault

@NotNull
@Support({ACCESS,ASE,AURORA_MYSQL,AURORA_POSTGRES,COCKROACHDB,CUBRID,FIREBIRD,H2,HANA,HSQLDB,INGRES,MEMSQL,MYSQL,POSTGRES,SQLITE,SQLSERVER,SYBASE,YUGABYTEDB})
@NotNull ConstraintForeignKeyOnStep onUpdateSetDefault()

Add an ON UPDATE SET DEFAULT clause to the FOREIGN KEY constraint.

onUpdate

@NotNull
@Support
@NotNull ConstraintForeignKeyOnStep onUpdate(QOM.ForeignKeyRule rule)

Add an ON UPDATE clause to the FOREIGN KEY constraint.

Check the specific clause to see if your dialect supports the particular rule.