Struct sea_query::foreign_key::ForeignKeyCreateStatement

pub struct ForeignKeyCreateStatement { /* private fields */ }

Create a foreign key constraint for an existing table. Unsupported by Sqlite

Examples

use sea_query::{tests_cfg::*, *};

let foreign_key = ForeignKey::create()
    .name("FK_character_font")
    .from(Char::Table, Char::FontId)
    .to(Font::Table, Font::Id)
    .on_delete(ForeignKeyAction::Cascade)
    .on_update(ForeignKeyAction::Cascade)
    .to_owned();

assert_eq!(
    foreign_key.to_string(MysqlQueryBuilder),
    [
        r#"ALTER TABLE `character`"#,
        r#"ADD CONSTRAINT `FK_character_font`"#,
        r#"FOREIGN KEY (`font_id`) REFERENCES `font` (`id`)"#,
        r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
    ]
    .join(" ")
);
assert_eq!(
    foreign_key.to_string(PostgresQueryBuilder),
    [
        r#"ALTER TABLE "character" ADD CONSTRAINT "FK_character_font""#,
        r#"FOREIGN KEY ("font_id") REFERENCES "font" ("id")"#,
        r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
    ]
    .join(" ")
);

Composite key

use sea_query::{tests_cfg::*, *};

let foreign_key = ForeignKey::create()
    .name("FK_character_glyph")
    .from(Char::Table, (Char::FontId, Char::Id))
    .to(Glyph::Table, (Char::FontId, Glyph::Id))
    .on_delete(ForeignKeyAction::Cascade)
    .on_update(ForeignKeyAction::Cascade)
    .to_owned();

assert_eq!(
    foreign_key.to_string(MysqlQueryBuilder),
    [
        r#"ALTER TABLE `character`"#,
        r#"ADD CONSTRAINT `FK_character_glyph`"#,
        r#"FOREIGN KEY (`font_id`, `id`) REFERENCES `glyph` (`font_id`, `id`)"#,
        r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
    ]
    .join(" ")
);
assert_eq!(
    foreign_key.to_string(PostgresQueryBuilder),
    [
        r#"ALTER TABLE "character" ADD CONSTRAINT "FK_character_glyph""#,
        r#"FOREIGN KEY ("font_id", "id") REFERENCES "glyph" ("font_id", "id")"#,
        r#"ON DELETE CASCADE ON UPDATE CASCADE"#,
    ]
    .join(" ")
);

Implementations

impl ForeignKeyCreateStatement

pub fn new() -> Self

Construct a new ForeignKeyCreateStatement

pub fn name<T>(&mut self, name: T) -> &mut Self

where T: Into<String>,

Set foreign key name

pub fn from<T, C>(&mut self, table: T, columns: C) -> &mut Self

where T: IntoTableRef, C: IdenList,

Set key table and columns

pub fn to<T, C>(&mut self, table: T, columns: C) -> &mut Self

where T: IntoTableRef, C: IdenList,

Set referencing table and columns

pub fn from_tbl<T>(&mut self, table: T) -> &mut Self

where T: IntoTableRef,

Set key table

pub fn to_tbl<R>(&mut self, ref_table: R) -> &mut Self

where R: IntoTableRef,

Set referencing table

pub fn from_col<T>(&mut self, column: T) -> &mut Self

where T: IntoIden,

Add key column

pub fn to_col<R>(&mut self, ref_column: R) -> &mut Self

where R: IntoIden,

Add referencing column

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

Set on delete action

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

Set on update action

pub fn get_foreign_key(&self) -> &TableForeignKey

pub fn take(&mut self) -> Self

impl ForeignKeyCreateStatement

pub fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String

See SchemaStatementBuilder::build

pub fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String

See SchemaStatementBuilder::build_any

pub fn to_string<T: SchemaBuilder>(&self, schema_builder: T) -> String

See SchemaStatementBuilder::to_string

Trait Implementations

impl Clone for ForeignKeyCreateStatement

fn clone(&self) -> ForeignKeyCreateStatement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ForeignKeyCreateStatement

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

Formats the value using the given formatter.

impl Default for ForeignKeyCreateStatement

fn default() -> ForeignKeyCreateStatement

Returns the “default value” for a type.

impl SchemaStatementBuilder for ForeignKeyCreateStatement

fn build<T: SchemaBuilder>(&self, schema_builder: T) -> String

Build corresponding SQL statement for certain database backend and return SQL string

fn build_any(&self, schema_builder: &dyn SchemaBuilder) -> String

Build corresponding SQL statement for certain database backend and return SQL string

fn to_string<T: SchemaBuilder>(&self, schema_builder: T) -> String

Build corresponding SQL statement for certain database backend and return SQL string