Struct ForeignKeyConstraint 

pub struct ForeignKeyConstraint {
    pub name: Option<String>,
    pub columns: Vec<String>,
    pub parent_table: String,
    pub parent_columns: Vec<String>,
    pub on_delete: FkAction,
    pub on_update: FkAction,
    pub match_type: MatchType,
    pub deferrable: bool,
    pub initially_deferred: bool,
}

v7.6.0 — A single FOREIGN KEY constraint. Both column-level REFERENCES and table-level FOREIGN KEY (...) REFERENCES ... parse into this shape — the column-level form has a single-entry columns / parent_columns.

Fields

name: Option<String>

Optional CONSTRAINT <name> prefix. Engine ignores the name today but parses + stores it so a future ALTER TABLE DROP CONSTRAINT can target by name (v7.6.8).

columns: Vec<String>

Local columns participating in the FK (≥ 1).

parent_table: String

Referenced parent table.

parent_columns: Vec<String>

Referenced parent columns. Must have the same arity as columns; engine validates parent has a PK / UNIQUE index on exactly this column set (v7.6.1).

on_delete: FkAction

ON DELETE action. Defaults to Restrict if absent.

on_update: FkAction

ON UPDATE action. Defaults to Restrict if absent.

match_type: MatchType

v7.38 (read01, T29) — MATCH {SIMPLE | FULL}. Defaults to Simple.

deferrable: bool

v7.39 (round 288) — [NOT] DEFERRABLE. Parsed since v7.17 and dropped on the floor, so a constraint declared DEFERRABLE was enforced immediately and a circular-FK migration could not load.

initially_deferred: bool

INITIALLY DEFERRED — the check moves to COMMIT unless SET CONSTRAINTS … IMMEDIATE pulls it forward.

Trait Implementations

impl Clone for ForeignKeyConstraint

fn clone(&self) -> ForeignKeyConstraint

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ForeignKeyConstraint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ForeignKeyConstraint

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for ForeignKeyConstraint

fn eq(&self, other: &ForeignKeyConstraint) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ForeignKeyConstraint