Skip to main content

SelectBuilder

Struct SelectBuilder 

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

Fluent builder for SELECT queries.

§Example

use oxisql_core::query::{SelectBuilder, SortDirection};

let q = SelectBuilder::new()
    .columns(&["id", "name", "email"])
    .from("users")
    .where_eq("active", &true)
    .order_by("name", Default::default())
    .limit(20)
    .offset(40)
    .build();

assert_eq!(q.sql, "SELECT id, name, email FROM users WHERE active = $1 ORDER BY name ASC LIMIT 20 OFFSET 40");

Implementations§

Source§

impl SelectBuilder

Source

pub fn new() -> Self

Create a new empty SELECT builder.

Source

pub fn columns(self, cols: &[&str]) -> Self

Add columns to SELECT. Call multiple times or pass a slice.

Source

pub fn from(self, table: &str) -> Self

Set the FROM table.

Source

pub fn where_raw(self, condition: &str) -> Self

Add a raw WHERE condition (e.g. "id > $1"). Call multiple times to AND them.

Source

pub fn where_eq(self, col: &str, val: &dyn ToSqlValue) -> Self

Add a WHERE col = $N condition, binding the value.

Source

pub fn order_by(self, col: &str, dir: SortDirection) -> Self

Add an ORDER BY clause.

Source

pub fn limit(self, n: usize) -> Self

Set LIMIT.

Source

pub fn offset(self, n: usize) -> Self

Set OFFSET.

Source

pub fn build(self) -> BuiltQuery

Build the query into a BuiltQuery.

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
Source§

impl Default for SelectBuilder

Source§

fn default() -> SelectBuilder

Returns the “default value” for a type. 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.