cake/combined

A DSL to build combined queries, such as:

UNION
UNION ALL
EXCEPT
EXCEPT ALL
INTERSECT
INTERSECT ALL

Compatibility

🪶SQLite does not support EXCEPT ALL and INTERSECT ALL.

Types

Combined

pub type Combined =
  read_query.Combined

Comment

</>

pub type Comment =
  read_query.Comment

Direction

</>

Defines the direction of an OrderBy.

pub type Direction {
  Asc
  Desc
}

Constructors

```
Asc
```
```
Desc
```

Epilog

</>

pub type Epilog =
  read_query.Epilog

Limit

</>

pub type Limit =
  read_query.Limit

Offset

</>

pub type Offset =
  read_query.Offset

OrderBy

</>

pub type OrderBy =
  read_query.OrderBy

OrderByDirection

</>

pub type OrderByDirection =
  read_query.OrderByDirection

ReadQuery

</>

pub type ReadQuery =
  read_query.ReadQuery

Select

</>

pub type Select =
  read_query.Select

Functions

comment

</>

pub fn comment(
  query qry: Combined,
  comment cmmnt: String,
) -> Combined

Appends a Comment to the Combined read_query.

epilog

</>

pub fn epilog(
  query qry: Combined,
  epilog eplg: String,
) -> Combined

Appends an Epilog to the Combined read_query.

except

</>

pub fn except(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates an EXCEPT query out of two queries as a Combined ReadQuery.

except_all

</>

pub fn except_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates an EXCEPT ALL query out of two queries as a Combined ReadQuery.

NOTICE: Not supported by 🪶SQLite.

excepts

</>

pub fn excepts(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates an EXCEPT query out of two or more queries as a Combined ReadQuery.

excepts_all

</>

pub fn excepts_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates an EXCEPT ALL query out of two or more queries as a Combined ReadQuery.

NOTICE: Not supported by 🪶SQLite.

get_comment

</>

pub fn get_comment(query qry: Combined) -> Comment

Gets the Comment from the Combined read_query.

get_epilog

</>

pub fn get_epilog(query qry: Combined) -> Epilog

Gets the Epilog from the Combined read_query.

get_limit

</>

pub fn get_limit(query qry: Combined) -> Limit

Gets Limit in the Combined ReadQuery.

get_offset

</>

pub fn get_offset(query qry: Combined) -> Offset

Gets Offset in the Combined ReadQuery.

get_order_by

</>

pub fn get_order_by(query qry: Combined) -> OrderBy

Gets the OrderBy from the Combined read_query.

get_queries

</>

pub fn get_queries(combined cmbnd: Combined) -> List(Select)

Gets the queries from a Combined ReadQuery.

intersect

</>

pub fn intersect(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates an INTERSECT query out of two queries as a Combined ReadQuery.

intersect_all

</>

pub fn intersect_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates an INTERSECT ALL query out of two queries as a Combined ReadQuery.

NOTICE: Not supported by 🪶SQLite.

intersects

</>

pub fn intersects(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates an INTERSECT query out of two or more queries as a Combined read_query.

intersects_all

</>

pub fn intersects_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates an INTERSECT ALL query out of two or more queries as a Combined ReadQuery.

NOTICE: Not supported by 🪶SQLite.

limit

</>

pub fn limit(query qry: Combined, limit lmt: Int) -> Combined

Sets a Limit in the Combined ReadQuery.

no_comment

</>

pub fn no_comment(query qry: Combined) -> Combined

Removes the Comment from the Combined read_query.

no_epilog

</>

pub fn no_epilog(query qry: Combined) -> Combined

Removes the Epilog from the Combined read_query.

no_limit

</>

pub fn no_limit(query qry: Combined) -> Combined

Removes Limit from the Combined ReadQuery.

no_offset

</>

pub fn no_offset(query qry: Combined) -> Combined

Removes Offset from the Combined ReadQuery.

no_order_by

</>

pub fn no_order_by(query qry: Combined) -> Combined

Removes the OrderBy from the Combined read_query.

offset

</>

pub fn offset(query qry: Combined, offst offst: Int) -> Combined

Sets an Offset in the Combined ReadQuery.

order_by

</>

pub fn order_by(
  query qry: Combined,
  by ordb: String,
  direction dir: Direction,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

Creates or appends an ascending OrderBy.

order_by_asc_nulls_first

</>

pub fn order_by_asc_nulls_first(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

Creates or appends a descending OrderBy.

order_by_desc_nulls_first

</>

pub fn order_by_desc_nulls_first(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

Creates or appends a descending OrderBy with NULLS LAST.

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

replace_order_by

</>

pub fn replace_order_by(
  query qry: Combined,
  by ordb: String,
  direction dir: Direction,
) -> Combined

Replaces the OrderBy a column with a direction.

replace_order_by_asc

</>

pub fn replace_order_by_asc(
  query qry: Combined,
  by ordb: String,
) -> Combined

Replaces the OrderBy a single ascending OrderBy.

replace_order_by_asc_nulls_first

</>

pub fn replace_order_by_asc_nulls_first(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

Replaces the OrderBy a single descending order.

replace_order_by_desc_nulls_first

</>

pub fn replace_order_by_desc_nulls_first(
  query qry: Combined,
  by ordb: String,
) -> Combined

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(
  query qry: Combined,
  by ordb: String,
) -> Combined

Replaces the OrderBy a single descending OrderBy with NULLS LAST.

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

to_query

</>

pub fn to_query(combined cmbnd: Combined) -> ReadQuery

Creates a ReadQuery from a Combined read_query.

union

</>

pub fn union(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates a UNION query out of two queries as a Combined ReadQuery.

union_all

</>

pub fn union_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
) -> Combined

Creates a UNION ALL query out of two queries as a Combined ReadQuery.

unions

</>

pub fn unions(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates a UNION query out of two or more queries as a Combined ReadQuery.

unions_all

</>

pub fn unions_all(
  query_a qry_a: Select,
  query_b qry_b: Select,
  more_queries mr_qrys: List(Select),
) -> Combined

Creates a UNION ALL query out of two or more queries as a Combined ReadQuery.

NOTICE: Not supported by 🪶SQLite.