cake - v2.1.0

cake/update

A DSL to build UPDATE queries.

Types

Comment

</> 
pub type Comment =
  read_query.Comment

Epilog

</> 
pub type Epilog =
  read_query.Epilog

From

</> 
pub type From =
  read_query.From

Join

</> 
pub type Join =
  read_query.Join

Joins

</> 
pub type Joins =
  read_query.Joins

ReadQuery

</> 
pub type ReadQuery =
  read_query.ReadQuery

Update

</> 
pub type Update(a) =
  write_query.Update(a)

UpdateSet

</> 
pub type UpdateSet =
  write_query.UpdateSet

UpdateSets

</> 
pub type UpdateSets =
  write_query.UpdateSets

UpdateTable

</> 
pub type UpdateTable =
  write_query.UpdateTable

Where

</> 
pub type Where =
  read_query.Where

WriteQuery

</> 
pub type WriteQuery(a) =
  write_query.WriteQuery(a)

Functions

comment

</> 
pub fn comment(
  update updt: Update(a),
  comment cmmnt: String,
) -> Update(a)

Sets a Comment or appends into an existing Comment.

epilog

</> 
pub fn epilog(
  update updt: Update(a),
  epilog eplg: String,
) -> Update(a)

Sets an Epilog or appends into an existing Epilog.

from_sub_query

</> 
pub fn from_sub_query(
  update updt: Update(a),
  query qry: ReadQuery,
  alias als: String,
) -> Update(a)

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

from_table

</> 
pub fn from_table(
  update updt: Update(a),
  name tbl_nm: String,
) -> Update(a)

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

get_comment

</> 
pub fn get_comment(update updt: Update(a)) -> Comment

Gets the Comment of the Update query.

get_epilog

</> 
pub fn get_epilog(update updt: Update(a)) -> Epilog

Gets the Epilog of the Update query.

get_from

</> 
pub fn get_from(update updt: Update(a)) -> From

Gets the FROM clause of the Update query.

get_joins

</> 
pub fn get_joins(update updt: Update(a)) -> Joins

Gets the Joins of the Update query.

get_set

</> 
pub fn get_set(update updt: Update(a)) -> List(UpdateSet)

Get the SETs of the Update query.

get_table

</> 
pub fn get_table(update updt: Update(a)) -> UpdateTable

Get the table of the Update query.

get_where

</> 
pub fn get_where(update updt: Update(a)) -> Where

Gets the Where of the Update query.

join

</> 
pub fn join(update updt: Update(a), join jn: Join) -> Update(a)

Adds a Join to the Update query.

NOTICE: On 🐘PostgreSQL and 🪶SQLite Joins are only allowed if the FROM clause is set as well.

joins

</> 
pub fn joins(
  update updt: Update(a),
  joins jns: List(Join),
) -> Update(a)

Adds Joins to the Update query.

NOTICE: On 🐘PostgreSQL and 🪶SQLite Joins are only allowed if the FROM clause is set as well.

new

</> 
pub fn new() -> Update(a)

Creates an empty Update query.

no_comment

</> 
pub fn no_comment(update updt: Update(a)) -> Update(a)

Removes the Comment from the Update query.

no_epilog

</> 
pub fn no_epilog(update updt: Update(a)) -> Update(a)

Removes the Epilog from the Update query.

no_from

</> 
pub fn no_from(update updt: Update(a)) -> Update(a)

Removes the FROM clause of the Update query.

no_join

</> 
pub fn no_join(update updt: Update(a)) -> Update(a)

Removes any Joins from the Update query.

no_returning

</> 
pub fn no_returning(update updt: Update(a)) -> Update(a)

NOTICE: 🦭MariaDB and 🐬MySQL do not support RETURNING in UPDATE queries; they do support it in INSERT (and REPLACE) queries, however.

no_where

</> 
pub fn no_where(update updt: Update(a)) -> Update(a)

Removes the Where from the Update query.

or_where

</> 
pub fn or_where(
  update updt: Update(a),
  where whr: Where,
) -> Update(a)

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.

