Struct RelationBuilder

pub struct RelationBuilder<E, R>
where
    E: EntityTrait,
    R: EntityTrait,
{ /* private fields */ }

Defines a helper to build a relation

Implementations

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

where E: EntityTrait, R: EntityTrait,

pub fn from<T>(self, identifier: T) -> Self

where T: IdentityOf<E>,

Build a relationship from an Entity

pub fn to<T>(self, identifier: T) -> Self

where T: IdentityOf<R>,

Build a relationship to an Entity

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

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

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

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

pub fn on_condition<F>(self, f: F) -> Self

where F: Fn(DynIden, DynIden) -> 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) -> Self

Set the name of foreign key constraint

pub fn condition_type(self, condition_type: ConditionType) -> Self

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

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>) -> Self

Converts to this type from the input type.