Overview

Module epgsql

• Description
• Data Types
• Function Index
• Function Details

This module defines the epgsql behaviour.
Required callback functions: handle_x_log_data/4.

Description

Synchronous interface.

Data Types

bind_param()

bind_param() = any()

Value to be bound to placeholder ($1, $2 etc)

cb_state()

cb_state() = term()

column()

column() = #column{name = binary(), type = epgsql:epgsql_type(), oid = non_neg_integer(), size = -1 | pos_integer(), modifier = -1 | pos_integer(), format = integer(), table_oid = non_neg_integer(), table_attr_number = pos_integer()}

connect_error()

connect_error() = epgsql_cmd_connect:connect_error()

connect_option()

connect_option() = {host, host()} | {username, string()} | {password, password()} | {database, DBName::string()} | {port, PortNum::inet:port_number()} | {ssl, IsEnabled::boolean() | required} | {ssl_opts, SslOptions::ssl_options()} | {tcp_opts, TcpOptions::[gen_tcp:option()]} | {timeout, TimeoutMs::timeout()} | {async, Receiver::pid() | atom()} | {codecs, Codecs::[{epgsql_codec:codec_mod(), any()}]} | {nulls, Nulls::[any(), ...]} | {replication, Replication::string()} | {application_name, ApplicationName::string()} | {socket_active, Active::socket_active()}

connect_opts()

connect_opts() = connect_opts_map() | [connect_option()]

connect_opts_map()

connect_opts_map() = #{host => host(), username => string(), password => password(), database => string(), port => inet:port_number(), ssl => boolean() | required, ssl_opts => ssl_options(), tcp_opts => [gen_tcp:option()], timeout => timeout(), async => pid() | atom(), codecs => [{epgsql_codec:codec_mod(), any()}], nulls => [any(), ...], replication => string(), application_name => string(), socket_active => socket_active()}

connection()

connection() = pid()

epgsql_type()

epgsql_type() = type_name() | {array, type_name()} | {unknown_oid, integer()}

equery_row()

equery_row() = tuple()

tuple of any().

error_reply()

error_reply() = {error, query_error()}

host()

host() = inet:ip_address() | inet:hostname()

lsn()

lsn() = integer()

ok_reply()

ok_reply(RowType) = {ok, ColumnsDescription::[column()], RowsValues::[RowType]} | {ok, Count::non_neg_integer()} | {ok, Count::non_neg_integer(), ColumnsDescription::[column()], RowsValues::[RowType]}

password()

password() = string() | iodata() | fun(() -> iodata())

pg_date()

pg_date() = epgsql_codec_datetime:pg_date()

pg_datetime()

pg_datetime() = epgsql_codec_datetime:pg_datetime()

pg_interval()

pg_interval() = epgsql_codec_datetime:pg_interval()

pg_time()

pg_time() = epgsql_codec_datetime:pg_time()

query_error()

query_error() = #error{severity = debug | log | info | notice | warning | error | fatal | panic, code = binary(), codename = atom(), message = binary(), extra = [{severity | detail | hint | position | internal_position | internal_query | where | schema_name | table_name | column_name | data_type_name | constraint_name | file | line | routine, binary()}]}

Error report generated by server

replication_option()

replication_option() = {align_lsn, boolean()}

Align last applied and flushed LSN with last received LSN after Primary keepalive message with ReplyRequired flag

replication_opts()

replication_opts() = [replication_option()] | #{align_lsn => boolean()}

reply()

reply(RowType) = ok_reply(RowType) | error_reply()

socket_active()

socket_active() = true | -32768..32767

sql_query()

sql_query() = iodata()

SQL query text

squery_row()

squery_row() = tuple()

tuple of binary().

ssl_options()

ssl_options() = [ssl:tls_client_option()]

statement()

statement() = #statement{name = string(), columns = [#column{name = binary(), type = epgsql:epgsql_type(), oid = non_neg_integer(), size = -1 | pos_integer(), modifier = -1 | pos_integer(), format = integer(), table_oid = non_neg_integer(), table_attr_number = pos_integer()}], types = [epgsql:epgsql_type()], parameter_info = [epgsql_oid_db:oid_entry()]}

transaction_option()

transaction_option() = {reraise, boolean()} | {ensure_committed, boolean()} | {begin_opts, iodata()}

transaction_opts()

transaction_opts() = [transaction_option()] | #{reraise => boolean(), ensure_committed => boolean(), begin_opts => iodata()}

type_name()

type_name() = atom()

typed_param()

typed_param() = {epgsql_type(), bind_param()}

Function Index

Function Details

activate/1

Activates TCP or SSL socket of a connection.

bind/3

bind/4

Binds parameters to prepared statement, creating "portal"

cancel/1

cancel currently executing command

close/1

close connection

close/2

close statement

close/3

close statement or portal

connect/1

connects to the server and performs all the necessary handshakes

connect/2

connect/3

connect/4

connects to the server and performs all the necessary handshakes (legacy interface)

See also: connect/1.

connect/5

copy_done/1

Tells server that the transfer of COPY data is done

copy_from_stdin/2

Equivalent to copy_from_stdin(C, SQL, text).

copy_from_stdin/3

Switches epgsql into COPY-mode

When Format is text, Erlang IO-protocol should be used to transfer "raw" COPY data to the server (see, eg, io:put_chars/2 and file:write/2 etc).

When Format is {binary, Types}, copy_send_rows/3 should be used instead.

copy_send_rows/3

Send a batch of rows to COPY .. FROM STDIN WITH (FORMAT binary) in Erlang format

describe/2

describe/3

equery/2

equery/3

equery/4

Executes extended query

See also: epgsql_cmd_equery.

execute/2

execute/3

execute/4

execute_batch/2

Executes batch of {statement(), [bind_param()]} extended queries

See also: epgsql_cmd_batch.

execute_batch/3

Executes same statement() extended query with each parameter list of a Batch

See also: epgsql_cmd_batch.

get_backend_pid/1

Returns the OS pid of PostgreSQL backend OS process that serves this connection.

get_cmd_status/1

Returns last command status message. If multiple queries were executed using squery/2, separated by semicolon, only the last query's status will be available. See https://www.postgresql.org/docs/current/static/libpq-exec.html#LIBPQ-PQCMDSTATUS

get_parameter/2

handle_x_log_data/5

parse/2

parse/3

parse/4

Ask server to parse the SQL query and generate prepared statement.

prepared_query/3

Similar to equery/3, but uses prepared statement that can be reused multiple times.

See also: epgsql_cmd_prepared_query.

set_notice_receiver/2

squery/2

runs simple SqlQuery via given Connection

See also: epgsql_cmd_squery.

standby_status_update/3

sends last flushed and applied WAL positions to the server in a standby status update message via given Connection

start_replication/5

start_replication/6

start_replication/7

instructs Postgres server to start streaming WAL for logical replication

sync/1

sync_on_error/2

update_type_cache/1

update_type_cache/2

with_transaction/2

with_transaction/3

Execute callback function with connection in a transaction. Transaction will be rolled back in case of exception. Options (proplist or map):

reraise

when set to true, exception will be re-thrown, otherwise {rollback, ErrorReason} will be returned. Default: true

ensure_comitted

even when callback returns without exception, check that transaction was committed by checking CommandComplete status of "COMMIT" command. In case when transaction was rolled back, status will be "rollback" instead of "commit". Default: false

begin_opts

append extra options to "BEGIN" command (see https://www.postgresql.org/docs/current/static/sql-begin.html) Beware of SQL injections! No escaping is made on begin_opts! Default: ""

Overview

Generated by EDoc