Struct QueryBuilder

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

SQL query builder for complex queries

Provides a fluent interface for building SQL queries with support for:

  • Column selection and table joins
  • WHERE clauses with complex filtering
  • GROUP BY and HAVING clauses
  • ORDER BY with multiple sort criteria
  • LIMIT and OFFSET for pagination
  • Aggregate functions (COUNT, SUM, AVG, etc.)
  • DISTINCT queries

§Examples

use libsql_orm::{QueryBuilder, FilterOperator, Sort, SortOrder, JoinType};

// Basic query
let query = QueryBuilder::new("users")
    .select(vec!["id", "name", "email"])
    .r#where(FilterOperator::Eq("is_active".to_string(), Value::Boolean(true)))
    .order_by(Sort::new("name", SortOrder::Asc))
    .limit(10);

// Query with joins
let joined_query = QueryBuilder::new("posts")
    .select(vec!["posts.title", "users.name"])
    .join(JoinType::Inner, "users", "users.id = posts.user_id")
    .r#where(FilterOperator::Eq("posts.published".to_string(), Value::Boolean(true)));

// Aggregate query
let agg_query = QueryBuilder::new("orders")
    .aggregate(Aggregate::Sum, "amount", Some("total_amount"))
    .group_by(vec!["user_id"])
    .having(FilterOperator::Gt("total_amount".to_string(), Value::Real(1000.0)));

Implementations§

Source§

impl QueryBuilder

Source

pub fn new(table: impl Into<String>) -> Self

Create a new query builder

Source

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

Select specific columns

Source

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

Add a join clause

Source

pub fn join_as( self, join_type: JoinType, table: impl Into<String>, alias: impl Into<String>, condition: impl Into<String>, ) -> Self

Add a join clause with alias

Source

pub fn where(self, filter: FilterOperator) -> Self

Add a where clause

Source

pub fn group_by(self, columns: Vec<impl Into<String>>) -> Self

Add a group by clause

Source

pub fn having(self, filter: FilterOperator) -> Self

Add a having clause

Source

pub fn order_by(self, sort: Sort) -> Self

Add an order by clause

Source

pub fn order_by_multiple(self, sorts: Vec<Sort>) -> Self

Add multiple order by clauses

Source

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

Set limit

Source

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

Set offset

Source

pub fn distinct(self, distinct: bool) -> Self

Set distinct

Source

pub fn aggregate( self, function: Aggregate, column: impl Into<String>, alias: Option<impl Into<String>>, ) -> Self

Set aggregate function

Source

pub fn select_all(self) -> Self

Select all columns

Source

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

Select specific columns

Source

pub fn select_column(self, column: &str) -> Self

Select a single column

Source

pub fn select_count(self) -> Self

Select count

Source

pub fn select_aggregate(self, aggregate: &str) -> Self

Select aggregate

Source

pub fn select_distinct(self, column: &str) -> Self

Select distinct

Source

pub fn where_condition( self, condition: &str, _params: impl Into<Vec<Value>>, ) -> Self

Add where condition

Source

pub fn search(self, field: &str, query: &str) -> Self

Add search

Source

pub fn with_filter(self, filter: Filter) -> Self

Add filter

Source

pub fn with_filters(self, filters: Vec<Filter>) -> Self

Add filters

Source

pub fn with_sorts(self, sorts: Vec<Sort>) -> Self

Add sorts

Source

pub fn having_condition( self, condition: &str, _params: impl Into<Vec<Value>>, ) -> Self

Add having condition

Source

pub fn where_in(self, field: &str, subquery: QueryBuilder) -> Self

Add where in clause

Source

pub async fn execute_count(&self, db: &Database) -> Result<u64>

Execute count query

Source

pub async fn execute_aggregate(&self, db: &Database) -> Result<Vec<Row>>

Execute aggregate query

Source

pub fn build(&self) -> Result<(String, Vec<Value>)>

Build the SQL query

Source

pub fn build_count(&self) -> Result<(String, Vec<Value>)>

Build a count query

Source

pub async fn execute<T>(&self, db: &Database) -> Result<Vec<T>>

Execute the query

Source

pub async fn execute_paginated<T>( &self, db: &Database, pagination: &Pagination, ) -> Result<PaginatedResult<T>>

Execute the query with pagination

Trait Implementations§

Source§

impl Clone for QueryBuilder

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

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,