Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Response types for epgsql:equery/[2-4] and epgsql:squery/2 can include socket errors #221

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/epgsql.erl
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ set_notice_receiver(C, PidOrName) ->
get_cmd_status(C) ->
epgsql_sock:get_cmd_status(C).

-spec squery(connection(), sql_query()) -> epgsql_cmd_squery:response().
-spec squery(connection(), sql_query()) -> epgsql_cmd_squery:response() | epgsql_sock:error().
%% @doc runs simple `SqlQuery' via given `Connection'
%% @see epgsql_cmd_squery
squery(Connection, SqlQuery) ->
Expand All @@ -241,7 +241,7 @@ equery(C, Sql) ->
equery(C, Sql, []).

-spec equery(connection(), sql_query(), [bind_param()]) ->
epgsql_cmd_equery:response().
epgsql_cmd_equery:response() | epgsql_sock:error().
equery(C, Sql, Parameters) ->
equery(C, "", Sql, Parameters).

Expand All @@ -251,7 +251,7 @@ equery(C, Sql, Parameters) ->
%% @end
%% TODO add fast_equery command that doesn't need parsed statement
-spec equery(connection(), string(), sql_query(), [bind_param()]) ->
epgsql_cmd_equery:response().
epgsql_cmd_equery:response() | epgsql_sock:error().
equery(C, Name, Sql, Parameters) ->
case parse(C, Name, Sql, []) of
{ok, #statement{types = Types} = S} ->
Expand Down
4 changes: 3 additions & 1 deletion src/epgsql_sock.erl
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
get_parameter_internal/2,
get_replication_state/1, set_packet_handler/2]).

-export_type([transport/0, pg_sock/0]).
-export_type([transport/0, pg_sock/0, error/0]).

-include("epgsql.hrl").
-include("protocol.hrl").
Expand All @@ -73,6 +73,8 @@
-type tcp_socket() :: port(). %gen_tcp:socket() isn't exported prior to erl 18
-type repl_state() :: #repl{}.

-type error() :: {error, sync_required | closed | sock_closed | sock_error}.

-record(state, {mod :: gen_tcp | ssl | undefined,
sock :: tcp_socket() | ssl:sslsocket() | undefined,
data = <<>>,
Expand Down