Struct SelectStatement

#[non_exhaustive]
pub struct SelectStatement<From, Select = DefaultSelectClause<From>, Distinct = NoDistinctClause, Where = NoWhereClause, Order = NoOrderClause, LimitOffset = LimitOffsetClause<NoLimitClause, NoOffsetClause>, GroupBy = NoGroupByClause, Having = NoHavingClause, Locking = NoLockingClause> {
    pub select: Select,
    pub from: From,
    pub distinct: Distinct,
    pub where_clause: Where,
    pub order: Order,
    pub limit_offset: LimitOffset,
    pub group_by: GroupBy,
    pub having: Having,
    pub locking: Locking,
}

This type represents a 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: Select

The select clause of the query

from: From

The from clause of the query

distinct: Distinct

The distinct clause of the query

where_clause: Where

The where clause of the query

order: Order

The order clause of the query

limit_offset: LimitOffset

The combined limit/offset clause of the query

group_by: GroupBy

The group by clause of the query

having: Having

The having clause of the query

locking: Locking

The locking clause of the query

Trait Implementations

impl<From, T> AppearsInFromClause<T> for SelectStatement<From>

where From: AsQuerySource, From::QuerySource: AppearsInFromClause<T> + QuerySource,

Allow SelectStatement<From> to act as if it were From as long as no other query methods have been called on it

type Count = <<From as AsQuerySource>::QuerySource as AppearsInFromClause<T>>::Count

How many times does Self appear in QS?

impl<ST, F, S, D, W, O, LOf, G, H, LC> AsInExpression<ST> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where ST: SqlType + TypedExpressionType, Subselect<Self, ST>: Expression<SqlType = ST>, Self: SelectQuery<SqlType = ST>,

type InExpression = Subselect<SelectStatement<F, S, D, W, O, LOf, G, H, LC>, 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<'a, S, D, W, O, LOf, G, H, DB> BoxedDsl<'a, DB> for SelectStatement<NoFromClause, S, D, W, O, LOf, G, H>

where Self: AsQuery, DB: Backend, S: SelectClauseExpression<NoFromClause> + QueryFragment<DB> + Send + 'a, S::Selection: ValidGrouping<G::Expressions>, D: QueryFragment<DB> + Send + 'a, W: Into<BoxedWhereClause<'a, DB>>, O: Into<Option<Box<dyn QueryFragment<DB> + Send + 'a>>>, LOf: IntoBoxedClause<'a, DB, BoxedClause = BoxedLimitOffsetClause<'a, DB>>, G: ValidGroupByClause + QueryFragment<DB> + Send + 'a, H: QueryFragment<DB> + Send + 'a,

type Output = BoxedSelectStatement<'a, <S as SelectClauseExpression<NoFromClause>>::SelectClauseSqlType, NoFromClause, DB, <G as ValidGroupByClause>::Expressions>

The return type of internal_into_boxed

fn internal_into_boxed(self) -> Self::Output

See the trait documentation.

impl<From: Clone, Select: Clone, Distinct: Clone, Where: Clone, Order: Clone, LimitOffset: Clone, GroupBy: Clone, Having: Clone, Locking: Clone> Clone for SelectStatement<From, Select, Distinct, Where, Order, LimitOffset, GroupBy, Having, Locking>

fn clone( &self, ) -> SelectStatement<From, Select, Distinct, Where, Order, LimitOffset, GroupBy, Having, Locking>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F, S, D, W, O, LOf, G, H, LC> CombineDsl for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where Self: Query,

type Query = SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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<From: Debug, Select: Debug, Distinct: Debug, Where: Debug, Order: Debug, LimitOffset: Debug, GroupBy: Debug, Having: Debug, Locking: Debug> Debug for SelectStatement<From, Select, Distinct, Where, Order, LimitOffset, GroupBy, Having, Locking>

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

Formats the value using the given formatter.

impl<ST, F, S, D, W, O, LOf, G, H> DistinctDsl for SelectStatement<F, S, D, W, O, LOf, G, H>

where Self: SelectQuery<SqlType = ST>, SelectStatement<F, S, DistinctClause, W, O, LOf, G, H>: SelectQuery<SqlType = ST>,

type Output = SelectStatement<F, S, DistinctClause, W, O, LOf, G, H>

The type returned by .distinct

fn distinct(self) -> Self::Output

See the trait documentation.

impl<F, S, D, W, O, LOf, G, H, LC, Predicate> FilterDsl<Predicate> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where Predicate: Expression + NonAggregate, Predicate::SqlType: BoolOrNullableBool, W: WhereAnd<Predicate>,

type Output = SelectStatement<F, S, D, <W as WhereAnd<Predicate>>::Output, O, LOf, G, H, LC>

The type returned by .filter.

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

See the trait documentation.

