Struct RelationBuilder 

pub struct RelationBuilder<E, R>
where
    E: EntityTrait,
    R: EntityTrait,
{
    entities: PhantomData<(E, R)>,
    rel_type: RelationType,
    from_tbl: TableRef,
    to_tbl: TableRef,
    from_col: Option<Identity>,
    to_col: Option<Identity>,
    is_owner: bool,
    on_delete: Option<ForeignKeyAction>,
    on_update: Option<ForeignKeyAction>,
    on_condition: Option<Box<dyn Fn(SeaRc<dyn Iden>, SeaRc<dyn Iden>) -> Condition + Sync + Send>>,
    fk_name: Option<String>,
    condition_type: ConditionType,
}

Defines a helper to build a relation

Fields

entities: PhantomData<(E, R)>

rel_type: RelationType

from_tbl: TableRef

to_tbl: TableRef

from_col: Option<Identity>

to_col: Option<Identity>

is_owner: bool

on_delete: Option<ForeignKeyAction>

on_update: Option<ForeignKeyAction>

on_condition: Option<Box<dyn Fn(SeaRc<dyn Iden>, SeaRc<dyn Iden>) -> Condition + Sync + Send>>

fk_name: Option<String>

condition_type: ConditionType

Implementations

impl<E, R> RelationBuilder<E, R>

where E: EntityTrait, R: EntityTrait,

pub fn from<T>(self, identifier: T) -> RelationBuilder<E, R>

where T: IdentityOf<E>,

Build a relationship from an Entity

pub fn to<T>(self, identifier: T) -> RelationBuilder<E, R>

where T: IdentityOf<R>,

Build a relationship to an Entity

pub fn on_delete(self, action: ForeignKeyAction) -> RelationBuilder<E, R>

An operation to perform on a foreign key when a delete operation occurs

pub fn on_update(self, action: ForeignKeyAction) -> RelationBuilder<E, R>

An operation to perform on a foreign key when an update operation occurs

pub fn on_condition<F>(self, f: F) -> RelationBuilder<E, R>

where F: Fn(SeaRc<dyn Iden>, SeaRc<dyn Iden>) -> Condition + 'static + Send + Sync,

Set custom join ON condition.

This method takes a closure with parameters denoting the left-hand side and right-hand side table in the join expression.

pub fn fk_name(self, fk_name: &str) -> RelationBuilder<E, R>

Set the name of foreign key constraint

pub fn condition_type( self, condition_type: ConditionType, ) -> RelationBuilder<E, R>

Set the condition type of join on expression

Trait Implementations

impl<E, R> Debug for RelationBuilder<E, R>

where E: EntityTrait, R: EntityTrait,

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

Formats the value using the given formatter.

impl<E, R> From<RelationBuilder<E, R>> for RelationDef

where E: EntityTrait, R: EntityTrait,

fn from(b: RelationBuilder<E, R>) -> RelationDef

Converts to this type from the input type.