Struct ForeignKey 

pub struct ForeignKey {
    pub schema: Cow<'static, str>,
    pub table: Cow<'static, str>,
    pub name: Cow<'static, str>,
    pub name_explicit: bool,
    pub columns: Cow<'static, [Cow<'static, str>]>,
    pub schema_to: Cow<'static, str>,
    pub table_to: Cow<'static, str>,
    pub columns_to: Cow<'static, [Cow<'static, str>]>,
    pub on_update: Option<Cow<'static, str>>,
    pub on_delete: Option<Cow<'static, str>>,
}

Runtime foreign key constraint entity

Uses Cow<'static, str> for all string fields, which works with both:

• Borrowed data from const definitions (Cow::Borrowed)
• Owned data from deserialization/introspection (Cow::Owned)

Fields

schema: Cow<'static, str>

Schema name

table: Cow<'static, str>

Parent table name

name: Cow<'static, str>

Constraint name

name_explicit: bool

Whether the constraint name was explicitly specified

columns: Cow<'static, [Cow<'static, str>]>

Source columns

schema_to: Cow<'static, str>

Referenced schema name

table_to: Cow<'static, str>

Referenced table name

columns_to: Cow<'static, [Cow<'static, str>]>

Referenced columns

on_update: Option<Cow<'static, str>>

ON UPDATE action

on_delete: Option<Cow<'static, str>>

ON DELETE action

Implementations

impl ForeignKey

pub fn new( schema: impl Into<Cow<'static, str>>, table: impl Into<Cow<'static, str>>, name: impl Into<Cow<'static, str>>, ) -> Self

Create a new foreign key

pub fn from_strings( schema: String, table: String, name: String, columns: Vec<String>, schema_to: String, table_to: String, columns_to: Vec<String>, ) -> ForeignKey

Create a new foreign key from owned strings (convenience for runtime construction)

pub fn on_delete(self, action: impl Into<Cow<'static, str>>) -> Self

Set ON DELETE action

pub fn on_update(self, action: impl Into<Cow<'static, str>>) -> Self

Set ON UPDATE action

pub fn schema(&self) -> &str

Get the schema name

pub fn name(&self) -> &str

Get the constraint name

pub fn table(&self) -> &str

Get the table name

pub fn table_to(&self) -> &str

Get the referenced table name

pub fn schema_to(&self) -> &str

Get the referenced schema name

impl ForeignKey

pub fn to_constraint_sql(&self) -> String

Generate the CONSTRAINT … FOREIGN KEY clause SQL

pub fn add_fk_sql(&self) -> String

Generate ADD FOREIGN KEY SQL

pub fn drop_fk_sql(&self) -> String

Generate DROP FOREIGN KEY SQL

Trait Implementations

impl Clone for ForeignKey

fn clone(&self) -> ForeignKey

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 Default for ForeignKey

fn default() -> Self

Returns the “default value” for a type.

impl From<ForeignKeyDef> for ForeignKey

fn from(def: ForeignKeyDef) -> Self

Converts to this type from the input type.

impl PartialEq for ForeignKey

fn eq(&self, other: &ForeignKey) -> 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 Eq for ForeignKey

impl StructuralPartialEq for ForeignKey