KQLite/com.kqlite.constraint/ForeignKeyConstraint

ForeignKeyConstraint

interface ForeignKeyConstraint

Represents a FOREIGN KEY in a KQLiteTable.

This interface provides a fluent API to build a complete foreign key definition, including specifying the referenced parent table columns and defining actions for ForeignKeyConstraint.onDelete and ForeignKeyConstraint.onUpdate.

Example

// Inside KQLiteTable
override val constraints: (ConstraintBuilder.() -> Unit)? = {
        foreignKey(columnA, columnB)
            .references(ParentTable.columnX, ParentTable.columnY)
            .onDelete(ForeignKeyAction.CASCADE)
            .onUpdate(ForeignKeyAction.NO_ACTION)
            .deferrable(true)
            .initially(Initially.DEFERRED)
    }

Author

MOHAMMAD AZIM ANSARI

See also

ConstraintBuilder

PrimaryKeyConstraint

Functions

abstract fun deferrable(): ForeignKeyConstraint

Same as calling deferrable(allow = true)

abstract fun deferrable(allow: Boolean): ForeignKeyConstraint

This corresponds to the DEFERRABLE clause in a FOREIGN KEY definition.

abstract fun initially(initially: Initially): Constraint

This corresponds to the INITIALLY clause in a FOREIGN KEY definition.

abstract fun onDelete(action: ForeignKeyAction): ForeignKeyConstraint

This corresponds to the ON DELETE clause in a FOREIGN KEY definition.

abstract fun onUpdate(action: ForeignKeyAction): ForeignKeyConstraint

This corresponds to the ON UPDATE clause in a FOREIGN KEY definition.

abstract fun references(vararg column: KQLiteColumn<*>): ForeignKeyConstraint

This corresponds to the REFERENCES clause in a FOREIGN KEY definition.