Struct ForeignKey 

pub struct ForeignKey {
    pub name: Option<Ident>,
    pub columns: Vec<Ident>,
    pub ref_table: Ident,
    pub ref_columns: Vec<Ident>,
    pub on_delete: Option<ForeignKeyAction>,
    pub on_update: Option<ForeignKeyAction>,
}

A foreign-key constraint.

Fields

name: Option<Ident>

The optional constraint name.

columns: Vec<Ident>

The local columns.

ref_table: Ident

The referenced table.

ref_columns: Vec<Ident>

The referenced columns.

on_delete: Option<ForeignKeyAction>

The ON DELETE action.

on_update: Option<ForeignKeyAction>

The ON UPDATE action.

Implementations

impl ForeignKey

pub fn new<C: IntoIden, R: IntoIden>( columns: impl IntoIterator<Item = C>, ref_table: impl IntoIden, ref_columns: impl IntoIterator<Item = R>, ) -> Self

Builds FOREIGN KEY (columns) REFERENCES table (ref_columns).

pub fn name(self, name: impl IntoIden) -> Self

Sets the constraint name.

pub fn on_delete(self, action: ForeignKeyAction) -> Self

Sets ON DELETE action.

pub fn on_update(self, action: ForeignKeyAction) -> Self

Sets ON UPDATE action.

Trait Implementations

impl Clone for ForeignKey

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignKey

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

Formats the value using the given formatter.

impl Eq for ForeignKey

impl PartialEq for ForeignKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ForeignKey