Struct BoxedSelectStatement

#[non_exhaustive]
pub struct BoxedSelectStatement<'a, ST, QS, DB, GB = ()> {
    pub select: Box<dyn QueryFragment<DB> + Send + 'a>,
    pub from: QS,
    pub distinct: Box<dyn QueryFragment<DB> + Send + 'a>,
    pub where_clause: BoxedWhereClause<'a, DB>,
    pub order: Option<Box<dyn QueryFragment<DB> + Send + 'a>>,
    pub limit_offset: BoxedLimitOffsetClause<'a, DB>,
    pub group_by: Box<dyn QueryFragment<DB> + Send + 'a>,
    pub having: Box<dyn QueryFragment<DB> + Send + 'a>,
    /* private fields */
}

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

This type represents a boxed select query

Using this type directly is only meaningful for custom backends that need to provide a custom QueryFragment implementation

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

select: Box<dyn QueryFragment<DB> + Send + 'a>

The select clause of the query

from: QS

The from clause of the query

distinct: Box<dyn QueryFragment<DB> + Send + 'a>

The distinct clause of the query

where_clause: BoxedWhereClause<'a, DB>

The where clause of the query

order: Option<Box<dyn QueryFragment<DB> + Send + 'a>>

The order clause of the query

limit_offset: BoxedLimitOffsetClause<'a, DB>

The combined limit/offset clause of the query

group_by: Box<dyn QueryFragment<DB> + Send + 'a>

The group by clause of the query

having: Box<dyn QueryFragment<DB> + Send + 'a>

The having clause of the query

Trait Implementations

impl<'a, ST, QS, DB, GB> AsInExpression<ST> for BoxedSelectStatement<'a, ST, QS, DB, GB>

where ST: SqlType, Subselect<BoxedSelectStatement<'a, ST, QS, DB, GB>, ST>: Expression<SqlType = ST>,

type InExpression = Subselect<BoxedSelectStatement<'a, ST, QS, DB, GB>, ST>

Type of the expression returned by AsInExpression::as_in_expression

fn as_in_expression(self) -> Self::InExpression

Construct the diesel query dsl representation of the IN (values) clause for the given type

impl<ST, QS, DB, GB> CombineDsl for BoxedSelectStatement<'_, ST, QS, DB, GB>

where Self: Query,

type Query = BoxedSelectStatement<'_, ST, QS, DB, GB>

What kind of query does this type represent?

fn union<Rhs>(self, rhs: Rhs) -> Union<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL UNION

fn union_all<Rhs>(self, rhs: Rhs) -> UnionAll<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL UNION ALL

fn intersect<Rhs>(self, rhs: Rhs) -> Intersect<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL INTERSECT

fn intersect_all<Rhs>(self, rhs: Rhs) -> IntersectAll<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL INTERSECT ALL

fn except<Rhs>(self, rhs: Rhs) -> Except<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL EXCEPT

fn except_all<Rhs>(self, rhs: Rhs) -> ExceptAll<Self, Rhs>

where Rhs: AsQuery<SqlType = <Self::Query as Query>::SqlType>,

Combine two queries using a SQL EXCEPT ALL

impl<ST, QS, DB, GB> DistinctDsl for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend, DistinctClause: QueryFragment<DB>,

type Output = BoxedSelectStatement<'_, ST, QS, DB, GB>

The type returned by .distinct

fn distinct(self) -> Self::Output

See the trait documentation.

impl<'a, ST, DB, Predicate, GB> FilterDsl<Predicate> for BoxedSelectStatement<'a, ST, NoFromClause, DB, GB>

where BoxedWhereClause<'a, DB>: WhereAnd<Predicate, Output = BoxedWhereClause<'a, DB>>, Predicate: AppearsOnTable<NoFromClause> + NonAggregate, Predicate::SqlType: BoolOrNullableBool,

type Output = BoxedSelectStatement<'a, ST, NoFromClause, DB, GB>