replace_join

</> 
pub fn replace_join(
  update updt: Update(a),
  join jn: Join,
) -> Update(a)

Replaces any Joins of the Update query with a signle Join.

NOTICE: On 🐘PostgreSQL and 🪶SQLite Joins are only allowed if the FROM clause is set as well.

replace_joins

</> 
pub fn replace_joins(
  update updt: Update(a),
  joins jns: List(Join),
) -> Update(a)

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

NOTICE: On 🐘PostgreSQL and 🪶SQLite Joins are only allowed if the FROM clause is set as well.

replace_where

</> 
pub fn replace_where(
  update updt: Update(a),
  where whr: Where,
) -> Update(a)

Replaces the Where in the Update query.

returning

</> 
pub fn returning(
  update updt: Update(a),
  returning rtrn: List(String),
) -> Update(a)

NOTICE: 🦭MariaDB and 🐬MySQL do not support RETURNING in UPDATE queries; they do support it in INSERT (and REPLACE) queries, however.

set

</> 
pub fn set(
  update updt: Update(a),
  set st: UpdateSet,
) -> Update(a)

Sets or appends one column set in an Update query.

set_bool

</> 
pub fn set_bool(column col: String, value v: Bool) -> UpdateSet

Sets a column to a Bool UpdateParamSet.

set_expression

</> 
pub fn set_expression(
  column col: String,
  expression exp: String,
) -> UpdateSet

Sets a column to an expression value.

set_false

</> 
pub fn set_false(column col: String) -> UpdateSet

Sets a column to a False UpdateParamSet.

set_float

</> 
pub fn set_float(column col: String, value v: Float) -> UpdateSet

Sets a column to a Float UpdateParamSet.

set_int

</> 
pub fn set_int(column col: String, value v: Int) -> UpdateSet

Sets a column to a Int UpdateParamSet.

set_null

</> 
pub fn set_null(column col: String) -> UpdateSet

Sets a column to an SQL NULL UpdateParamSet.

set_replace

</> 
pub fn set_replace(
  update updt: Update(a),
  set st: UpdateSet,
) -> Update(a)

Sets or replaces one column set in an Update query.

set_string

</> 
pub fn set_string(
  column col: String,
  value v: String,
) -> UpdateSet

Sets a column to a string UpdateParamSet.

set_sub_query

</> 
pub fn set_sub_query(
  column col: String,
  query qry: ReadQuery,
) -> UpdateSet

Sets a column to a sub-query value.

set_true

</> 
pub fn set_true(column col: String) -> UpdateSet

Sets a column to a True UpdateParamSet.

sets

</> 
pub fn sets(
  update updt: Update(a),
  set sts: List(UpdateSet),
) -> Update(a)

Sets or appends many column sets n an Update query.

sets_expression

</> 
pub fn sets_expression(
  columns cols: List(String),
  expression exp: String,
) -> UpdateSet

Sets many columns to an expression value.

NOTICE: the expression must return an equal count of columns.

sets_replace

</> 
pub fn sets_replace(
  update updt: Update(a),
  sets sts: List(UpdateSet),
) -> Update(a)

Sets or replaces many column sets in an Update query.

sets_sub_query

</> 
pub fn sets_sub_query(
  columns cols: List(String),
  query qry: ReadQuery,
) -> UpdateSet

Sets many columns to a sub-query value.

NOTICE: the sub-query must return an equal count of columns.

table

</> 
pub fn table(
  update updt: Update(a),
  table_name tbl_nm: String,
) -> Update(a)

Sets the table of the Update query.

to_query

</> 
pub fn to_query(update updt: Update(a)) -> WriteQuery(a)

Creates a WriteQuery from an Update query.

where

</> 
pub fn where(
  update updt: Update(a),
  where whr: Where,
) -> Update(a)

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_where

</> 
pub fn xor_where(
  update updt: Update(a),
  where whr: Where,
) -> Update(a)

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.

NOTICE: This operator exists in 🦭MariaDB and 🐬MySQL with native support.

✨ Search Document