Struct Clause 

pub struct Clause<'q, T> { /* private fields */ }

Implementations

impl<'q, T> Clause<'q, T>

pub fn this(self) -> Self

pub fn into<C>(self) -> Clause<'q, C>

Force convert clause type

pub fn combine_raw( self, raw_sql: &str, params: &[&'q (dyn ToSql + Sync)], ) -> Self

pub fn union<C>(self, clause: Clause<'q, C>) -> Clause<'q, ()>

pub fn union_all<C>(self, clause: Clause<'q, C>) -> Clause<'q, ()>

pub fn debug(self) -> Self

This method will call println!("{:?}", &self) to show temporary SQL result

impl<'q> Clause<'q, Condition>

pub fn cast(self, sql_type: &str) -> Clause<'q, Condition>

pub fn and_col(self, column: &str) -> Clause<'q, Column>

pub fn or_col(self, column: &str) -> Clause<'q, Column>

pub fn and_cond(self, cond: Clause<'q, Condition>) -> Clause<'q, Condition>

pub fn or_cond(self, cond: Clause<'q, Condition>) -> Clause<'q, Condition>

impl<'q> Clause<'q, Delete>

pub fn where_col( self, column: &str, value: Clause<'q, Condition>, ) -> Clause<'q, DeleteWhere>

pub fn where_cond(self, cond: Clause<'q, Condition>) -> Clause<'q, DeleteWhere>

impl<'q> Clause<'q, DeleteWhere>

pub fn and(self, condition: Clause<'q, Condition>) -> Clause<'q, DeleteWhere>

pub fn or(self, condition: Clause<'q, Condition>) -> Clause<'q, DeleteWhere>

impl<'q> Clause<'q, Insert>

pub fn on_conflict_do_nothing(self) -> Clause<'q, ()>

pub fn on_conflict(self, cols: Clause<'q, Column>) -> OnConflictHandle<'q>

impl<'q> Clause<'q, Where>

pub fn group_by_cols(self, columns: &[&str]) -> Clause<'q, Group>

pub fn group_by<C>(self, group: Clause<'_, C>) -> Clause<'q, Group>

pub fn limit(self, limit: &'q i64) -> Clause<'q, Paging>

pub fn offset(self, offset: &'q i64) -> Clause<'q, Paging>

impl<'q> Clause<'q, Paging>

pub fn limit(self, limit: &'q i64) -> Clause<'q, ()>

pub fn offset(self, offset: &'q i64) -> Clause<'q, ()>

impl<'q> Clause<'q, Group>

pub fn order_by_cols(self, columns: &[&str]) -> Clause<'q, Order>

pub fn limit(self, limit: &'q i64) -> Clause<'q, Paging>

pub fn offset(self, offset: &'q i64) -> Clause<'q, Paging>

impl<'q> Clause<'q, Order>

pub fn limit(self, limit: &'q i64) -> Clause<'q, Paging>

pub fn offset(self, offset: &'q i64) -> Clause<'q, Paging>

impl<'q> Clause<'q, Select>

pub fn select<T>(self, clause: Clause<'q, T>) -> Clause<'q, Select>

Add more column in SELECT statement

Arguments

• clause:

returns: Clause

Examples

use ngb_sqlbuilder::select;

.select(col("t1.ColName as Alias"))

 , t1."ColName" as "Alias"

pub fn from(self, table: &str) -> Clause<'q, From>

pub fn from_subquery<T>( self, sub: Clause<'q, T>, alias: &str, ) -> Clause<'q, From>

impl<'q> Clause<'q, From>

pub fn join( self, table: &str, join_method: Clause<'q, Join>, ) -> Clause<'q, From>

pub fn left_join( self, table: &str, join_method: Clause<'q, Join>, ) -> Clause<'q, From>

pub fn left_outer_join( self, table: &str, join_method: Clause<'q, Join>, ) -> Clause<'q, From>

pub fn right_join( self, table: &str, join_method: Clause<'q, Join>, ) -> Clause<'q, From>

pub fn right_outer_join( self, table: &str, join_method: Clause<'q, Join>, ) -> Clause<'q, From>

pub fn where_col( self, name: &str, condition: Clause<'q, Condition>, ) -> Clause<'q, Where>

pub fn where_cond(self, condition: Clause<'q, Condition>) -> Clause<'q, Where>

pub fn limit(self, limit: &'q i64) -> Clause<'q, ()>

pub fn offset(self, offset: &'q i64) -> Clause<'q, ()>

impl<'q> Clause<'q, Where>

pub fn and( self, name: &str, condition: Clause<'q, Condition>, ) -> Clause<'q, Where>

pub fn or( self, name: &str, condition: Clause<'q, Condition>, ) -> Clause<'q, Where>

pub fn and_nest(self, clause: Clause<'q, Condition>) -> Clause<'q, Where>

pub fn or_nest(self, clause: Clause<'q, Condition>) -> Clause<'q, Where>

pub fn order_by_cols(self, columns: &[&str]) -> Clause<'q, Order>

impl<'q> Clause<'q, Update>

pub fn set( self, map: &[(&str, &'q (dyn ToSql + Sync + 'q))], ) -> Clause<'q, UpdateSet>

impl<'q> Clause<'q, UpdateSet>

pub fn where_col( self, name: &str, condition: Clause<'q, Condition>, ) -> Clause<'q, UpdateWhere>

pub fn where_cond( self, condition: Clause<'q, Condition>, ) -> Clause<'q, UpdateWhere>

impl<'q> Clause<'q, UpdateWhere>

pub fn and(self, condition: Clause<'q, Condition>) -> Clause<'q, UpdateWhere>

pub fn or(self, condition: Clause<'q, Condition>) -> Clause<'q, UpdateWhere>

pub fn and_nest( self, condition: Clause<'q, Condition>, ) -> Clause<'q, UpdateWhere>

Add AND and a nested condition

Arguments

• condition:

returns: Clause<UpdateWhere>

Examples

where_col("t.Id", eq(&id)).and_wrap(col("t.Date").lt(&date).or_col("t.Status").gt(&status))
// SQL: ... WHERE t."Id" = $1 AND (t."Date" < $2 OR t."Status > $3)

pub fn or_nest( self, condition: Clause<'q, Condition>, ) -> Clause<'q, UpdateWhere>

Add OR and a nested condition

Arguments

• condition:

returns: Clause<UpdateWhere>

Examples

where_col("t.Id", eq(&id)).or_wrap(col("t.Date").lt(&date).or_col("t.Status").gt(&status))
// SQL: ... WHERE t."Id" = $1 OR (t."Date" < $2 OR t."Status > $3)

impl<'q> Clause<'q, Column>

pub fn alias(self, value: &str) -> Self

Add alias to column

Arguments

• value: alias name

returns: Clause

Examples

use ngb_sqlbuilder::col;

col("t.ColName").alias("col_name")
// SQL: t."ColName" as "col_name"

pub fn cast(self, sql_type: &str) -> Self

Add cast statement

Arguments

• sql_type: SQL type

returns: Clause

Examples

use ngb_sqlbuilder::col;

col("t.ColName").cast("text")
// SQL: t."ColName"::text

pub fn eq<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Add equal column = value comparison

Arguments

• value: value to compare. Will be parameterized to $n.

returns: Clause

Examples

pub fn neq<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Add not equal column != value comparison

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn lt<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column < value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn gt<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column > value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn lte<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column <= value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn gte<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column >= value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn like<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column like value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn ilike<T: ToSql + Sync + 'q>(self, value: &'q T) -> Clause<'q, Condition>

Compare column ilike value

Arguments

• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn between<T: ToSql + Sync + 'q>( self, low: &'q T, high: &'q T, ) -> Clause<'q, Condition>

Compare column between low and high

Arguments

• low: bottom limit, will be parameterized to $n
• high: top limit, will be parameterized to $n

returns: Clause

Examples

pub fn op<T: ToSql + Sync + 'q>( self, op: &str, value: &'q T, ) -> Clause<'q, Condition>

Custom operator comparison column op value

Arguments

• op: operator
• value: value to compare, will be parameterized to $n

returns: Clause

Examples

pub fn is_true(self) -> Clause<'q, Condition>

pub fn is_false(self) -> Clause<'q, Condition>

pub fn is_null(self) -> Clause<'q, Condition>

pub fn is_not_null(self) -> Clause<'q, Condition>

pub fn raw(self, raw_sql: &str) -> Clause<'q, Column>

Add raw, unchecked statement.

Arguments

• raw_sql: SQL statement

returns: Clause

Examples

use ngb_sqlbuilder::col;

col("t.ColName").raw("is not null")
// SQL: t."ColName" is not null

pub fn coalesce_raw(self, value: &str) -> Self

Set default value if null

Arguments

• value: default value, will be rendered directly, no filter.

returns: Clause

Examples

use ngb_sqlbuilder::col;

col("t.ColName").coalesce_raw("0")
// SQL: coalesce(t."ColName", 0)

col("t.TextValue").coalesce_raw("'empty'")
// SQL: coalesce(t."ColName", 'empty')

pub fn coalesce<T: ToSql + Sync + 'q>( self, value: &'q T, ) -> Clause<'q, Condition>

Set default value if null

Arguments

• value: default value, will be parameterized to $n

returns: Clause

Examples

use ngb_sqlbuilder::col;

col("t.ColName").coalesce(0)
// SQL: coalesce(t."ColName", $n)

Trait Implementations

impl<'q, T> Build<'q> for Clause<'q, T>

fn build(self) -> (String, Vec<&'q (dyn ToSql + Sync)>)

Build and compile query into SQL syntax with numbered parameters

impl<T> Clone for Clause<'_, T>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'q, T> Debug for Clause<'q, T>

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

Formats the value using the given formatter.

impl<'q, T> Display for Clause<'q, T>

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

Formats the value using the given formatter.

impl<'q, T> SqlClause<'q> for Clause<'q, T>

fn unwrap(self) -> (String, Vec<&'q (dyn ToSql + Sync)>)

fn unwrap_ref(&self) -> (&str, &[&'q (dyn ToSql + Sync)])