impl<F, S, D, W, O, LOf, G, H, Expr> GroupByDsl<Expr> for SelectStatement<F, S, D, W, O, LOf, G, H>

where SelectStatement<F, S, D, W, O, LOf, GroupByClause<Expr>, H>: SelectQuery, Expr: Expression + AppearsOnTable<F>,

type Output = SelectStatement<F, S, D, W, O, LOf, GroupByClause<Expr>, H>

The type returned by .group_by

fn group_by(self, expr: Expr) -> Self::Output

See the trait documentation.

impl<F, S, D, W, O, LOf, G, H, LC, Tab> Insertable<Tab> for &SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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

type Values = InsertFromSelect<&SelectStatement<F, S, D, W, O, LOf, G, H, LC>, <Tab 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<F, S, D, W, O, LOf, G, H, LC, Tab> Insertable<Tab> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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

type Values = InsertFromSelect<SelectStatement<F, S, D, W, O, LOf, G, H, LC>, <Tab 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, F, S, D, W, O, L, Of, G, H, LC> LimitDsl for SelectStatement<F, S, D, W, O, LimitOffsetClause<L, Of>, G, H, LC>

where Self: SelectQuery<SqlType = ST>, SelectStatement<F, S, D, W, O, LimitOffsetClause<LimitClause<AsExprOf<i64, BigInt>>, Of>, G, H, LC>: SelectQuery<SqlType = ST>,

type Output = SelectStatement<F, S, D, W, O, LimitOffsetClause<LimitClause<<i64 as AsExpression<BigInt>>::Expression>, Of>, G, H, LC>

The type returned by .limit

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

See the trait documentation

impl<F, S, W, O, LOf, Lock> LockingDsl<Lock> for SelectStatement<F, S, NoDistinctClause, W, O, LOf>

type Output = SelectStatement<F, S, NoDistinctClause, W, O, LOf, NoGroupByClause, NoHavingClause, LockingClause<Lock>>

The type returned by set_lock. See dsl::ForUpdate and friends for convenient access to this type.

fn with_lock(self, lock: Lock) -> Self::Output

See the trait level documentation

impl<F, S, D, W, O, LOf, G, H, LC, LM, Modifier> ModifyLockDsl<Modifier> for SelectStatement<F, S, D, W, O, LOf, G, H, LockingClause<LC, LM>>

type Output = SelectStatement<F, S, D, W, O, LOf, G, H, LockingClause<LC, Modifier>>

The type returned by modify_lock. See dsl::SkipLocked and friends for convenient access to this type.

fn modify_lock(self, modifier: Modifier) -> Self::Output

See the trait level documentation

impl<ST, F, S, D, W, O, L, Of, G, H, LC> OffsetDsl for SelectStatement<F, S, D, W, O, LimitOffsetClause<L, Of>, G, H, LC>

where Self: SelectQuery<SqlType = ST>, SelectStatement<F, S, D, W, O, LimitOffsetClause<L, OffsetClause<AsExprOf<i64, BigInt>>>, G, H, LC>: SelectQuery<SqlType = ST>,

type Output = SelectStatement<F, S, D, W, O, LimitOffsetClause<L, OffsetClause<<i64 as AsExpression<BigInt>>::Expression>>, G, H, LC>

The type returned by .offset.

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

See the trait documentation

impl<F, S, D, W, O, LOf, G, H, LC, Predicate> OrFilterDsl<Predicate> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where Predicate: Expression + NonAggregate, Predicate::SqlType: BoolOrNullableBool, W: WhereOr<Predicate>,

type Output = SelectStatement<F, S, D, <W as WhereOr<Predicate>>::Output, O, LOf, G, H, LC>

The type returned by .filter.

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

See the trait documentation.

impl<F, S, D, W, O, LOf, G, H, LC> Query for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where G: ValidGroupByClause, S: SelectClauseExpression<F>, S::Selection: ValidGrouping<G::Expressions>, W: ValidWhereClause<F>,

type SqlType = <S as SelectClauseExpression<F>>::SelectClauseSqlType

The SQL type that this query represents.

impl<F, S, D, W, O, LOf, G, H, LC> QueryDsl for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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>,

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 for_update(self) -> ForUpdate<Self>

where Self: LockingDsl<ForUpdate>,

Adds FOR UPDATE to the end of the select statement.

fn for_no_key_update(self) -> ForNoKeyUpdate<Self>

where Self: LockingDsl<ForNoKeyUpdate>,

Adds FOR NO KEY UPDATE to the end of the select statement.

fn for_share(self) -> ForShare<Self>

where Self: LockingDsl<ForShare>,

Adds FOR SHARE to the end of the select statement.

fn for_key_share(self) -> ForKeyShare<Self>

where Self: LockingDsl<ForKeyShare>,

Adds FOR KEY SHARE to the end of the select statement.

fn skip_locked(self) -> SkipLocked<Self>

