Struct SelectTwo

pub struct SelectTwo<E, F>
where
    E: EntityTrait,
    F: EntityTrait,
{ /* private fields */ }

Defines a structure to perform a SELECT operation on two Models

Implementations

impl<E, F, M, N> SelectTwo<E, F>

where E: EntityTrait<Model = M>, F: EntityTrait<Model = N>, M: FromQueryResult + Sized + Send + Sync, N: FromQueryResult + Sized + Send + Sync,

pub fn cursor_by<C>(self, order_columns: C) -> Cursor<SelectTwoModel<M, N>>

where C: IdentityOf<E>,

Convert into a cursor using column of first entity

pub fn cursor_by_other<C>( self, order_columns: C, ) -> Cursor<SelectTwoModel<M, N>>

where C: IdentityOf<F>,

Convert into a cursor using column of second entity

impl<E, F> SelectTwo<E, F>

where E: EntityTrait, F: EntityTrait,

pub fn into_model<M, N>(self) -> Selector<SelectTwoModel<M, N>>

where M: FromQueryResult, N: FromQueryResult,

Perform a conversion into a SelectTwoModel

pub fn into_partial_model<M, N>(self) -> Selector<SelectTwoModel<M, N>>

where M: PartialModelTrait, N: PartialModelTrait,

Perform a conversion into a SelectTwoModel with PartialModel

pub fn into_json(self) -> Selector<SelectTwoModel<JsonValue, JsonValue>>

Convert the Models into JsonValue

pub async fn one<'a, C>( self, db: &C, ) -> Result<Option<(E::Model, Option<F::Model>)>, DbErr>

where C: ConnectionTrait,

Get one Model from the Select query

pub async fn all<'a, C>( self, db: &C, ) -> Result<Vec<(E::Model, Option<F::Model>)>, DbErr>

where C: ConnectionTrait,

Get all Models from the Select query

pub async fn stream<'a: 'b, 'b, C>( self, db: &'a C, ) -> Result<impl Stream<Item = Result<(E::Model, Option<F::Model>), DbErr>> + 'b, DbErr>

where C: ConnectionTrait + StreamTrait + Send,

Stream the results of a Select operation on a Model

pub async fn stream_partial_model<'a: 'b, 'b, C, M, N>( self, db: &'a C, ) -> Result<impl Stream<Item = Result<(M, Option<N>), DbErr>> + 'b + Send, DbErr>

where C: ConnectionTrait + StreamTrait + Send, M: PartialModelTrait + Send + 'b, N: PartialModelTrait + Send + 'b,

Stream the result of the operation with PartialModel

Trait Implementations

impl<E, F> Clone for SelectTwo<E, F>

where E: EntityTrait + Clone, F: EntityTrait + Clone,

fn clone(&self) -> SelectTwo<E, F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E, F, M, N> CursorTrait for SelectTwo<E, F>

where E: EntityTrait<Model = M>, F: EntityTrait<Model = N>, M: FromQueryResult + Sized + Send + Sync, N: FromQueryResult + Sized + Send + Sync,

type Selector = SelectTwoModel<M, N>

Select operation

impl<E, F> Debug for SelectTwo<E, F>

where E: EntityTrait + Debug, F: EntityTrait + Debug,

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

Formats the value using the given formatter.

impl<'db, C, M, N, E, F> PaginatorTrait<'db, C> for SelectTwo<E, F>

where C: ConnectionTrait, E: EntityTrait<Model = M>, F: EntityTrait<Model = N>, M: FromQueryResult + Sized + Send + Sync + 'db, N: FromQueryResult + Sized + Send + Sync + 'db,

type Selector = SelectTwoModel<M, N>

Select operation

fn paginate( self, db: &'db C, page_size: u64, ) -> Paginator<'db, C, Self::Selector>

Paginate the result of a select operation.

fn count<'async_trait>( self, db: &'db C, ) -> Pin<Box<dyn Future<Output = Result<u64, DbErr>> + Send + 'async_trait>>

where Self: Send + Sized + Send + 'async_trait, 'db: 'async_trait,

Perform a count on the paginated results

impl<E, F> QueryFilter for SelectTwo<E, F>

where E: EntityTrait, F: EntityTrait,

type QueryStatement = SelectStatement

fn query(&mut self) -> &mut SelectStatement

Add the query to perform a FILTER on

fn filter<F>(self, filter: F) -> Self

where F: IntoCondition,

Add an AND WHERE expression

fn belongs_to<M>(self, model: &M) -> Self

where M: ModelTrait,

Apply a where condition using the model’s primary key

fn belongs_to_tbl_alias<M>(self, model: &M, tbl_alias: &str) -> Self

where M: ModelTrait,

Perform a check to determine table belongs to a Model through it’s name alias

impl<E, F> QueryOrder for SelectTwo<E, F>

