Struct Select 

pub struct Select { /* private fields */ }

A SELECT statement.

Implementations

impl Select

pub fn new() -> Self

A new empty select whose conditions default to Condition::all().

pub fn distinct(self) -> Self

Sets SELECT DISTINCT.

pub fn column(self, column: impl Into<ColumnRef>) -> Self

Selects a column.

pub fn columns<C: Into<ColumnRef>>( self, columns: impl IntoIterator<Item = C>, ) -> Self

Selects several columns.

pub fn expr(self, expr: Expr) -> Self

Selects an expression.

pub fn expr_as(self, expr: Expr, alias: impl IntoIden) -> Self

Selects an aliased expression.

pub fn has_items(&self) -> bool

Whether any item has been selected; without one the statement renders SELECT *.

pub fn clear_items(self) -> Self

Removes all selected items.

pub fn from(self, table: impl Into<TableRef>) -> Self

Adds a FROM table.

pub fn from_subquery(self, subquery: Select, alias: impl IntoIden) -> Self

Sets FROM (subquery) AS alias.

pub fn join( self, kind: JoinType, table: impl Into<TableRef>, on: impl IntoCondition, ) -> Self

Adds a JOIN table ON cond of the given kind.

pub fn inner_join( self, table: impl Into<TableRef>, on: impl IntoCondition, ) -> Self

Adds an INNER JOIN.

pub fn left_join( self, table: impl Into<TableRef>, on: impl IntoCondition, ) -> Self

Adds a LEFT JOIN.

pub fn and_where(self, cond: impl IntoCondition) -> Self

Adds a condition to WHERE with AND.

pub fn cond_where(self, cond: impl IntoCondition) -> Self

Replaces the whole WHERE condition.

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

Adds a GROUP BY expression.

pub fn and_having(self, cond: impl IntoCondition) -> Self

Adds a condition to HAVING with AND.

pub fn order_by(self, column: impl Into<ColumnRef>, order: Order) -> Self

Adds an ORDER BY column.

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

Adds an ORDER BY expr.

pub fn clear_order_by(self) -> Self

Removes the ordering.

pub fn limit(self, limit: u64) -> Self

Sets LIMIT.

pub fn reset_limit(self) -> Self

Removes LIMIT.

pub fn offset(self, offset: u64) -> Self

Sets OFFSET.

pub fn reset_offset(self) -> Self

Removes OFFSET.

pub fn from_tables(&self) -> &[TableRef]

The FROM tables.

pub fn joins(&self) -> &[Join]

The join clauses, in order.

Trait Implementations

impl Build for Select

fn to_statement(&self) -> Statement

Renders into a Statement.

fn build(&self) -> (String, Vec<Value>)

Renders to the SQL text and the values to bind.

fn to_string_inlined(&self) -> String

Renders with literals inlined, for logs and tests only.

impl Clone for Select

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Select

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

Formats the value using the given formatter.

impl Default for Select

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Select

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Select