cake - v4.0.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 =
  @internal Fragment

ReadQuery

</> 
pub type ReadQuery =
  @internal ReadQuery

Where

</> 
pub type Where =
  @internal Where

WhereValue

</> 
pub type WhereValue =
  @internal WhereValue

Values

and

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

Logical AND of multiple Wheres.

between

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

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

bool

</> 
pub fn bool(value value: Bool) -> WhereValue

Creates a WhereValue from a Bool.

col

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

Creates a WhereValue from a column name String.

date

</> 
pub fn date(value value: calendar.Date) -> WhereValue

Creates a WhereValue from a calendar.Date.

eq

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

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

eq_all_query

</> 
pub fn eq_all_query(
  value value: WhereValue,
  sub_query query: 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 value: WhereValue,
  sub_query query: 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 query: 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(value value: Float) -> WhereValue

Creates a WhereValue from a Float.

fragment

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

Creates a WhereFragment from a Fragment.

fragment_value

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

Creates a WhereValue from a Fragment.

gt

</> 
pub fn gt(
  value_a value_a: WhereValue,
  value_b value_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 value: WhereValue,
  sub_query query: 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 value: WhereValue,
  sub_query query: 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 value_a: WhereValue,
  value_b value_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 value: WhereValue,
  sub_query query: 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 value: WhereValue,
  sub_query query: 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 value: WhereValue,
  pattern pattern: 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 value: WhereValue,
  values values: 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 value: WhereValue,
  sub_query query: 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(value value: Int) -> WhereValue

Creates a WhereValue from an Int.

is_bool

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

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

is_false

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

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

is_not_bool

</> 
pub fn is_not_bool(
  value value: WhereValue,
  bool bool: 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 value: WhereValue) -> Where

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

is_null

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

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

is_true

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

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

like

</> 
pub fn like(
  value value: WhereValue,
  pattern pattern: 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 value_a: WhereValue,
  value_b value_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 value: WhereValue,
  sub_query query: 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 value: WhereValue,
  sub_query query: 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 value_a: WhereValue,
  value_b value_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 value: WhereValue,
  sub_query query: 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 value: WhereValue,
  sub_query query: 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.

neq

</> 
pub fn neq(
  value_a value_a: WhereValue,
  value_b value_b: WhereValue,
) -> Where

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

neq_all_query

</> 
pub fn neq_all_query(
  value value: WhereValue,
  sub_query query: ReadQuery,
) -> Where

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

NOTICE: Not supported by 🪶SQLite.

neq_any_query

</> 
pub fn neq_any_query(
  value value: WhereValue,
  sub_query query: ReadQuery,
) -> Where

Creates a WHERE clause that checks if a WhereValue is not 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 where: Where) -> Where

Negates a Where.

null

</> 
pub fn null() -> WhereValue

Creates a NULL WhereValue.

or

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

Logical OR of multiple Wheres.

similar_to

</> 
pub fn similar_to(
  value value: WhereValue,
  to pattern: String,
  escape_with escape_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(value value: String) -> WhereValue

Creates a WhereValue from a String.

sub_query

</> 
pub fn sub_query(query query: 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 wheres: List(Where)) -> Where

Logical XOR of multiple Wheres.

Returns TRUE when exactly one condition is true.

Unlike xor_parity, which returns TRUE for any odd number of true conditions, xor is stricter: two or more true conditions yield FALSE.

Number of conditions trueResult
0FALSE
1TRUE
2FALSE
3FALSE
4FALSE

xor_parity

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

Logical XOR of multiple Wheres using left-associative binary XOR.

Unlike xor, which returns TRUE when exactly one condition is true, xor_parity returns TRUE when an odd number of conditions are true — matching the behaviour of MySQL’s and MariaDB’s native XOR operator.

Number of conditions trueResult
0FALSE
1TRUE
2FALSE
3TRUE
4FALSE

NULL handling: if any predicate evaluates to NULL, the entire expression evaluates to NULL, which a WHERE clause treats as no match (NULL-poisoning). This is consistent across all adapters:

  • 🐘PostgreSQL / 🪶SQLite emulate parity via integer arithmetic; a NULL predicate propagates as NULL through the sum and modulo.
  • 🦭MariaDB / 🐬MySQL use native XOR, where NULL XOR anything = NULL.

For adapters 🦭MariaDB or 🐬MySQL the native XOR syntax will be utilized under the hood.

✨ Search Document