The type returned by .filter.

fn filter(self, predicate: Predicate) -> Self::Output

See the trait documentation.

impl<ST, QS, DB, T, GB> Insertable<T> for &BoxedSelectStatement<'_, ST, QS, DB, GB>

where T: Table, Self: Query, <T::AllColumns as ValidGrouping<()>>::IsAggregate: MixedAggregates<No, Output = No>,

type Values = InsertFromSelect<&BoxedSelectStatement<'_, ST, QS, DB, GB>, <T as Table>::AllColumns>

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl<ST, QS, DB, T, GB> Insertable<T> for BoxedSelectStatement<'_, ST, QS, DB, GB>

where T: Table, Self: Query, <T::AllColumns as ValidGrouping<()>>::IsAggregate: MixedAggregates<No, Output = No>,

type Values = InsertFromSelect<BoxedSelectStatement<'_, ST, QS, DB, GB>, <T as Table>::AllColumns>

The VALUES clause to insert these records

fn values(self) -> Self::Values

Construct Self::Values

fn insert_into(self, table: T) -> InsertStatement<T, Self::Values>

where T: Table, Self: Sized,

Insert self into a given table.

impl<'a, ST, QS, DB, GB> IntoArrayExpression<ST> for BoxedSelectStatement<'a, ST, QS, DB, GB>

where ST: SqlType + TypedExpressionType, ArraySubselect<BoxedSelectStatement<'a, ST, QS, DB, GB>, ST>: Expression<SqlType = Array<ST>>,

Available on crate feature postgres_backend only.

type ArrayExpression = ArraySubselect<BoxedSelectStatement<'a, ST, QS, DB, GB>, ST>

Type of the expression returned by [AsArrayExpression::as_in_expression]

fn into_array_expression(self) -> Self::ArrayExpression

Construct the diesel query dsl representation of the ARRAY (values) clause for the given type

impl<ST, QS, DB, GB> LimitDsl for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend, LimitClause<AsExprOf<i64, BigInt>>: QueryFragment<DB>,

type Output = BoxedSelectStatement<'_, ST, QS, DB, GB>

The type returned by .limit

fn limit(self, limit: i64) -> Self::Output

See the trait documentation

impl<ST, QS, DB, GB> OffsetDsl for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend, OffsetClause<AsExprOf<i64, BigInt>>: QueryFragment<DB>,

type Output = BoxedSelectStatement<'_, ST, QS, DB, GB>

The type returned by .offset.

fn offset(self, offset: i64) -> Self::Output

See the trait documentation

impl<'a, ST, DB, Predicate, GB> OrFilterDsl<Predicate> for BoxedSelectStatement<'a, ST, NoFromClause, DB, GB>

where BoxedWhereClause<'a, DB>: WhereOr<Predicate, Output = BoxedWhereClause<'a, DB>>, Predicate: AppearsOnTable<NoFromClause> + NonAggregate, Predicate::SqlType: BoolOrNullableBool,

type Output = BoxedSelectStatement<'a, ST, NoFromClause, DB, GB>

The type returned by .filter.

fn or_filter(self, predicate: Predicate) -> Self::Output

See the trait documentation.

impl<ST, QS, DB, GB> Query for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend,

type SqlType = ST

The SQL type that this query represents.

impl<ST, QS, DB, GB> QueryDsl for BoxedSelectStatement<'_, ST, QS, DB, GB>

fn distinct(self) -> Distinct<Self>

where Self: DistinctDsl,

Adds the DISTINCT keyword to a query.

fn distinct_on<Expr>(self, expr: Expr) -> DistinctOn<Self, Expr>

where Self: DistinctOnDsl<Expr>,

Available on crate feature postgres_backend only.

Adds the DISTINCT ON clause to a query.

fn select<Selection>(self, selection: Selection) -> Select<Self, Selection>

where Selection: Expression, Self: SelectDsl<Selection>,

