Skip to main content

QueryBuilder

Struct QueryBuilder 

Source
pub struct QueryBuilder<M> { /* private fields */ }
Expand description

A type-safe SQL query builder.

Constructed primarily via <Model>::find() and <Model>::select(...). Chain methods like .filter(), .order_by(), and .limit() before executing.

Implementations§

Source§

impl<M: Model + Send + Sync> QueryBuilder<M>

Source

pub fn new() -> Self

Source

pub fn filter<E>(self, expr: E) -> Self
where E: IntoExpr<M>,

Add a WHERE filter clause, e.g., filter(Expr::new(“age >= {}”, vec![18.to_param()])) Or using DSL: filter(UserColumn::Age.gte(18.to_param())) Backwards compatibility raw signature with $1 etc is also supported if string literal passes without {}

Source

pub fn select_only<E: IntoExpr<M>>(self, exprs: Vec<E>) -> Self

Source

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

Source

pub fn join_child<R: Model + HasForeignKey<M>>(self) -> Self

Adds an INNER JOIN automatically resolving foreign keys using HasForeignKey.

Source

pub fn join_parent<R: Model>(self) -> Self
where M: HasForeignKey<R>,

Adds an INNER JOIN automatically resolving the parent entity foreign keys.

Source

pub fn group_by(self, clause: &str) -> Self

Source

pub fn having<E: IntoExpr<M>>(self, expr: E) -> Self

Source

pub fn order_by(self, clause: &str) -> Self

Source

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

Source

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

Source

pub fn into_raw(self, executor: &mut impl Executor) -> OrmResult<Vec<Row>>

Executes the query and returns raw Row results without model mapping.

Source

pub fn all(self, executor: &mut impl Executor) -> OrmResult<Vec<M>>

Executes the query and returns a list of models.

Source

pub fn paginate(self, page_size: usize) -> Paginator<M>

Converts this query builder into a Paginator using the specified page size.

Source

pub fn one(self, executor: &mut impl Executor) -> OrmResult<Option<M>>

Executes the query, returning the first matching model, or None if not found.

Source

pub fn count(self, executor: &mut impl Executor) -> OrmResult<i64>

Executes a COUNT(*) query for the current filters.

Trait Implementations§

Source§

impl<M> Clone for QueryBuilder<M>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<M: Model + Send + Sync> Default for QueryBuilder<M>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<M> Freeze for QueryBuilder<M>

§

impl<M> RefUnwindSafe for QueryBuilder<M>
where M: RefUnwindSafe,

§

impl<M> Send for QueryBuilder<M>
where M: Send,

§

impl<M> Sync for QueryBuilder<M>
where M: Sync,

§

impl<M> Unpin for QueryBuilder<M>
where M: Unpin,

§

impl<M> UnsafeUnpin for QueryBuilder<M>

§

impl<M> UnwindSafe for QueryBuilder<M>
where M: UnwindSafe,

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.