cake - v0.6.0

cake/query/insert

A DSL to build INSERT queries.

Functions

bool

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

Create an InsertValue from a column String and a Bool value.

columns

</> 
pub fn columns(
  query qry: Insert(a),
  columns cols: List(String),
) -> Insert(a)

Specify the columns to insert into.

NOTICE: You have to specify the columns and keep track if their names are correct, as well as their count which must be equal to the count of InsertRows the caster function returns or is given as source values.

comment

</> 
pub fn comment(
  query qry: Insert(a),
  comment cmmnt: String,
) -> Insert(a)

Specify a comment for the INSERT query.

epilog

</> 
pub fn epilog(
  query qry: Insert(a),
  epilog eplg: String,
) -> Insert(a)

Specify an epilog for the INSERT query.

float

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

Create an InsertValue from a column String and a Float value.

from_records

</> 
pub fn from_records(
  table_name tbl_nm: String,
  columns cols: List(String),
  records rcrds: List(a),
  caster cstr: fn(a) -> InsertRow,
) -> Insert(a)

Create an INSERT query from a list of gleam records.

The caster function is used to convert each record into an InsertRow.

from_values

</> 
pub fn from_values(
  table_name tbl_nm: String,
  columns cols: List(String),
  records rcrds: List(InsertRow),
) -> Insert(a)

Create an INSERT query from a list of InsertRows.

get_comment

</> 
pub fn get_comment(query qry: Insert(a)) -> Comment

Get the comment from an INSERT query.

get_epilog

</> 
pub fn get_epilog(query qry: Insert(a)) -> Epilog

Get the epilog from an INSERT query.

get_modifier

</> 
pub fn get_modifier(query qry: Insert(a)) -> String

Get the modifier from an Insert query.

get_source

</> 
pub fn get_source(query qry: Insert(a)) -> InsertSource(a)

Get the source from an Insert query which is either a list of records, accompanied by a caster function or a list of InsertRows.

get_table

</> 
pub fn get_table(query qry: Insert(a)) -> String

Get the table name to insert into from an Insert query.

int

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

Create an InsertValue from a column String and an Int value.

modifier

</> 
pub fn modifier(
  query qry: Insert(a),
  modifier mdfr: String,
) -> Insert(a)

Specify a modifier for the INSERT query.

no_comment

</> 
pub fn no_comment(query qry: Insert(a)) -> Insert(a)

Specify that no comment should be added to the INSERT query.

no_epilog

</> 
pub fn no_epilog(query qry: Insert(a)) -> Insert(a)

Specify that no epilog should be added to the INSERT query.

no_modifier

</> 
pub fn no_modifier(query qry: Insert(a)) -> Insert(a)

Specify that no modifier should be used for the given INSERT query.

no_returning

</> 
pub fn no_returning(query qry: Insert(a)) -> Insert(a)

Specify that no columns should be returned after the INSERT query.

null

</> 
pub fn null() -> Param

Create a NULL InsertValue.

on_columns_conflict_ignore

</> 
pub fn on_columns_conflict_ignore(
  query qry: Insert(a),
  column cols: List(String),
  where whr: Where,
) -> Insert(a)

This specifies that specific conflicts do not result in an error but instead are just ignored and not inserted.

Conflict Target: Columns

on_columns_conflict_update

</> 
pub fn on_columns_conflict_update(
  query qry: Insert(a),
  column cols: List(String),
  where whr: Where,
  update updt: Update(a),
) -> Insert(a)

Inserts or updates on conflict, also called ´.UPSERT´.

Conflict Target: Columns

on_conflict_error

</> 
pub fn on_conflict_error(query qry: Insert(a)) -> Insert(a)

This specifies that any conflicts result in the query to fail

This is the default behaviour.

on_constraint_conflict_ignore

</> 
pub fn on_constraint_conflict_ignore(
  query qry: Insert(a),
  constraint cnstrt: String,
  where whr: Where,
) -> Insert(a)

This specifies that specific conflicts do not result in an error but instead are just ignored and not inserted.

Conflict Target: Constraint

on_constraint_conflict_update

</> 
pub fn on_constraint_conflict_update(
  query qry: Insert(a),
  constraint cnstrt: String,
  where whr: Where,
  update updt: Update(a),
) -> Insert(a)

Inserts or updates on conflict, also called ´.UPSERT´.

Conflict Target: Constraint

param

</> 
pub fn param(column col: String, param prm: Param) -> InsertValue

Create an InsertValue from a column String and a Param.

returning

</> 
pub fn returning(
  query qry: Insert(a),
  returning rtrn: List(String),
) -> Insert(a)

Specify the columns to return after the INSERT query.

row

</> 
pub fn row(values vls: List(InsertValue)) -> InsertRow

Create an InsertRow from a list of InsertValues.

source_records

</> 
pub fn source_records(
  query qry: Insert(a),
  source rcrds: List(a),
  caster cstr: fn(a) -> InsertRow,
) -> Insert(a)

Specify the source records to insert.

source_values

</> 
pub fn source_values(
  query qry: Insert(a),
  records rcrds: List(InsertRow),
) -> Insert(a)

Specify the source values to insert.

string

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

Create an InsertValue from a column String and a String value.

table

</> 
pub fn table(
  query qry: Insert(a),
  table_name tbl_nm: String,
) -> Insert(a)

Specify the table to insert into.

to_query

</> 
pub fn to_query(insert isrt: Insert(a)) -> WriteQuery(a)

Creates a WriteQuery from an Insert query.

✨ Search Document