| Overview |  |
bind_param() = null | boolean() | string() | binary() | integer() | float() | calendar:date() | calendar:time() | calendar:datetime() | {calendar:time(), Days::non_neg_integer(), Months::non_neg_integer()} | {[{binary(), binary() | null}]} | [bind_param()]
connect_error() = #error{}
connect_option() = {database, DBName::string()} | {port, PortNum::inet:port_number()} | {ssl, IsEnabled::boolean() | required} | {ssl_opts, SslOptions::[ssl:ssl_option()]} | {timeout, TimeoutMs::timeout()} | {async, Receiver::pid()}
connection() = pid()
equery_row() = {bind_param()}
error_reply() = {error, query_error()}
host() = inet:ip_address() | inet:hostname()
ok_reply(RowType) = {ok, ColumnsDescription::[#column{}], RowsValues::[RowType]} | {ok, Count::non_neg_integer()} | {ok, Count::non_neg_integer(), ColumnsDescription::[#column{}], RowsValues::[RowType]}
query_error() = #error{}
reply(RowType) = ok_reply(RowType) | error_reply()
sql_query() = string() | iodata()
squery_row() = {binary()}
typed_param() = {epgsql_type(), bind_param()}
| bind/3 | |
| bind/4 | |
| cancel/1 | |
| close/1 | |
| close/2 | |
| close/3 | |
| connect/1 | |
| connect/2 | |
| connect/3 | |
| connect/4 | connects to Postgres
where
Host - host to connect to
Username - username to connect as, defaults to $USER
Password - optional password to authenticate with
Opts - proplist of extra options
returns {ok, Connection} otherwise {error, Reason} |
| connect/5 | |
| describe/2 | |
| describe/3 | |
| equery/2 | |
| equery/3 | |
| equery/4 | |
| execute/2 | |
| execute/3 | |
| execute/4 | |
| execute_batch/2 | |
| get_parameter/2 | |
| parse/2 | |
| parse/3 | |
| parse/4 | |
| prepared_query/3 | |
| squery/2 | runs simple SqlQuery via given Connection |
| sync/1 | |
| sync_on_error/2 | |
| update_type_cache/1 | |
| update_type_cache/2 | |
| with_transaction/2 |
bind(C, Statement, Parameters) -> any()
bind(C::connection(), Statement::#statement{}, PortalName::string(), Parameters::[bind_param()]) -> ok | {error, query_error()}
cancel(C::connection()) -> ok
close(C::connection()) -> ok
close(C, Statement) -> any()
close(C, Type, Name) -> any()
connect(Settings) -> any()
connect(Host, Opts) -> any()
connect(Host, Username, Opts) -> any()
connect(Host::host(), Username::string(), Password::string(), Opts::[connect_option()]) -> {ok, Connection::connection()} | {error, Reason::connect_error()}
connects to Postgres
where
Host - host to connect to
Username - username to connect as, defaults to $USER
Password - optional password to authenticate with
Opts - proplist of extra options
returns {ok, Connection} otherwise {error, Reason}
connect(C::connection(), Host::host(), Username::string(), Password::string(), Opts::[connect_option()]) -> {ok, Connection::connection()} | {error, Reason::connect_error()}
describe(C, Statement) -> any()
describe(C, X2, Name) -> any()
equery(C, Sql) -> any()
equery(C, Sql, Parameters) -> any()
equery(C::connection(), Name::string(), Sql::sql_query(), Parameters::[bind_param()]) -> reply(equery_row())
execute(C, S) -> any()
execute(C, S, N) -> any()
execute(C::connection(), Statement::#statement{}, PortalName::string(), N::non_neg_integer()) -> Reply
execute_batch(C::connection(), Batch::[{#statement{}, [bind_param()]}]) -> [reply(equery_row())]
get_parameter(C::connection(), Name::binary()) -> binary() | undefined
parse(C, Sql) -> any()
parse(C, Sql, Types) -> any()
parse(C::connection(), Name::iolist(), Sql::sql_query(), Types::[epgsql_type()]) -> {ok, #statement{}} | {error, query_error()}
prepared_query(C::connection(), Name::string(), Parameters::[bind_param()]) -> reply(equery_row())
squery(Connection::connection(), SqlQuery::sql_query()) -> reply(squery_row()) | [reply(squery_row())]
runs simple SqlQuery via given Connection
sync(C) -> any()
sync_on_error(C, Error) -> any()
update_type_cache(C::connection()) -> ok
update_type_cache(C::connection(), DynamicTypes::[binary()]) -> ok
with_transaction(C::connection(), F::fun((connection()) -> Reply)) -> Reply | {rollback, any()}
Generated by EDoc, May 14 2016, 14:35:40.