where Self: ModifyLockDsl<SkipLocked>,

Adds SKIP LOCKED to the end of a FOR UPDATE clause.

fn no_wait(self) -> NoWait<Self>

where Self: ModifyLockDsl<NoWait>,

Adds NOWAIT to the end of a FOR UPDATE clause.

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<F, S, D, W, O, LOf, G, H, LC, DB> QueryFragment<DB> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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<()>

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<()>

Serializes all bind parameters in this query.

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

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

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

Does walking this AST have any effect?

impl<F, S, D, W, O, LOf, G, H, LC, DB> QueryFragment<DB, AnsiSqlSelectStatement> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where DB: Backend<SelectStatementSyntax = AnsiSqlSelectStatement>, S: QueryFragment<DB>, F: QueryFragment<DB>, D: QueryFragment<DB>, W: QueryFragment<DB>, O: QueryFragment<DB>, LOf: QueryFragment<DB>, G: QueryFragment<DB>, H: QueryFragment<DB>, LC: 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<()>

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<()>

Serializes all bind parameters in this query.

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

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

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

Does walking this AST have any effect?

impl<From: QueryId, Select: QueryId, Distinct: QueryId, Where: QueryId, Order: QueryId, LimitOffset: QueryId, GroupBy: QueryId, Having: QueryId, Locking: QueryId> QueryId for SelectStatement<From, Select, Distinct, Where, Order, LimitOffset, GroupBy, Having, Locking>

const HAS_STATIC_QUERY_ID: bool

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

type QueryId = SelectStatement<<From as QueryId>::QueryId, <Select as QueryId>::QueryId, <Distinct as QueryId>::QueryId, <Where as QueryId>::QueryId, <Order as QueryId>::QueryId, <LimitOffset as QueryId>::QueryId, <GroupBy as QueryId>::QueryId, <Having as QueryId>::QueryId, <Locking as QueryId>::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<From> QuerySource for SelectStatement<From>

where From: AsQuerySource, <From::QuerySource as QuerySource>::DefaultSelection: SelectableExpression<Self>,

type FromClause = <<From as AsQuerySource>::QuerySource as QuerySource>::FromClause

The type returned by from_clause

type DefaultSelection = <<From as AsQuerySource>::QuerySource as QuerySource>::DefaultSelection

The type returned by default_selection

fn from_clause(&self) -> <From::QuerySource as QuerySource>::FromClause

The actual FROM clause of this type. This is typically only called in QueryFragment implementations.

fn default_selection(&self) -> Self::DefaultSelection

The default select clause of this type, which should be used if no select clause was explicitly specified. This should always be a tuple of all the desired columns, not star

impl<F, S, D, W, O, LOf, G, H, LC, Conn> RunQueryDsl<Conn> for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

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<S, D, W, O, LOf, G, H, LC, Selection> SelectDsl<Selection> for SelectStatement<NoFromClause, S, D, W, O, LOf, G, H, LC>

where G: ValidGroupByClause, Selection: SelectableExpression<NoFromClause> + ValidGrouping<G::Expressions>, SelectStatement<NoFromClause, SelectClause<Selection>, D, W, O, LOf, G, H, LC>: SelectQuery, D: ValidDistinctForGroupBy<Selection, G::Expressions>,

type Output = SelectStatement<NoFromClause, SelectClause<Selection>, D, W, O, LOf, G, H, LC>

The type returned by .select

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

See the trait documentation

impl<F, S, D, W, O, LOf, G, H> SelectNullableDsl for SelectStatement<F, SelectClause<S>, D, W, O, LOf, G, H>

type Output = SelectStatement<F, SelectClause<Nullable<S>>, D, W, O, LOf, G, H>

The return type of nullable

fn nullable(self) -> Self::Output

See the trait documentation

impl<F, S, D, W, O, LOf, G, H, LC> SelectQuery for SelectStatement<F, S, D, W, O, LOf, G, H, LC>

where S: SelectClauseExpression<F>, O: ValidOrderingForDistinct<D>,

type SqlType = <S as SelectClauseExpression<F>>::SelectClauseSqlType

The SQL type of the SELECT clause

impl<F, S, D, W, LOf, G, LC, Expr> ThenOrderDsl<Expr> for SelectStatement<F, S, D, W, NoOrderClause, LOf, G, LC>

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

type Output = <SelectStatement<F, S, D, W, NoOrderClause, LOf, G, LC> as OrderDsl<Expr>>::Output

The type returned by .then_order_by.

fn then_order_by(self, expr: Expr) -> Self::Output

See the trait documentation.

impl<From: Copy, Select: Copy, Distinct: Copy, Where: Copy, Order: Copy, LimitOffset: Copy, GroupBy: Copy, Having: Copy, Locking: Copy> Copy for SelectStatement<From, Select, Distinct, Where, Order, LimitOffset, GroupBy, Having, Locking>