Struct orma::JoinBuilder

pub struct JoinBuilder<'a, A> where
    A: DbData,  { /* fields omitted */ }

Implementations

impl<'a, A> JoinBuilder<'a, A> where
    A: DbData, 

pub fn new(source: &'a A) -> Self

Defines the source DbEntity of the DbJoin

pub fn with_target(self, target_table: &'a str) -> Self

Provides the name of the table where DbJoin items are mapped to

pub fn with_source_fk(self, source_fk: &'a str) -> Self

The name of the source foreign key in the items table when you want to represents a simple join ( 1 to n )

pub fn with_join_table(
    self,
    join_table: &'a str,
    source_fk: &'a str,
    items_fk: &'a str
) -> Self

If you want to map a m2n join, you provide the name of the db table with name of the source foreign key and the foreign key of the items table

pub fn with_sorting(self, sorting: &'a [&'a str]) -> Self

DbJoin sorting attribute used to provide a sorting method on data fetching.

vec!["data->>'first_name'", "data->>'last_name' DESC"];

pub fn build(&self) -> Result<DbJoin, DbError>

Creates the DbJoin object and fetches the data