Struct ForeignKeyConstraint 

pub struct ForeignKeyConstraint {
    pub name: Option<Ident>,
    pub index_name: Option<Ident>,
    pub columns: Vec<Ident>,
    pub foreign_table: ObjectName,
    pub referred_columns: Vec<Ident>,
    pub on_delete: Option<ReferentialAction>,
    pub on_update: Option<ReferentialAction>,
    pub match_kind: Option<ConstraintReferenceMatchKind>,
    pub characteristics: Option<ConstraintCharacteristics>,
}

A referential integrity constraint ([ CONSTRAINT <name> ] FOREIGN KEY (<columns>) REFERENCES <foreign_table> (<referred_columns>) [ MATCH { FULL | PARTIAL | SIMPLE } ] { [ON DELETE <referential_action>] [ON UPDATE <referential_action>] | [ON UPDATE <referential_action>] [ON DELETE <referential_action>] }).

Fields

name: Option<Ident>

Optional constraint name.

index_name: Option<Ident>

MySQL-specific index name associated with the foreign key. https://dev.mysql.com/doc/refman/8.4/en/create-table-foreign-keys.html

columns: Vec<Ident>

Columns in the local table that participate in the foreign key.

foreign_table: ObjectName

Referenced foreign table name.

referred_columns: Vec<Ident>

Columns in the referenced table.

on_delete: Option<ReferentialAction>

Action to perform ON DELETE.

on_update: Option<ReferentialAction>

Action to perform ON UPDATE.

match_kind: Option<ConstraintReferenceMatchKind>

Optional MATCH kind (FULL | PARTIAL | SIMPLE).

characteristics: Option<ConstraintCharacteristics>

Optional characteristics (e.g., DEFERRABLE).

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 From<ForeignKeyConstraint> for ColumnOption

fn from(fk: ForeignKeyConstraint) -> Self

Converts to this type from the input type.

impl From<ForeignKeyConstraint> for TableConstraint

fn from(constraint: ForeignKeyConstraint) -> Self

Converts to this type from the input type.

impl Hash for ForeignKeyConstraint

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ForeignKeyConstraint

fn cmp(&self, other: &ForeignKeyConstraint) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ForeignKeyConstraint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for ForeignKeyConstraint

fn partial_cmp(&self, other: &ForeignKeyConstraint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Spanned for ForeignKeyConstraint

fn span(&self) -> Span

Return the Span (the minimum and maximum Location) for this AST node, by recursively combining the spans of its children.

impl Visit for ForeignKeyConstraint

fn visit<V: Visitor>(&self, visitor: &mut V) -> ControlFlow<V::Break>

Visit this node with the provided Visitor.

impl VisitMut for ForeignKeyConstraint

fn visit<V: VisitorMut>(&mut self, visitor: &mut V) -> ControlFlow<V::Break>

Mutably visit this node with the provided VisitorMut.

impl Eq for ForeignKeyConstraint

impl StructuralPartialEq for ForeignKeyConstraint