Struct QueryBuilder 

pub struct QueryBuilder<E>
where
    E: Entity,
{ /* private fields */ }

Query Builder for constructing type-safe SQL queries

Type Parameters

• E - The Entity type this query is built for

Example

use ormkit::query::{QueryBuilder, FilterOp, Order};

let query = QueryBuilder::<User>::new()
    .filter("email", FilterOp::Eq, "user@example.com")
    .order("created_at", Order::Desc)
    .limit(10)
    .build();

Implementations

impl<E> QueryBuilder<E>

where E: Entity,

pub fn new() -> Self

Create a new QueryBuilder for entity E

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

Add a SELECT clause

Arguments

• column - The column name to select

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

Add multiple SELECT clauses

Arguments

• columns - Iterator of column names to select

pub fn select_raw(self, expr: impl Into<String>) -> Self

Add a raw SELECT expression

Arguments

• expr - The raw SQL expression

Warning

This bypasses type safety. Use with caution.

pub fn filter( self, column: impl Into<String>, op: FilterOp, value: impl Into<String>, ) -> Self

Add a WHERE filter

Arguments

• column - The column name to filter on
• op - The filter operator
• value - The filter value

Example

let query = QueryBuilder::<User>::new()
    .filter("age", FilterOp::Gt, 18);

pub fn filter_in( self, column: impl Into<String>, op: FilterOp, values: Vec<impl Into<String>>, ) -> Self

Add a WHERE filter with multiple values (for IN/NOT IN)

Arguments

• column - The column name to filter on
• op - The filter operator (should be In or NotIn)
• values - The filter values

pub fn filter_between( self, column: impl Into<String>, low: impl Into<String>, high: impl Into<String>, ) -> Self

Add a WHERE filter with a range (for BETWEEN)

Arguments

• column - The column name to filter on
• low - The low value
• high - The high value

pub fn filter_raw(self, expr: impl Into<String>) -> Self

Add a raw WHERE filter

Arguments

• expr - The raw SQL expression

Warning

This bypasses type safety. Use with caution and never interpolate user input directly.

pub fn join( self, join_type: JoinType, table: impl Into<String>, on_column: impl Into<String>, on_foreign_column: impl Into<String>, ) -> Self

Add a JOIN clause

Arguments

• join_type - The type of join
• table - The table to join
• on_column - The column in the current table
• on_foreign_column - The column in the joined table

pub fn inner_join( self, table: impl Into<String>, on_column: impl Into<String>, on_foreign_column: impl Into<String>, ) -> Self

Add an INNER JOIN

Arguments

• table - The table to join
• on_column - The column in the current table
• on_foreign_column - The column in the joined table

pub fn left_join( self, table: impl Into<String>, on_column: impl Into<String>, on_foreign_column: impl Into<String>, ) -> Self

Add a LEFT JOIN

Arguments

• table - The table to join
• on_column - The column in the current table
• on_foreign_column - The column in the joined table

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

Add an ORDER BY clause

Arguments

• column - The column name to order by
• order - The sort direction

pub fn order_with_table( self, table: impl Into<String>, column: impl Into<String>, order: Order, ) -> Self

Add an ORDER BY clause with explicit table

Arguments

• table - The table name
• column - The column name
• order - The sort direction

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

Add a LIMIT clause

Arguments

• limit - The maximum number of rows to return

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

Add an OFFSET clause

Arguments

• offset - The number of rows to skip

pub fn distinct(self) -> Self

Add DISTINCT to the SELECT

pub fn build(self) -> BuiltQuery

Build the query

Returns a BuiltQuery that can be executed

pub async fn fetch_all<T>(self, pool: &PgPool) -> Result<Vec<T>, Error>

where T: for<'r> FromRow<'r, PgRow> + Unpin + Send,

Build and execute the query, fetching all results

Arguments

• pool - The database connection pool

Returns

A vector of results

pub async fn fetch_one<T>(self, pool: &PgPool) -> Result<T, Error>

where T: for<'r> FromRow<'r, PgRow> + Unpin + Send,

Build and execute the query, fetching the first result

Arguments

• pool - The database connection pool

Returns

The first result or an error

pub async fn fetch_optional<T>(self, pool: &PgPool) -> Result<Option<T>, Error>

where T: for<'r> FromRow<'r, PgRow> + Unpin + Send,

Build and execute the query, fetching the first result or None

Arguments

• pool - The database connection pool

Returns

An optional result

Trait Implementations

impl<E> Clone for QueryBuilder<E>

where E: Entity + Clone,

fn clone(&self) -> QueryBuilder<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> Debug for QueryBuilder<E>

where E: Entity + Debug,

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

Formats the value using the given formatter.

impl<E> Default for QueryBuilder<E>

where E: Entity,

fn default() -> Self

Returns the “default value” for a type.