Struct QueryBuilder 

pub struct QueryBuilder<T> { /* private fields */ }

Simplified query builder for ClickHouse.

Provides a fluent API to construct SQL queries safely, ensuring column names belong to the specified table.

Example

let sql = QueryBuilder::<User>::new()
    .select(User::NAME)
    .filter(User::AGE, Operator::Gt, 18)
    .to_sql();

Implementations

impl<T: ClickTable> QueryBuilder<T>

pub fn new() -> Self

Create a new query builder for the given table.

pub fn select<C: TypedColumn<Table = T>>(self, _col: C) -> Self

Add a typed column to the SELECT clause.

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

Add a raw expression string to the SELECT clause. Useful for aggregate functions like count(), sum(field), etc.

pub fn join<T2: ClickTable, J: JoinType>( self, join_spec: JoinSpec<T, T2, J>, ) -> Self

Add a JOIN clause using a JoinSpec.

Example

use clicktype::query::{QueryBuilder, inner_join};

let query = QueryBuilder::<User>::new()
    .select(User::NAME)
    .join(inner_join::<User, Order>().on(User::ID, Order::USER_ID))
    .to_sql();

pub fn join_raw(self, join_clause: impl Into<String>) -> Self

Add a raw JOIN string.

pub fn filter<C: TypedColumn<Table = T>, V: SqlValue>( self, _col: C, op: Operator, value: V, ) -> Self

Add a WHERE condition with type-safe column and operator.

The value is automatically converted to a safe SQL string representation.

Example

.filter(User::ID, Operator::Eq, 42)
.filter(User::NAME, Operator::Eq, "Alice") // Automatically quoted

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

Add a raw WHERE condition string.

pub fn order_by<C: TypedColumn<Table = T>>(self, _col: C, desc: bool) -> Self

Add an ORDER BY clause for a specific column.

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

Add a raw string to the ORDER BY clause.

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

Add a LIMIT clause.

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

Add an OFFSET clause.

pub fn group_by<C: TypedColumn<Table = T>>(self, _col: C) -> Self

Add a GROUP BY clause for a typed column.

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

Add a raw string to the GROUP BY clause.

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

Add a raw HAVING clause.

pub fn to_sql(&self) -> String

Render the final SQL query string.

Trait Implementations

impl<T: Clone> Clone for QueryBuilder<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for QueryBuilder<T>

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

Formats the value using the given formatter.