Struct ForeignKeyDef 

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

Const-friendly foreign key definition

Examples

use drizzle_types::postgres::ddl::{ForeignKeyDef, ReferentialAction};
use std::borrow::Cow;

const COLS: &[Cow<'static, str>] = &[Cow::Borrowed("user_id")];
const REFS: &[Cow<'static, str>] = &[Cow::Borrowed("id")];

const FK: ForeignKeyDef = ForeignKeyDef::new("public", "posts", "fk_posts_user")
    .columns(COLS)
    .references("public", "users", REFS)
    .on_delete(ReferentialAction::Cascade);

Fields

schema: &'static str

Schema name

table: &'static str

Parent table name

name: &'static str

Constraint name

name_explicit: bool

Whether the constraint name was explicitly specified

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

Source columns

schema_to: &'static str

Referenced schema name

table_to: &'static str

Referenced table name

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

Referenced columns

on_delete: Option<ReferentialAction>

ON DELETE action

on_update: Option<ReferentialAction>

ON UPDATE action

deferrable: bool

Whether the constraint is DEFERRABLE

initially_deferred: bool

Whether the constraint is INITIALLY DEFERRED

Implementations

impl ForeignKeyDef

pub const fn new( schema: &'static str, table: &'static str, name: &'static str, ) -> Self

Create a new foreign key definition

pub const fn columns(self, cols: &'static [Cow<'static, str>]) -> Self

Set source columns

pub const fn references( self, schema_to: &'static str, table_to: &'static str, cols_to: &'static [Cow<'static, str>], ) -> Self

Set referenced table and columns

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

Set ON DELETE action

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

Set ON UPDATE action

pub const fn deferrable(self) -> Self

Mark the constraint DEFERRABLE.

pub const fn initially_deferred(self) -> Self

Mark the constraint DEFERRABLE INITIALLY DEFERRED.

pub const fn explicit_name(self) -> Self

Mark the name as explicitly specified

pub const fn into_foreign_key(self) -> ForeignKey

Convert to runtime ForeignKey type

Trait Implementations

impl Clone for ForeignKeyDef

fn clone(&self) -> ForeignKeyDef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ForeignKeyDef

impl Debug for ForeignKeyDef

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

Formats the value using the given formatter.

impl Default for ForeignKeyDef

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ForeignKeyDef

impl From<ForeignKeyDef> for ForeignKey

fn from(def: ForeignKeyDef) -> Self

Converts to this type from the input type.

impl Hash for ForeignKeyDef

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 PartialEq for ForeignKeyDef

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ForeignKeyDef