Struct RelationSpec 

pub struct RelationSpec {
    pub name: String,
    pub relation_type: RelationType,
    pub related_model: String,
    pub related_table: String,
    pub fields: Vec<String>,
    pub references: Vec<String>,
    pub join_table: Option<JoinTableSpec>,
    pub on_delete: Option<ReferentialAction>,
    pub on_update: Option<ReferentialAction>,
}

Specification for a relation between models.

Fields

name: String

Name of the relation (field name).

relation_type: RelationType

Type of relation.

related_model: String

Name of the related model.

related_table: String

Name of the related table.

fields: Vec<String>

Foreign key fields on this model.

references: Vec<String>

Referenced fields on the related model.

join_table: Option<JoinTableSpec>

Join table for many-to-many relations.

on_delete: Option<ReferentialAction>

On delete action.

on_update: Option<ReferentialAction>

On update action.

Implementations

impl RelationSpec

pub fn one_to_one( name: impl Into<String>, related_model: impl Into<String>, related_table: impl Into<String>, ) -> Self

Create a one-to-one relation spec.

pub fn one_to_many( name: impl Into<String>, related_model: impl Into<String>, related_table: impl Into<String>, ) -> Self

Create a one-to-many relation spec.

pub fn many_to_one( name: impl Into<String>, related_model: impl Into<String>, related_table: impl Into<String>, ) -> Self

Create a many-to-one relation spec.

pub fn many_to_many( name: impl Into<String>, related_model: impl Into<String>, related_table: impl Into<String>, join_table: JoinTableSpec, ) -> Self

Create a many-to-many relation spec.

pub fn fields(self, fields: impl IntoIterator<Item = impl Into<String>>) -> Self

Set the foreign key fields.

pub fn references( self, refs: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the referenced fields.

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

Set the on delete action.

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

Set the on update action.

pub fn to_join_clause(&self, parent_alias: &str, child_alias: &str) -> String

Generate the JOIN clause for this relation.

Trait Implementations

impl Clone for RelationSpec

fn clone(&self) -> RelationSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RelationSpec

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

Formats the value using the given formatter.