Struct Relationship 

pub struct Relationship {
    pub table: QualifiedIdentifier,
    pub foreign_table: QualifiedIdentifier,
    pub is_self: bool,
    pub cardinality: Cardinality,
    pub table_is_view: bool,
    pub foreign_table_is_view: bool,
}

Foreign key relationship between two tables

Represents the relationship from one table to another via a foreign key constraint.

Fields

table: QualifiedIdentifier

Source table (the table containing the FK columns)

foreign_table: QualifiedIdentifier

Target table (the table being referenced)

is_self: bool

Whether this is a self-referencing relationship

cardinality: Cardinality

Relationship cardinality (M2O, O2M, O2O, M2M)

table_is_view: bool

Whether the source table is a view

foreign_table_is_view: bool

Whether the target table is a view

Implementations

impl Relationship

pub fn is_to_one(&self) -> bool

Check if this is a to-one relationship (M2O or O2O)

Returns true if following this relationship yields at most one row.

pub fn is_to_many(&self) -> bool

Check if this is a to-many relationship (O2M or M2M)

pub fn constraint_name(&self) -> &str

Get the constraint name for this relationship

pub fn columns(&self) -> &[(CompactString, CompactString)]

Get the column mappings for this relationship

Returns pairs of (source_column, target_column).

pub fn source_columns(&self) -> impl Iterator<Item = &str>

Get the source column names

pub fn target_columns(&self) -> impl Iterator<Item = &str>

Get the target column names

pub fn uses_column(&self, col_name: &str) -> bool

Check if this relationship uses a specific column

pub fn is_m2m(&self) -> bool

Check if this is a many-to-many relationship

pub fn junction(&self) -> Option<&Junction>

Get the junction table if this is an M2M relationship

pub fn reverse(&self) -> Self

Create the reverse direction of this relationship.

Swaps table / foreign_table and flips cardinality:

• M2O → O2M (and vice-versa)
• O2O child → O2O parent (and vice-versa)

Column pairs are swapped so (src, tgt) becomes (tgt, src).

pub fn is_o2o_parent(&self) -> bool

Check if this is an O2O relationship where we are the parent side

pub fn is_o2o_child(&self) -> bool

Check if this is an O2O relationship where we are the child side

Trait Implementations

impl Clone for Relationship

fn clone(&self) -> Relationship

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Relationship

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

Formats the value using the given formatter.

impl From<Relationship> for AnyRelationship

fn from(r: Relationship) -> Self

Converts to this type from the input type.