cake - v4.0.0

cake/select

A DSL to build SELECT queries.

Types

Comment

</> 
pub type Comment =
  @internal Comment

Direction

</>

Defines the direction of an OrderBy.

pub type Direction {
  Asc
  Desc
}

Constructors 

  • Asc
  • Desc

Epilog

</> 
pub type Epilog =
  @internal Epilog

Fragment

</> 
pub type Fragment =
  @internal Fragment

From

</> 
pub type From =
  @internal From

GroupBy

</> 
pub type GroupBy =
  @internal GroupBy

Join

</> 
pub type Join =
  @internal Join

Joins

</> 
pub type Joins =
  @internal Joins

Limit

</> 
pub type Limit =
  @internal Limit

Offset

</> 
pub type Offset =
  @internal Offset

OrderBy

</> 
pub type OrderBy =
  @internal OrderBy

OrderByDirection

</> 
pub type OrderByDirection =
  @internal OrderByDirection

ReadQuery

</> 
pub type ReadQuery =
  @internal ReadQuery

Select

</> 
pub type Select =
  @internal Select

SelectKind

</> 
pub type SelectKind =
  @internal SelectKind

SelectValue

</> 
pub type SelectValue =
  @internal SelectValue

Selects

</> 
pub type Selects =
  @internal Selects

Where

</> 
pub type Where =
  @internal Where

Values

alias

</> 
pub fn alias(
  value value: SelectValue,
  alias alias: String,
) -> SelectValue

Creates an alias SelectValue from String.

all

</> 
pub fn all(select select: Select) -> Select

Sets the kind of the Select query to return duplicates which is the default.

bool

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

Creates a SelectValue from a Bool.

col

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

Creates a column SelectValue from a String.

comment

</> 
pub fn comment(
  select select: Select,
  comment comment: String,
) -> Select

Appends a Comment to the Select query.

date

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

Creates a SelectValue from a calendar.Date.

distinct

</> 
pub fn distinct(select select: Select) -> Select

Sets the kind of the Select query to return distinct rows only.

epilog

</> 
pub fn epilog(
  select select: Select,
  epilog epilog: String,
) -> Select

Appends an Epilog to the Select query.

float

</> 
pub fn float(value value: Float) -> SelectValue

Creates a SelectValue from a Float.

fragment

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

Creates a SelectFragment off a Fragment.

from_query

</> 
pub fn from_query(
  select select: Select,
  sub_query sub_query: ReadQuery,
  alias alias: String,
) -> Select

Sets the FROM clause of the Select query to an aliased sub-query.

from_table

</> 
pub fn from_table(
  select select: Select,
  name table_name: String,
) -> Select

Sets the FROM clause of the Select query to a table name.

get_comment

</> 
pub fn get_comment(select select: Select) -> Comment

Gets the Comment from the Select query.

get_epilog

</> 
pub fn get_epilog(select select: Select) -> Epilog

Gets the Epilog from the Select query.

get_from

</> 
pub fn get_from(select select: Select) -> From

Gets the FROM clause of the Select query.

get_group_by

</> 
pub fn get_group_by(select select: Select) -> GroupBy

Gets GroupBy in the Select query.

get_having

</> 
pub fn get_having(select select: Select) -> Where

Gets HAVING in the Select query.

See function having on details why this returns a Where.

get_joins

</> 
pub fn get_joins(select select: Select) -> Joins

Gets the Joins of the Select query.

get_kind

</> 
pub fn get_kind(select select: Select) -> SelectKind

Gets the kind of the Select query.

get_limit

</> 
pub fn get_limit(select select: Select) -> Limit

Gets Limit in the Select query.

get_offset

</> 
pub fn get_offset(select select: Select) -> Offset

Gets Offset in the Select query.

get_order_by

</> 
pub fn get_order_by(select select: Select) -> OrderBy

Gets the OrderBy from the Select query.

get_select

</> 
pub fn get_select(select select: Select) -> Selects

Gets the SelectValues of the Select query.

get_where

</> 
pub fn get_where(select select: Select) -> Where

Gets the Where of the Select query.

group_by

</> 
pub fn group_by(
  select select: Select,
  group_by group_by: String,
) -> Select

Sets or appends GroupBy a single into an existing GroupBy.

group_bys

</> 
pub fn group_bys(
  select select: Select,
  group_bys group_bys: List(String),
) -> Select

Sets or appends a list of GroupBy into an existing GroupBy.

having

</> 
pub fn having(
  select select: Select,
  having where: Where,
) -> Select

Sets an AndWhere or appends into an existing AndWhere.

  • If the outermost Where is an AndWhere, the new Where is appended to the list within AndWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an AndWhere.

