cake/insert

A DSL to build INSERT queries.

Types

Comment

pub type Comment =
  read_query.Comment

Epilog

</>

pub type Epilog =
  read_query.Epilog

Insert

</>

pub type Insert(a) =
  write_query.Insert(a)

InsertColumns

</>

pub type InsertColumns =
  write_query.InsertColumns

InsertConflictStrategy

</>

pub type InsertConflictStrategy(a) =
  write_query.InsertConflictStrategy(a)

InsertIntoTable

</>

pub type InsertIntoTable =
  write_query.InsertIntoTable

InsertRow

</>

pub type InsertRow =
  write_query.InsertRow

InsertSource

</>

pub type InsertSource(a) =
  write_query.InsertSource(a)

InsertValue

</>

pub type InsertValue =
  write_query.InsertValue

Update

</>

pub type Update(a) =
  write_query.Update(a)

Where

</>

pub type Where =
  read_query.Where

WriteQuery

</>

pub type WriteQuery(a) =
  write_query.WriteQuery(a)

Functions

bool

</>

pub fn bool(value vl: Bool) -> InsertValue

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

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 encoder function returns or is given as source values.

comment

</>

pub fn comment(
  insert isrt: Insert(a),
  comment cmmnt: String,
) -> Insert(a)

Specify a comment for the INSERT query.

epilog

</>

pub fn epilog(
  insert isrt: Insert(a),
  epilog eplg: String,
) -> Insert(a)

Specify an epilog for the INSERT query.

float

</>

pub fn float(value vl: Float) -> InsertValue

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),
  encoder encdr: fn(a) -> InsertRow,
) -> Insert(a)

Create an INSERT query from a list of gleam records.

The encoder 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),
  values vls: List(InsertRow),
) -> Insert(a)

Create an INSERT query from a list of InsertRows.

get_columns

</>

pub fn get_columns(insert isrt: Insert(a)) -> InsertColumns

Get the columns to insert into from an Insert query.

get_comment

</>

pub fn get_comment(insert isrt: Insert(a)) -> Comment

Get the comment from an INSERT query.

get_epilog

</>

pub fn get_epilog(insert isrt: Insert(a)) -> Epilog

Get the epilog from an INSERT query.

get_modifier

</>

pub fn get_modifier(insert isrt: Insert(a)) -> String

Get the modifier from an Insert query.

get_on_conflict

</>

pub fn get_on_conflict(
  insert isrt: Insert(a),
) -> InsertConflictStrategy(a)

Get the conflict strategy from an Insert query.

get_source

</>

pub fn get_source(insert isrt: Insert(a)) -> InsertSource(a)

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

get_table

</>

pub fn get_table(insert isrt: Insert(a)) -> InsertIntoTable

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

int

</>

pub fn int(value vl: Int) -> InsertValue

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

modifier

</>

pub fn modifier(
  insert isrt: Insert(a),
  modifier mdfr: String,
) -> Insert(a)

Specify a modifier for the INSERT query.

new

</>

pub fn new() -> Insert(a)

Create an empty INSERT query.

no_comment

</>

pub fn no_comment(insert isrt: Insert(a)) -> Insert(a)

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

no_epilog

</>

pub fn no_epilog(insert isrt: Insert(a)) -> Insert(a)

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

no_modifier

</>

pub fn no_modifier(insert isrt: Insert(a)) -> Insert(a)

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

no_returning

</>

pub fn no_returning(insert isrt: Insert(a)) -> Insert(a)

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

null

</>

pub fn null() -> InsertValue

Create a NULL InsertValue.

on_columns_conflict_ignore

</>

pub fn on_columns_conflict_ignore(
  insert isrt: Insert(a),
  columns 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(
  insert isrt: Insert(a),
  columns 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(insert isrt: 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(
  insert isrt: 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(
  insert isrt: 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

returning

</>

pub fn returning(
  insert isrt: 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(
  insert isrt: Insert(a),
  source rcrds: List(a),
  encoder encdr: fn(a) -> InsertRow,
) -> Insert(a)

Specify the source records to insert.

source_values

</>

pub fn source_values(
  insert isrt: Insert(a),
  source rws: List(InsertRow),
) -> Insert(a)

Specify the source values to insert.

string

</>

pub fn string(value vl: String) -> InsertValue

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

table

</>

pub fn table(
  insert isrt: 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.