Adds a SELECT clause to the query.

fn count(self) -> Select<Self, CountStar>

where Self: SelectDsl<CountStar>,

Get the count of a query. This is equivalent to .select(count_star())

fn inner_join<Rhs>(self, rhs: Rhs) -> InnerJoin<Self, Rhs>

where Self: JoinWithImplicitOnClause<Rhs, Inner>,

Join two tables using a SQL INNER JOIN.

fn left_outer_join<Rhs>(self, rhs: Rhs) -> LeftJoin<Self, Rhs>

where Self: JoinWithImplicitOnClause<Rhs, LeftOuter>,

Join two tables using a SQL LEFT OUTER JOIN.

fn left_join<Rhs>(self, rhs: Rhs) -> LeftJoin<Self, Rhs>

where Self: JoinWithImplicitOnClause<Rhs, LeftOuter>,

Alias for left_outer_join.

fn filter<Predicate>(self, predicate: Predicate) -> Filter<Self, Predicate>

where Self: FilterDsl<Predicate>,

Adds to the WHERE clause of a query.

fn or_filter<Predicate>(self, predicate: Predicate) -> OrFilter<Self, Predicate>

where Self: OrFilterDsl<Predicate>,

Adds to the WHERE clause of a query using OR

fn find<PK>(self, id: PK) -> Find<Self, PK>

where Self: FindDsl<PK>,

Attempts to find a single record from the given table by primary key.

fn order<Expr>(self, expr: Expr) -> Order<Self, Expr>

where Expr: Expression, Self: OrderDsl<Expr>,

Sets the order clause of a query.

fn order_by<Expr>(self, expr: Expr) -> OrderBy<Self, Expr>

where Expr: Expression, Self: OrderDsl<Expr>,

Alias for order

fn then_order_by<Order>(self, order: Order) -> ThenOrderBy<Self, Order>

where Self: ThenOrderDsl<Order>,

Appends to the ORDER BY clause of this SQL query.

fn limit(self, limit: i64) -> Limit<Self>

where Self: LimitDsl,

Sets the limit clause of the query.

fn offset(self, offset: i64) -> Offset<Self>

where Self: OffsetDsl,

Sets the offset clause of the query.

fn group_by<GB>(self, group_by: GB) -> GroupBy<Self, GB>

where GB: Expression, Self: GroupByDsl<GB>,

Sets the group by clause of a query.

fn having<Predicate>(self, predicate: Predicate) -> Having<Self, Predicate>

where Self: HavingDsl<Predicate>,

Adds to the HAVING clause of a query.

fn into_boxed<'a, DB>(self) -> IntoBoxed<'a, Self, DB>

where DB: Backend, Self: BoxedDsl<'a, DB>,

Boxes the pieces of a query into a single type.

fn single_value(self) -> SingleValue<Self>

where Self: SingleValueDsl,

Wraps this select statement in parenthesis, allowing it to be used as an expression.

fn nullable(self) -> NullableSelect<Self>

where Self: SelectNullableDsl,

Coerce the SQL type of the select clause to it’s nullable equivalent.

impl<ST, QS, DB, GB> QueryFragment<DB> for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend, Self: QueryFragment<DB, DB::SelectStatementSyntax>,

fn walk_ast<'b>(&'b self, pass: AstPass<'_, 'b, DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder, backend: &DB) -> QueryResult<()>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut DB::BindCollector<'b>, metadata_lookup: &mut DB::MetadataLookup, backend: &'b DB, ) -> QueryResult<()>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Does walking this AST have any effect?

impl<'a, ST, QS, DB, GB> QueryFragment<DB, AnsiSqlSelectStatement> for BoxedSelectStatement<'a, ST, QS, DB, GB>

where DB: Backend<SelectStatementSyntax = AnsiSqlSelectStatement> + DieselReserveSpecialization, QS: QueryFragment<DB>, BoxedLimitOffsetClause<'a, DB>: QueryFragment<DB>,