NOTICE: HAVING allows to specify constraints much like WHERE, but filters the results after GROUP BY is applied instead of before. Because HAVING uses the same semantics as WHERE, it takes a Where.

int

</> 
pub fn int(value value: Int) -> SelectValue

Creates a SelectValue from an Int.

join

</> 
pub fn join(select select: Select, join join: Join) -> Select

Adds a Join to the Select query.

joins

</> 
pub fn joins(
  select select: Select,
  joins joins: List(Join),
) -> Select

Adds Joins to the Select query.

limit

</> 
pub fn limit(select select: Select, limit limit: Int) -> Select

Sets a Limit in the Select query.

new

</> 
pub fn new() -> Select

Creates an empty Select query.

no_comment

</> 
pub fn no_comment(select select: Select) -> Select

Removes the Comment from the Select query.

no_epilog

</> 
pub fn no_epilog(select select: Select) -> Select

Removes the Epilog from the Select query.

no_from

</> 
pub fn no_from(select select: Select) -> Select

Removes the FROM clause of the Select query.

no_group_by

</> 
pub fn no_group_by(select select: Select) -> Select

Removes GroupBy from the Select query.

no_having

</> 
pub fn no_having(select select: Select) -> Select

Removes HAVING from the Select query.

no_join

</> 
pub fn no_join(select select: Select) -> Select

Removes any Joins from the Select query.

no_limit

</> 
pub fn no_limit(select select: Select) -> Select

Removes Limit from the Select query.

no_offset

</> 
pub fn no_offset(select select: Select) -> Select

Removes Offset from the Select query.

no_order_by

</> 
pub fn no_order_by(select select: Select) -> Select

Removes the OrderBy from the Select query.

no_where

</> 
pub fn no_where(select select: Select) -> Select

Removes the Where from the Select query.

null

</> 
pub fn null() -> SelectValue

Creates an SQL NULL Param.

offset

</> 
pub fn offset(
  select select: Select,
  offset offset: Int,
) -> Select

Sets an Offset in the Select query.

or_having

</> 
pub fn or_having(
  select select: Select,
  having where: Where,
) -> Select

Sets an OrWhere or appends into an existing OrWhere.

  • If the outermost Where is an OrWhere, the new Where is appended to the list within OrWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an OrWhere.

See function having on details why this takes a Where.

or_where

</> 
pub fn or_where(
  select select: Select,
  where where: Where,
) -> Select

Sets an OrWhere or appends into an existing OrWhere.

  • If the outermost Where is an OrWhere, the new Where is appended to the list within OrWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an OrWhere.

order_by

</> 
pub fn order_by(
  select select: Select,
  order_by order_by: String,
  direction direction: Direction,
) -> Select

Creates or appends an OrderBy a column with a direction.

The direction can either ASC or DESC.

order_by_asc

