Struct QueryBuilder

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

A query builder for the model entity.

Examples

use crate::model::{User, UserColumn};
use zino_core::orm::{QueryBuilder, Schema};

let query = QueryBuilder::<User>::new()
    .and_not_in(UserColumn::Status, ["Deleted", "Locked"])
    .or(QueryBuilder::<User>::new()
        .and_eq(UserColumn::Roles, "worker")
        .and_eq(UserColumn::Visibility, "Public"))
    .or(QueryBuilder::<User>::new()
        .and_in(UserColumn::Roles, ["admin", "auditor"])
        .and_ne(UserColumn::Visibility, "Public"))
    .order_desc(UserColumn::UpdatedAt)
    .limit(10)
    .build();
let users: Vec<User> = User::find(&query).await?;

Implementations

impl<E: Entity> QueryBuilder<E>

pub fn new() -> Self

Creates a new instance.

pub fn field(self, col: E::Column) -> Self

Adds a field corresponding to the column.

pub fn fields<V: Into<Vec<E::Column>>>(self, cols: V) -> Self

Adds the fields corresponding to the columns.

pub fn alias(self, col: E::Column, alias: &str) -> Self

Adds a field with an alias for the column.

pub fn aggregate(self, aggregation: Aggregation<E>, alias: Option<&str>) -> Self

Adds a field with an optional alias for the aggregate function.

pub fn window(self, window: Window<E>, alias: Option<&str>) -> Self

Adds a field with an optional alias for the window function.

pub fn group_by(self, col: E::Column) -> Self

Adds a GROUP BY column.