fn walk_ast<'b>(&'b self, out: AstPass<'_, 'b, DB>) -> QueryResult<()>

Walk over this QueryFragment for all passes.

fn to_sql(&self, out: &mut DB::QueryBuilder, backend: &DB) -> QueryResult<()>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Converts this QueryFragment to its SQL representation.

fn collect_binds<'b>( &'b self, out: &mut DB::BindCollector<'b>, metadata_lookup: &mut DB::MetadataLookup, backend: &'b DB, ) -> QueryResult<()>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Serializes all bind parameters in this query.

fn is_safe_to_cache_prepared(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Is this query safe to store in the prepared statement cache?

fn is_noop(&self, backend: &DB) -> QueryResult<bool>

Available on crate feature i-implement-a-third-party-backend-and-opt-into-breaking-changes only.

Does walking this AST have any effect?

impl<ST, QS, DB, GB> QueryId for BoxedSelectStatement<'_, ST, QS, DB, GB>

const HAS_STATIC_QUERY_ID: bool = false

Can the SQL generated by Self be uniquely identified by its type?

type QueryId = ()

A type which uniquely represents Self in a SQL query.

fn query_id() -> Option<TypeId>

Returns the type id of Self::QueryId if Self::HAS_STATIC_QUERY_ID. Returns None otherwise.

impl<ST, QS, DB, Conn, GB> RunQueryDsl<Conn> for BoxedSelectStatement<'_, ST, QS, DB, GB>

fn execute(self, conn: &mut Conn) -> QueryResult<usize>

where Conn: Connection, Self: ExecuteDsl<Conn>,

Executes the given command, returning the number of rows affected.

fn load<'query, U>(self, conn: &mut Conn) -> QueryResult<Vec<U>>

where Self: LoadQuery<'query, Conn, U>,

Executes the given query, returning a Vec with the returned rows.

fn load_iter<'conn, 'query: 'conn, U, B>( self, conn: &'conn mut Conn, ) -> QueryResult<Self::RowIter<'conn>>

where U: 'conn, Self: LoadQuery<'query, Conn, U, B> + 'conn,

Executes the given query, returning an Iterator with the returned rows.

fn get_result<'query, U>(self, conn: &mut Conn) -> QueryResult<U>

where Self: LoadQuery<'query, Conn, U>,

Runs the command, and returns the affected row.

fn get_results<'query, U>(self, conn: &mut Conn) -> QueryResult<Vec<U>>

where Self: LoadQuery<'query, Conn, U>,

Runs the command, returning an Vec with the affected rows.

fn first<'query, U>(self, conn: &mut Conn) -> QueryResult<U>

where Self: LimitDsl, Limit<Self>: LoadQuery<'query, Conn, U>,

Attempts to load a single record.

impl<'a, ST, DB, Selection, GB> SelectDsl<Selection> for BoxedSelectStatement<'a, ST, NoFromClause, DB, GB>

where DB: Backend, Selection: SelectableExpression<NoFromClause> + QueryFragment<DB> + ValidGrouping<GB> + Send + 'a,

type Output = BoxedSelectStatement<'a, <Selection as Expression>::SqlType, NoFromClause, DB, GB>

The type returned by .select

fn select(self, selection: Selection) -> Self::Output

See the trait documentation

impl<'a, ST, QS, DB, GB> SelectNullableDsl for BoxedSelectStatement<'a, ST, QS, DB, GB>

where ST: IntoNullable,

type Output = BoxedSelectStatement<'a, <ST as IntoNullable>::Nullable, QS, DB>

The return type of nullable

fn nullable(self) -> Self::Output

See the trait documentation

impl<ST, QS, DB, GB> SelectQuery for BoxedSelectStatement<'_, ST, QS, DB, GB>

where DB: Backend,

type SqlType = ST

The SQL type of the SELECT clause