Struct orma::DbJoin

pub struct DbJoin {
    pub offset: i64,
    pub limit: i64,
    pub sorting: Vec<String>,
    // some fields omitted
}

This struct is used to create a join between DbEntyty elements and JoinBuilder is used to create a DbJoin instance.

sorting parameter (such as vec!["data->>'first_name'", "data->>'last_name' DESC"]) take effect after a call to fetch method.

items can be persisted to db after a call to save_items method.

See JoinBuilder for more info

Fields

offset: i64

The offset of the extracted query join

limit: i64

The limit of the extracted query join. If limit is negative it means "no limit"

sorting: Vec<String>

Used to provide a sorting method on data fetching.

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

Implementations

impl DbJoin

pub async fn fetch<'_, '_, A>(
    &'_ self,
    conn: &'_ Connection
) -> Result<Vec<DbEntity<A>>, DbError> where
    A: DbData, 

This method fetches items field for the given join using the current sorting field.

pub async fn fetch_filtered<'_, '_, '_, '_, '_, A>(
    &'_ self,
    conn: &'_ Connection,
    filter: (&'_ str, &'_ [&'_ (dyn ToSql + Sync)])
) -> Result<Vec<DbEntity<A>>, DbError> where
    A: DbData, 

This method fetches items field for the given join using the current sorting field. Filter is a tuple with the query filter and its values. The target table is aliased with "a" name so a query filter could be "a.data->>'name' LIKE $1"

pub async fn add_items<'_, '_, '_, A>(
    &'_ self,
    conn: &'_ mut Connection,
    items: &'_ [DbEntity<A>]
) -> Result<(), DbError> where
    A: DbData, 

This method adds items for the given join to the DB.

pub async fn add_items_by_id<'_, '_, '_, '_>(
    &'_ self,
    conn: &'_ mut Connection,
    items: &'_ [&'_ Uuid]
) -> Result<(), DbError>

This method adds items for the given join to the DB using object ids.

pub async fn remove_items<'_, '_, '_, A>(
    &'_ self,
    conn: &'_ mut Connection,
    items: Option<&'_ [DbEntity<A>]>
) -> Result<(), DbError> where
    A: DbData, 

This method removes items for the given join to the DB.

pub async fn remove_items_by_id<'_, '_, '_>(
    &'_ self,
    conn: &'_ mut Connection,
    items_id: Option<&'_ [Uuid]>
) -> Result<(), DbError>

This method removes items for the given join to the DB using object ids.