Skip to main content

SelectBuilder

Struct SelectBuilder 

Source
pub struct SelectBuilder { /* private fields */ }
Expand description

Builder for SELECT queries.

Implementations§

Source§

impl SelectBuilder

Source

pub fn with_capacity(self, capacity: SelectCapacity) -> Self

Reserve capacity for the builder’s internal vectors.

Source

pub fn items(self, items: Vec<SelectItem>) -> Self

Sets the select items.

Source

pub fn item(self, item: SelectItem) -> Self

Adds a select item.

Source

pub fn computed(self, expr: Expr, alias: impl Into<String>) -> Self

Adds a computed expression with an alias.

Source

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

Adds a WHERE clause filter.

Source

pub fn order_by(self, column: impl Into<String>, direction: OrderDir) -> Self

Adds an ORDER BY clause.

Source

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

Adds an ORDER BY ASC clause.

Source

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

Adds an ORDER BY DESC clause.

Source

pub fn take(self, n: i32) -> Self

Sets the row count (maps to SQL LIMIT).

Pass a positive value for forward pagination. Negative values signal backward pagination to callers; the dialect renders the absolute value.

Source

pub fn skip(self, n: u32) -> Self

Sets the row offset (maps to SQL OFFSET).

Source

pub fn join(self, clause: JoinClause) -> Self

Adds a JOIN clause.

Source

pub fn inner_join( self, table: impl Into<String>, on: Expr, items: Vec<SelectItem>, ) -> Self

Adds an INNER JOIN clause.

Source

pub fn left_join( self, table: impl Into<String>, on: Expr, items: Vec<SelectItem>, ) -> Self

Adds a LEFT JOIN clause.

Source

pub fn group_by_column(self, column: ColumnMarker) -> Self

Adds a GROUP BY clause.

Source

pub fn group_by(self, columns: Vec<ColumnMarker>) -> Self

Adds multiple columns to the GROUP BY clause.

Source

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

Sets the HAVING clause (post-GROUP BY filter).

Source

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

Adds an ORDER BY clause using an arbitrary expression (e.g. an aggregate function).

Source

pub fn distinct(self, columns: Vec<String>) -> Self

Sets the columns to deduplicate on (SELECT DISTINCT / DISTINCT ON).

  • Postgres: emits SELECT DISTINCT ON (col, ...) and requires those columns to appear first in ORDER BY (callers should prepend them).
  • SQLite / MySQL: emits plain SELECT DISTINCT.
Source

pub fn build(self) -> Result<Select>

Builds the final SELECT query.

Trait Implementations§

Source§

impl Clone for SelectBuilder

Source§

fn clone(&self) -> SelectBuilder

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SelectBuilder

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.