Struct ForeignKeyDef 

pub struct ForeignKeyDef {
    pub ref_table: TableName,
    pub ref_columns: Vec<ColumnName>,
    pub on_delete: Option<ReferenceAction>,
    pub on_update: Option<ReferenceAction>,
    pub orphan_strategy: ForeignKeyOrphanStrategy,
}

Full foreign key definition used in the normalized table representation.

Specifies the referenced table and columns along with optional referential actions for ON DELETE and ON UPDATE. This is the canonical form produced after parsing any of the three ForeignKeySyntax variants.

Always add "index": true on the column carrying the foreign key for query performance.

Fields

ref_table: TableName

The table being referenced (the “parent” side of the relationship).

ref_columns: Vec<ColumnName>

The column(s) in the referenced table that this foreign key points to.

on_delete: Option<ReferenceAction>

Action to take on child rows when the parent row is deleted.

on_update: Option<ReferenceAction>

Action to take on child rows when the referenced column(s) in the parent row are updated.

orphan_strategy: ForeignKeyOrphanStrategy

Pre-cleanup strategy for orphan child rows when the FK is added to a populated table. See ForeignKeyOrphanStrategy for semantics; the canonical default (ForeignKeyOrphanStrategy::NullifyOrphans) is omitted from the JSON wire format.

Stripped from model.schema.json by the schema generator but preserved in migration.schema.json.

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

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ForeignKeyDef

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ForeignKeyDef

impl JsonSchema for ForeignKeyDef

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ForeignKeyDef

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ForeignKeyDef