cake - v2.1.0

cake/where

Used to build WHERE clauses for SQL queries.

Where clauses are used to filter rows in a table.

Also used to build HAVING clauses for SQL queries, because they work the same way as WHERE clauses, but are used to filter rows after GROUP BY has been applied.

Compatibility

Types

Fragment

</> 
pub type Fragment =
  read_query.Fragment

ReadQuery

</> 
pub type ReadQuery =
  read_query.ReadQuery

Where

</> 
pub type Where =
  read_query.Where

WhereValue

</> 
pub type WhereValue =
  read_query.WhereValue

Functions

and

</> 
pub fn and(wheres whrs: List(Where)) -> Where

Logical AND of multiple Wheres.

between

</> 
pub fn between(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
  value_c vl_c: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue A is between two WhereValues B and C.

col

</> 
pub fn col(name: String) -> WhereValue

Creates a WhereValue from a column name String.

eq

</> 
pub fn eq(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue equals another WhereValue.

eq_all_query

</> 
pub fn eq_all_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue matches all in a sub-query.

NOTICE: Not supported by 🪶SQLite.

eq_any_query

</> 
pub fn eq_any_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue matches any in a sub-query.

NOTICE: Not supported by 🪶SQLite.

exists_in_query

</> 
pub fn exists_in_query(sub_query qry: ReadQuery) -> Where

Creates a WHERE clause that checks if it exists in a sub-query.

false

</> 
pub fn false() -> WhereValue

Creates a FALSE WhereValue.

Notice: You probably want to use where.is_false() instead.

float

</> 
pub fn float(v vl: Float) -> WhereValue

Creates a WhereValue from a Float.

fragment

</> 
pub fn fragment(fragment frgmt: Fragment) -> Where

Creates a WhereFragment from a Fragment.

fragment_value

</> 
pub fn fragment_value(fragment frgmt: Fragment) -> WhereValue

Creates a WhereValue from a Fragment.

gt

</> 
pub fn gt(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater than another WhereValue.

gt_all_query

</> 
pub fn gt_all_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater than all in a sub-query.

NOTICE: Not supported by 🪶SQLite.

gt_any_query

</> 
pub fn gt_any_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater than any in a sub-query.

NOTICE: Not supported by 🪶SQLite.

gte

</> 
pub fn gte(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater or equal to another WhereValue.

gte_all_query

</> 
pub fn gte_all_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater or equal to all in a sub-query.

NOTICE: Not supported by 🪶SQLite.

gte_any_query

</> 
pub fn gte_any_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is greater or equal to any in a sub-query.

NOTICE: Not supported by 🪶SQLite.

ilike

</> 
pub fn ilike(
  value vl: WhereValue,
  pattern pttrn: String,
) -> Where

Creates a WHERE clause that checks if a WhereValue matches a pattern.

ilike is the same as like but case-insensitive.

in

</> 
pub fn in(
  value vl: WhereValue,
  values vals: List(WhereValue),
) -> Where

Creates a WHERE clause that checks if a WhereValue is in a list of WhereValues.

in_query

</> 
pub fn in_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is IN a sub-query.

NOTICE: Usually the sub-query must return a single column.

int

</> 
pub fn int(v vl: Int) -> WhereValue

Creates a WhereValue from an Int.

is_bool

</> 
pub fn is_bool(value vl: WhereValue, bool b: Bool) -> Where

Creates a WHERE clause that checks if a WhereValue matches a Bool.

is_false

</> 
pub fn is_false(value vl: WhereValue) -> Where

Creates a WHERE clause that checks if a WhereValue is False.

is_not_bool

</> 
pub fn is_not_bool(value vl: WhereValue, bool b: Bool) -> Where

Creates a WHERE clause that checks if a WhereValue does not match a Bool.

is_not_null

</> 
pub fn is_not_null(value vl: WhereValue) -> Where

Creates a WHERE clause that checks if a WhereValue is not SQL NULL.

is_null

</> 
pub fn is_null(value vl: WhereValue) -> Where

Creates a WHERE clause that checks if a WhereValue is SQL NULL.

is_true

</> 
pub fn is_true(value vl: WhereValue) -> Where

Creates a WHERE clause that checks if a WhereValue is True.

like

</> 
pub fn like(value vl: WhereValue, pattern pttrn: String) -> Where

Creates a WHERE clause that checks if a WhereValue matches a pattern. The pattern can contain for example the following wildcards:

  • % matches any sequence of characters.
  • _ matches any single character.

lt

</> 
pub fn lt(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue lower than another WhereValue.

lt_all_query

</> 
pub fn lt_all_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is lower than all in a sub-query.

NOTICE: Not supported by 🪶SQLite.

lt_any_query

</> 
pub fn lt_any_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is lower than an any in a sub-query.

NOTICE: Not supported by 🪶SQLite.

lte

</> 
pub fn lte(
  value_a vl_a: WhereValue,
  value_b vl_b: WhereValue,
) -> Where

Creates a WHERE clause that checks if a WhereValue lower or equal to another WhereValue.

lte_all_query

</> 
pub fn lte_all_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is lower or equal to all in a sub-query.

NOTICE: Not supported by 🪶SQLite.

lte_any_query

</> 
pub fn lte_any_query(
  value vl: WhereValue,
  sub_query qry: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is lower or equal to any in a sub-query.

NOTICE: Not supported by 🪶SQLite.

none

</> 
pub fn none() -> Where

No where condition.

not

</> 
pub fn not(where whr: Where) -> Where

Negates a Where.

null

</> 
pub fn null() -> WhereValue

Creates a NULL WhereValue.

or

</> 
pub fn or(wheres whrs: List(Where)) -> Where

Logical OR of multiple Wheres.

similar_to

</> 
pub fn similar_to(
  value vl: WhereValue,
  to pttrn: String,
  escape_with escp_char: String,
) -> Where

Creates a WHERE clause that checks if a WhereValue is similar to a pattern.

NOTICE: Not supported by 🪶SQLite.

string

</> 
pub fn string(v vl: String) -> WhereValue

Creates a WhereValue from a String.

sub_query

</> 
pub fn sub_query(query qry: ReadQuery) -> WhereValue

Creates a WhereValue off a ReadQuery.

NOTICE: Usually the sub-query must return a single column.

true

</> 
pub fn true() -> WhereValue

Creates a TRUE WhereValue.

Notice: You probably want to use where.is_true() instead.

xor

</> 
pub fn xor(wheres whrs: List(Where)) -> Where

Logical XOR of multiple Wheres.

✨ Search Document