where E: EntityTrait, F: EntityTrait,

type QueryStatement = SelectStatement

fn query(&mut self) -> &mut SelectStatement

Add the query to perform an ORDER BY operation

fn order_by<C>(self, col: C, ord: Order) -> Self

where C: IntoSimpleExpr,

Add an order_by expression

fn order_by_asc<C>(self, col: C) -> Self

where C: IntoSimpleExpr,

Add an order_by expression (ascending)

fn order_by_desc<C>(self, col: C) -> Self

where C: IntoSimpleExpr,

Add an order_by expression (descending)

fn order_by_with_nulls<C>(self, col: C, ord: Order, nulls: NullOrdering) -> Self

where C: IntoSimpleExpr,

Add an order_by expression with nulls ordering option

impl<E, F> QuerySelect for SelectTwo<E, F>

where E: EntityTrait, F: EntityTrait,

type QueryStatement = SelectStatement

fn query(&mut self) -> &mut SelectStatement

Add the select SQL statement

fn select_only(self) -> Self

Clear the selection list

fn column<C>(self, col: C) -> Self

where C: ColumnTrait,

Add a select column

fn column_as<C, I>(self, col: C, alias: I) -> Self

where C: IntoSimpleExpr, I: IntoIdentity,

Add a select column with alias

fn columns<C, I>(self, cols: I) -> Self

where C: ColumnTrait, I: IntoIterator<Item = C>,

Select columns

fn offset<T>(self, offset: T) -> Self

where T: Into<Option<u64>>,

Add an offset expression. Passing in None would remove the offset.

fn limit<T>(self, limit: T) -> Self

where T: Into<Option<u64>>,

Add a limit expression. Passing in None would remove the limit.

fn group_by<C>(self, col: C) -> Self

where C: IntoSimpleExpr,

Add a group by column

fn having<F>(self, filter: F) -> Self

where F: IntoCondition,

Add an AND HAVING expression

fn distinct(self) -> Self

Add a DISTINCT expression

fn distinct_on<T, I>(self, cols: I) -> Self

where T: IntoColumnRef, I: IntoIterator<Item = T>,

Add a DISTINCT ON expression NOTE: this function is only supported by sqlx-postgres

fn join(self, join: JoinType, rel: RelationDef) -> Self

Join via RelationDef.

fn join_rev(self, join: JoinType, rel: RelationDef) -> Self

Join via RelationDef but in reverse direction. Assume when there exist a relation A to B. You can reverse join B from A.

fn join_as<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Self

where I: IntoIden,

Join via RelationDef with table alias.

fn join_as_rev<I>(self, join: JoinType, rel: RelationDef, alias: I) -> Self

where I: IntoIden,

Join via RelationDef with table alias but in reverse direction. Assume when there exist a relation A to B. You can reverse join B from A.

fn lock(self, lock_type: LockType) -> Self

Select lock

fn lock_shared(self) -> Self

Select lock shared

fn lock_exclusive(self) -> Self

Select lock exclusive

fn lock_with_behavior(self, type: LockType, behavior: LockBehavior) -> Self

Row locking with behavior (if supported).

fn expr<T>(self, expr: T) -> Self

where T: Into<SelectExpr>,

Add an expression to the select expression list.

fn exprs<T, I>(self, exprs: I) -> Self

where T: Into<SelectExpr>, I: IntoIterator<Item = T>,

Add select expressions from vector of SelectExpr.

fn expr_as<T, A>(self, expr: T, alias: A) -> Self

where T: Into<SimpleExpr>, A: IntoIdentity,

Select column.

fn expr_as_<T, A>(self, expr: T, alias: A) -> Self

where T: Into<SimpleExpr>, A: IntoIdentity,

Same as expr_as. Here for legacy reasons.

fn tbl_col_as<T, C, A>(self, (tbl, col): (T, C), alias: A) -> Self

where T: IntoIden + 'static, C: IntoIden + 'static, A: IntoIdentity,

Shorthand of expr_as(Expr::col((T, C)), A).

impl<E, F> QueryTrait for SelectTwo<E, F>

where E: EntityTrait, F: EntityTrait,

type QueryStatement = SelectStatement

Constrain the QueryStatement to QueryStatementBuilder trait

fn query(&mut self) -> &mut SelectStatement

Get a mutable ref to the query builder

fn as_query(&self) -> &SelectStatement

Get an immutable ref to the query builder

fn into_query(self) -> SelectStatement

Take ownership of the query builder

fn build(&self, db_backend: DbBackend) -> Statement

Build the query as Statement

fn apply_if<T, F>(self, val: Option<T>, if_some: F) -> Self

where Self: Sized, F: FnOnce(Self, T) -> Self,

Apply an operation on the QueryTrait::QueryStatement if the given Option<T> is Some(_)