defql v0.1.0 Defql.Adapter behaviour

This module specifies the adapter API that an adapter is required to implement.

Summary

Callbacks

The callback to build delete query

The callback to build insert query

The callback for querying database, and parse result

The callback to build select query

Start specific adapter

The callback to build delete query

Types

params()
params() :: List.t
query()
query() :: String.t
return()
return() :: keyword
table()
table() :: String.t

Callbacks

delete(table, params)
delete(table :: table, params :: params) :: return

The callback to build delete query.

insert(table, params)
insert(table :: table, params :: params) :: return

The callback to build insert query.

query(query, params)
query(query :: query, params :: params) :: return

The callback for querying database, and parse result.

select(table, params)
select(table :: query, params :: params) :: return

The callback to build select query.

start(arg0, arg1)
start(Application.start_type, Application.start_args :: term) ::
  {:ok, pid} |
  {:ok, pid, Application.state} |
  {:error, reason :: term}

Start specific adapter

update(table, params, conds)
update(table :: table, params :: params, conds :: params) :: return

The callback to build delete query.