pub fn having_filter( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition using the value as a filter for the column.

pub fn having_eq( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for equal parts.

pub fn having_ne( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for non-equal parts.

pub fn having_lt( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for the column less than a value.

pub fn having_le( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for the column not greater than a value.

pub fn having_gt( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for the column greater than a value.

pub fn having_ge( self, aggregation: Aggregation<E>, value: impl IntoSqlValue, ) -> Self

Adds a HAVING condition for the column not less than a value.

pub fn primary_key(self, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for the primary key.

pub fn rand(self, value: impl IntoSqlValue) -> Self

Adds a logical AND condition which selects random items by rand() < value.

pub fn and<M: Entity>(self, other: QueryBuilder<M>) -> Self

Adds a logical AND condition by merging the other query builder.

pub fn and_not<M: Entity>(self, other: QueryBuilder<M>) -> Self

Adds a logical AND NOT condition by merging the other query builder.

pub fn and_filter(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition using the value as a filter for the column.

pub fn and_eq(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for equal parts.

pub fn and_eq_if_not_null( self, col: E::Column, value: impl IntoSqlValue, ) -> Self

Adds a logical AND condition for equal parts if the value is not null.

pub fn and_eq_if_some<T: IntoSqlValue>( self, col: E::Column, value: Option<T>, ) -> Self

Adds a logical AND condition for equal parts if the value is not none.

pub fn and_ne(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for non-equal parts.

pub fn and_ne_if_not_null( self, col: E::Column, value: impl IntoSqlValue, ) -> Self

Adds a logical AND condition for non-equal parts if the value is not null.

pub fn and_ne_if_some<T: IntoSqlValue>( self, col: E::Column, value: Option<T>, ) -> Self

Adds a logical AND condition for non-equal parts if the value is not none.

pub fn and_lt(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for the column less than a value.

pub fn and_le(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for the column not greater than a value.

pub fn and_gt(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for the column greater than a value.

pub fn and_ge(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical AND condition for the column not less than a value.

pub fn and_in<T, V>(self, col: E::Column, values: V) -> Self

where T: IntoSqlValue, V: Into<Vec<T>>,

Adds a logical AND condition for the column IN a list of values.

pub fn and_not_in<T, V>(self, col: E::Column, values: V) -> Self

where T: IntoSqlValue, V: Into<Vec<T>>,

Adds a logical AND condition for the column NOT IN a list of values.

pub fn and_in_subquery<C, M>(self, cols: C, subquery: QueryBuilder<M>) -> Self

where C: Into<Vec<E::Column>>, M: Entity + Schema,

Adds a logical AND condition for the columns IN a subquery.

pub fn and_not_in_subquery<C, M>( self, cols: C, subquery: QueryBuilder<M>, ) -> Self

where C: Into<Vec<E::Column>>, M: Entity + Schema,

Adds a logical AND condition for the columns NOT IN a subquery.

pub fn and_in_range<T: IntoSqlValue>( self, col: E::Column, min: T, max: T, ) -> Self

Adds a logical AND condition for the column in a range [min, max).

pub fn and_between<T: IntoSqlValue>( self, col: E::Column, min: T, max: T, ) -> Self

Adds a logical AND condition for the column BETWEEN two values.

pub fn and_like(self, col: E::Column, value: String) -> Self

Adds a logical AND condition for the column LIKE a string value.

pub fn and_ilike(self, col: E::Column, value: String) -> Self

Adds a logical AND condition for the column ILIKE a string value.

pub fn and_rlike(self, col: E::Column, value: String) -> Self

Adds a logical AND condition for the column RLIKE a string value.

pub fn and_contains(self, col: E::Column, value: &str) -> Self

Adds a logical AND condition for the column which contains a string value.

pub fn and_starts_with(self, col: E::Column, value: &str) -> Self

Adds a logical AND condition for the column which starts with a string value.

pub fn and_ends_with(self, col: E::Column, value: &str) -> Self

Adds a logical AND condition for the column which ends with a string value.

pub fn and_null(self, col: E::Column) -> Self

Adds a logical AND condition for the column which is null.

pub fn and_not_null(self, col: E::Column) -> Self

Adds a logical AND condition for the column which is not null.

pub fn and_empty(self, col: E::Column) -> Self

Adds a logical AND condition for the column which is an empty string or a null.

pub fn and_nonempty(self, col: E::Column) -> Self

Adds a logical AND condition for the column which is not an empty string or a null.

pub fn and_overlaps<T: IntoSqlValue>( self, cols: (E::Column, E::Column), values: (T, T), ) -> Self

Adds a logical AND condition for the two ranges which overlaps with each other.

pub fn or<M: Entity>(self, other: QueryBuilder<M>) -> Self

Adds a logical OR condition by merging the other query builder.

pub fn or_not<M: Entity>(self, other: QueryBuilder<M>) -> Self

Adds a logical OR NOT condition by merging the other query builder.

pub fn or_filter(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition using the value as a filter for the column.

pub fn or_eq(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for equal parts.

pub fn or_eq_if_not_null(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for equal parts if the value is not null.

pub fn or_eq_if_some<T: IntoSqlValue>( self, col: E::Column, value: Option<T>, ) -> Self

Adds a logical OR condition for equal parts if the value is not none.

pub fn or_ne(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for non-equal parts.

pub fn or_ne_if_not_null(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for non-equal parts if the value is not none.

pub fn or_ne_if_some<T: IntoSqlValue>( self, col: E::Column, value: Option<T>, ) -> Self

Adds a logical OR condition for non-equal parts if the value is not none.

pub fn or_lt(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for the column less than a value.

pub fn or_le(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for the column not greater than a value.

pub fn or_gt(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for the column greater than a value.

pub fn or_ge(self, col: E::Column, value: impl IntoSqlValue) -> Self

Adds a logical OR condition for the column not less than a value.

pub fn or_in<T, V>(self, col: E::Column, values: V) -> Self

where T: IntoSqlValue, V: Into<Vec<T>>,

Adds a logical OR condition for the column IN a list of values.

pub fn or_not_in<T, V>(self, col: E::Column, values: V) -> Self

where T: IntoSqlValue, V: Into<Vec<T>>,

Adds a logical OR condition for the column NOT IN a list of values.

pub fn or_in_subquery<C, M>(self, cols: C, subquery: QueryBuilder<M>) -> Self

where C: Into<Vec<E::Column>>, M: Entity + Schema,

Adds a logical OR condition for the columns IN a subquery.

pub fn or_not_in_subquery<C, M>( self, cols: C, subquery: QueryBuilder<M>, ) -> Self

where C: Into<Vec<E::Column>>, M: Entity + Schema,

Adds a logical OR condition for the columns NOT IN a subquery.

pub fn or_in_range<T: IntoSqlValue>( self, col: E::Column, min: T, max: T, ) -> Self

Adds a logical OR condition for the column is in a range [min, max).

pub fn or_between<T: IntoSqlValue>(self, col: E::Column, min: T, max: T) -> Self

Adds a logical OR condition for the column BETWEEN two values.

pub fn or_like(self, col: E::Column, value: String) -> Self

Adds a logical OR condition for the column LIKE a string value.

pub fn or_ilike(self, col: E::Column, value: String) -> Self

Adds a logical OR condition for the column ILIKE a string value.

pub fn or_rlike(self, col: E::Column, value: String) -> Self

Adds a logical OR condition for the column RLIKE a string value.

pub fn or_contains(self, col: E::Column, value: &str) -> Self

Adds a logical OR condition for the column which contains a string value.

pub fn or_starts_with(self, col: E::Column, value: &str) -> Self

Adds a logical OR condition for the column which starts with a string value.

pub fn or_ends_with(self, col: E::Column, value: &str) -> Self

Adds a logical OR condition for the column which ends with a string value.

pub fn or_null(self, col: E::Column) -> Self

Adds a logical OR condition for the column which is null.

pub fn or_not_null(self, col: E::Column) -> Self

Adds a logical OR condition for the column which is not null.

pub fn or_empty(self, col: E::Column) -> Self

Adds a logical OR condition for the column which is an empty string or a null.

pub fn or_nonempty(self, col: E::Column) -> Self

Adds a logical OR condition for the column which is not an empty string or a null.

pub fn or_overlaps<T: IntoSqlValue>( self, cols: (E::Column, E::Column), values: (T, T), ) -> Self

Adds a logical OR condition for the two ranges which overlaps with each other.

pub fn order_by(self, col: impl ToString, descending: bool) -> Self

Adds a query order.

pub fn order_by_with_nulls( self, col: impl ToString, descending: bool, nulls_first: bool, ) -> Self

Adds a query order with an extra flag to indicate whether the nulls appear first or last.

pub fn order_asc(self, col: impl ToString) -> Self

Adds a query order with an ascending order.

pub fn order_desc(self, col: impl ToString) -> Self

Adds a query order with an descending order.

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

Sets the offset.

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

Sets the limit.

pub fn build(self) -> Query

Builds the model query.

impl<E: Entity + Schema> QueryBuilder<E>

pub fn build_subquery(self) -> String

Builds a subquery SQL expression.

Trait Implementations

impl<E: Clone + Entity> Clone for QueryBuilder<E>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<E: Debug + Entity> Debug for QueryBuilder<E>

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

Formats the value using the given formatter.

impl<E: Entity> Default for QueryBuilder<E>

fn default() -> Self

Returns the “default value” for a type.

impl<E: Entity + Schema> IntoSqlValue for QueryBuilder<E>

fn into_sql_value(self) -> JsonValue

Converts self to a SQL value.