Overview

Module mekao

• Data Types
• Function Index
• Function Details

Data Types

b_query()

b_query() = query(iolist())

column()

column() = #mekao_column{name = iodata(), type = term(), key = boolean(), ro = boolean(), transform = undefined | fun((Val::term()) -> NewVal::term())}

entity()

entity() = tuple() | [term() | '$skip']

iotriple()

iotriple() = iodata() | {iodata(), iodata(), iodata()}

p_query()

p_query() = query(#mekao_insert{table = mekao:iotriple(), columns = mekao:iotriple(), values = mekao:iotriple(), returning = mekao:iotriple()} | #mekao_select{columns = mekao:iotriple(), table = mekao:iotriple(), where = mekao:iotriple(), order_by = mekao:iotriple()} | #mekao_update{table = mekao:iotriple(), set = mekao:iotriple(), where = mekao:iotriple(), returning = mekao:iotriple()} | #mekao_delete{table = mekao:iotriple(), where = mekao:iotriple(), returning = mekao:iotriple()})

built query

predicate()

predicate(Val) = Val | {'$predicate', between, Val, Val} | {'$predicate', in, [Val, ...]} | {'$predicate', '=' | '<>' | '>' | '>=' | '<' | '<=' | like, Val} | {'$predicate', 'not', predicate(Val)}

query()

query(Body) = #mekao_query{body = Body, types = [term()], values = [term()], next_ph_num = non_neg_integer()}

s()

s() = #mekao_settings{placeholder = fun((mekao:column(), Num::non_neg_integer(), Val::term()) -> iodata()), limit = undefined | fun((mekao:query(#mekao_select{columns = mekao:iotriple(), table = mekao:iotriple(), where = mekao:iotriple(), order_by = mekao:iotriple()}), RowCount::non_neg_integer(), Offset::non_neg_integer()) -> mekao:query(#mekao_select{columns = mekao:iotriple(), table = mekao:iotriple(), where = mekao:iotriple(), order_by = mekao:iotriple()})), returning = undefined | fun((insert | update | delete, mekao:table()) -> iodata()), is_null = fun((Value::term()) -> boolean())}

select_opt()

select_opt() = {limit, {RowCount::non_neg_integer(), Offset::non_neg_integer()}}

selector()

selector() = tuple() | [predicate(term()) | '$skip']

table()

table() = #mekao_table{name = iodata(), columns = [mekao:column() | '$skip'], order_by = [non_neg_integer() | iodata() | {non_neg_integer() | iodata(), {asc | desc | default, nulls_first | nulls_last | default}}]}

Function Index

Function Details

build/1

count/3

Selects COUNT(*) with WHERE clause based on selector().

delete/3

Deletes entities, composes WHERE clause from Selector non $skip fields.

delete_pk/3

Deletes entity by primary key.

exists/3

Selects one column called exists with value 1 or 0, depends on EXISTS clause return.

exists_pk/3

Same as exists/3 but checks only primary key in EXISTS clause.

insert/3

Inserts entity, omits columns with $skip value.

insert_all/3

Inserts entities, places DEFAULT keyword when column with $skip value occurs.

prepare_count/3

prepare_delete/3

prepare_exists/3

prepare_insert/3

prepare_insert_all/3

prepare_select/3

prepare_select/4

prepare_update/4

select/3

Selects several entities, omits columns with $skip value.

select/4

select_pk/3

Reads entity by it's primary key.

update/4

Updates entities, composes WHERE clause from Selector non $skip fields. This is possible to update PK as well if it is not ro = true.

update_pk/3

Updates entity by it's primary key, omits columns with $skip value.

update_pk_diff/4

Updates only changed fields by primary key. This is possible to update PK as well if it is not ro = true.

Overview

Generated by EDoc