Struct RelationBuilder 

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

Fluent builder for a RelationDef. Construct one via EntityTrait::belongs_to / has_one / has_many.

Implementations

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

where E: EntityTrait, R: EntityTrait,

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

where T: IdentityOf<E>,

Column(s) on the FK-owning side. Accepts a column or a tuple of columns for composite keys.

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

where T: IdentityOf<R>,

Column(s) on the referenced side (usually the related entity’s primary key). Accepts a column or a tuple of columns for composite keys.

pub fn skip_fk(self) -> Self

Don’t emit a FOREIGN KEY constraint when this relation is used to generate schema DDL.

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

Set the ON DELETE action for the foreign key (e.g. Cascade, SetNull).

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

Set the ON UPDATE action for the foreign key.

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

where F: Fn(DynIden, DynIden) -> Condition + 'static,

Add an extra predicate to the join’s ON clause. The closure receives the left-hand-side and right-hand-side table idens.

pub fn fk_name(self, fk_name: &str) -> Self

Override the name of the FOREIGN KEY constraint emitted in DDL.

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

Combine the column equality and on_condition with AND (ConditionType::All, default) or OR (ConditionType::Any).

Trait Implementations

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

where E: EntityTrait, R: EntityTrait, PhantomData<(E, R)>: Debug,

fn fmt(&self, __derive_more_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.