</> 
pub fn order_by_asc(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends an ascending OrderBy.

order_by_asc_nulls_first

</> 
pub fn order_by_asc_nulls_first(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends an ascending OrderBy with NULLS FIRST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS FIRST out of the box.

order_by_asc_nulls_last

</> 
pub fn order_by_asc_nulls_last(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends an ascending OrderBy with NULLS LAST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS LAST out of the box.

order_by_desc

</> 
pub fn order_by_desc(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends a descending OrderBy.

order_by_desc_nulls_first

</> 
pub fn order_by_desc_nulls_first(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends a descending order with NULLS FIRST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS FIRST out of the box.

order_by_desc_nulls_last

</> 
pub fn order_by_desc_nulls_last(
  select select: Select,
  order_by order_by: String,
) -> Select

Creates or appends a descending OrderBy with NULLS LAST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS LAST out of the box.

replace_group_by

</> 
pub fn replace_group_by(
  select select: Select,
  group_by group_by: String,
) -> Select

Replaces GroupBy with a single GroupBy.

replace_group_bys

</> 
pub fn replace_group_bys(
  select select: Select,
  group_bys group_bys: List(String),
) -> Select

Replaces GroupBy with a list of GroupBys.

replace_having

</> 
pub fn replace_having(
  select select: Select,
  having where: Where,
) -> Select

Replaces HAVING in the Select query.

See function having on details why this takes a Where.

replace_join

</> 
pub fn replace_join(
  select select: Select,
  join join: Join,
) -> Select

Replaces any Joins of the Select query with a single Join.

replace_joins

</> 
pub fn replace_joins(
  select select: Select,
  joins joins: List(Join),
) -> Select

Replaces any Joins of the Select query with the given Joins.

replace_order_by

</> 
pub fn replace_order_by(
  select select: Select,
  order_by order_by: String,
  direction direction: Direction,
) -> Select

Replaces the OrderBy a column with a direction.

replace_order_by_asc

</> 
pub fn replace_order_by_asc(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single ascending OrderBy.

replace_order_by_asc_nulls_first

</> 
pub fn replace_order_by_asc_nulls_first(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single ascending OrderBy with NULLS FIRST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS FIRST out of the box.

replace_order_by_asc_nulls_last

</> 
pub fn replace_order_by_asc_nulls_last(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single ascending OrderBy with NULLS LAST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS LAST out of the box.

replace_order_by_desc

</> 
pub fn replace_order_by_desc(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single descending order.

replace_order_by_desc_nulls_first

</> 
pub fn replace_order_by_desc_nulls_first(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single descending order with NULLS FIRST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS FIRST out of the box.

replace_order_by_desc_nulls_last

</> 
pub fn replace_order_by_desc_nulls_last(
  select select: Select,
  order_by order_by: String,
) -> Select

Replaces the OrderBy a single descending OrderBy with NULLS LAST.

NOTICE: 🦭MariaDB and 🐬MySQL do not support NULLS LAST out of the box.

replace_select

</> 
pub fn replace_select(
  select select: Select,
  select_value select_value: SelectValue,
) -> Select

Add a SelectValue to the Select query.

If the query already has any SelectValues, they are replaced.

replace_select_col

</> 
pub fn replace_select_col(
  select select: Select,
  name name: String,
) -> Select

Add a column name to the Select query as a SelectValue.

If the query already has any SelectValues, they are replaced.

replace_select_cols

</> 
pub fn replace_select_cols(
  select select: Select,
  select_cols columns: List(String),
) -> Select

Adds many column names as SelectValues to the Select query.

If the query already has any SelectValues, the new ones are replaced.

replace_selects

</> 
pub fn replace_selects(
  select select: Select,
  select_values select_values: List(SelectValue),
) -> Select

Adds many SelectValues to the Select query.

If the query already has any SelectValues, they are replaced.

If no SelectValues are provided, the query is returned as-is.

replace_where

</> 
pub fn replace_where(
  select select: Select,
  where where: Where,
) -> Select

Replaces the Where in the Select query.

select

</> 
pub fn select(
  select select: Select,
  select_value select_value: SelectValue,
) -> Select

Add a SelectValue to the Select query.

If the query already has any SelectValues, the new one is appended.

select_col

</> 
pub fn select_col(
  select select: Select,
  name name: String,
) -> Select

Add a column name to the Select query as a SelectValue.

If the query already has any SelectValues, the new one is appended.

select_cols

</> 
pub fn select_cols(
  select select: Select,
  select_cols columns: List(String),
) -> Select

Adds many column names as SelectValues to the Select query.

If the query already has any SelectValues, the new ones are appended.

selects

</> 
pub fn selects(
  select select: Select,
  select_values select_values: List(SelectValue),
) -> Select

Adds many SelectValues to the Select query.

If the query already has any SelectValues, the new ones are appended.

string

</> 
pub fn string(value value: String) -> SelectValue

Creates a SelectValue from a String.

to_query

</> 
pub fn to_query(select select: Select) -> ReadQuery

Creates a ReadQuery from a Select query.

where

</> 
pub fn where(select select: Select, where where: Where) -> Select

Sets an AndWhere or appends into an existing AndWhere.

  • If the outermost Where is an AndWhere, the new Where is appended to the list within AndWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an AndWhere.

xor_having

</> 
pub fn xor_having(
  select select: Select,
  having where: Where,
) -> Select

Sets an XorWhere or appends into an existing XorWhere.

  • If the outermost Where is an XorWhere, the new Where is appended to the list within XorWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an XorWhere.

See function having on details why this takes a Where.

NOTICE: This operator does not exist in 🐘PostgreSQL or 🪶SQLite, and Cake generates equivalent SQL using OR and AND and NOT. This operator exists in 🦭MariaDB and 🐬MySQL.

xor_where

</> 
pub fn xor_where(
  select select: Select,
  where where: Where,
) -> Select

Sets an XorWhere or appends into an existing XorWhere.

  • If the outermost Where is an XorWhere, the new Where is appended to the list within XorWhere.
  • If the query does not have a Where clause, the given Where is set instead.
  • If the outermost Where is any other kind of Where, this and the current outermost Where are wrapped in an XorWhere.

NOTICE: This operator does not exist in 🐘PostgreSQL or 🪶SQLite, and Cake generates equivalent SQL using OR and AND and NOT. This operator exists in 🦭MariaDB and 🐬MySQL.

✨ Search Document