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.

Sign up for GitHub

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

Update to DBConnection 2.0 #235

Merged
merged 19 commits into from
Sep 24, 2018
Merged

Update to DBConnection 2.0 #235

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
f9f3af6
Remove Docker dependent test
Aug 31, 2018
e0bcf00
Update decimal
wojtekmach Aug 31, 2018
e9c575c
Use database transaction status to prevent transaction errors
fishcakez Aug 11, 2017
dd2dc21
Use one text statement for all queries
fishcakez Aug 12, 2017
0491f72
Support explicit cursor API
fishcakez Aug 12, 2017
9f2350d
Remove reserved query name errors
fishcakez Aug 13, 2017
869c0b7
Add max rows option to each cursor fetch
fishcakez Aug 13, 2017
c1c7475
Raise DBConnection.ConnectionError on connection error
fishcakez Nov 26, 2017
02bc0fb
Update to DBConnection 2.0
Aug 31, 2018
e319241
Update to latest DBCOnnection
Sep 2, 2018
6abbee2
Update to latest DBConnection
Sep 13, 2018
6783f8f
Update docs
Sep 13, 2018
1f33f8e
Fix return types
Sep 13, 2018
31e896a
Update types
Sep 13, 2018
0483010
Update dbconnection reference
Sep 16, 2018
f9a48cc
Remove outdated pool config
Sep 16, 2018
8841917
Add Mariaex.prepare_execute
Sep 16, 2018
642d650
Update mariaex.ex
josevalim Sep 24, 2018
ec14055
Update DBConnection git ref
Sep 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 83 additions & 67 deletions lib/mariaex.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@ defmodule Mariaex do
"""
@type conn :: DBConnection.conn

@pool_timeout 5000
@timeout 5000
@idle_timeout 5000
@max_rows 500

# Inherited from DBConnection

@pool_timeout 5000
@timeout 15000

### PUBLIC API ###

@doc """
Expand Down Expand Up @@ -61,8 +65,7 @@ defmodule Mariaex do
* `:idle` - Either `:active` to asynchronously detect TCP disconnects when
idle or `:passive` not to (default: `:passive`);
* `:pool` - The pool module to use, see `DBConnection` for pool dependent
options, this option must be included with all requests contacting the pool
if not `DBConnection.Connection` (default: `DBConnection.Connection`);
options (default: `DBConnection.ConnectionPool`);
* `:name` - A name to register the started process (see the `:name` option
in `GenServer.start_link/3`).
* `:datetime` - How datetimes should be returned. `:structs` for Elixir v1.3
Expand Down Expand Up @@ -132,18 +135,17 @@ defmodule Mariaex do
param_types: ["text", "text"], result_types: ["text"])

"""
@spec query(conn, iodata, list, Keyword.t) :: {:ok, Mariaex.Result.t} | {:error, Mariaex.Error.t}
@spec query(conn, iodata, list, Keyword.t) :: {:ok, Mariaex.Result.t} | {:error, Exception.t}
def query(conn, statement, params \\ [], opts \\ [])

def query(conn, statement, params, opts) do
case Keyword.get(opts, :query_type) do
:text ->
query = %Query{type: :text, statement: statement, ref: make_ref(),
num_params: 0}
execute(conn, query, [], opts)
query = %Query{type: :text, statement: statement, ref: make_ref(), num_params: 0}
run_query(:execute, conn, query, [], opts)
type when type in [:binary, nil] ->
query = %Query{type: type, statement: statement}
prepare_execute(conn, query, params, defaults(opts))
run_query(:prepare_execute, conn, query, params, opts)
end
end

Expand Down Expand Up @@ -173,16 +175,14 @@ defmodule Mariaex do
(default: `#{@pool_timeout}`)
* `:queue` - Whether to wait for connection in a queue (default: `true`);
* `:timeout` - Prepare request timeout (default: `#{@timeout}`);
* `:pool` - The pool module to use, must match that set on
`start_link/1`, see `DBConnection`
* `:query_type` - `:binary` to use binary protocol, `:text` to use text
protocol or `nil` to try binary but fallback to text (default `nil`)

## Examples

Mariaex.prepare(conn, "", "CREATE TABLE posts (id serial, title text)")
"""
@spec prepare(conn, iodata, iodata, Keyword.t) :: {:ok, Mariaex.Query.t} | {:error, Mariaex.Error.t}
@spec prepare(conn, iodata, iodata, Keyword.t) :: {:ok, Mariaex.Query.t} | {:error, Exception.t}
def prepare(conn, name, statement, opts \\ []) do
case Keyword.get(opts, :query_type) do
:text ->
Expand All @@ -191,7 +191,7 @@ defmodule Mariaex do
{:ok, query}
type when type in [:binary, nil] ->
query = %Query{type: type, name: name, statement: statement}
prepare_binary(conn, query, opts)
DBConnection.prepare(conn, query, opts)
end
end

Expand All @@ -209,10 +209,64 @@ defmodule Mariaex do
end
end

@doc """
Prepares and executes a query and returns the result as
`{:ok, %Mariaex.Query{}, %Mariaex.Result{}}` or `{:error, %Mariaex.Error{}}`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be any exception?

if there was an error. Parameters are given as part of the prepared query,
`%Mariaex.Query{}`.

See the README for information on how Mariaex encodes and decodes Elixir
values by default. See `Mariaex.Query` for the query data and
`Mariaex.Result` for the result data.

## Options

* `:pool_timeout` - Time to wait in the queue for the connection
(default: `#{@pool_timeout}`)
* `:queue` - Whether to wait for connection in a queue (default: `true`);
* `:timeout` - Execute request timeout (default: `#{@timeout}`);
* `:decode_mapper` - Fun to map each row in the result to a term after
decoding, (default: `fn x -> x end`);

## Examples

Mariaex.prepare_execute(conn, "", "SELECT id FROM posts WHERE title like $1", ["%my%"])

"""
@spec prepare_execute(conn, iodata, iodata, list, Keyword.t) ::
{:ok, Mariaex.Query.t, Mariaex.Result.t} | {:error, Exception.t}
def prepare_execute(conn, name, statement, params, opts \\ []) do
case Keyword.get(opts, :query_type) do
:text ->
query = %Query{type: :text, name: name, statement: statement, ref: make_ref(), num_params: 0}
DBConnection.execute(conn, query, params, opts)
type when type in [:binary, nil] ->
query = %Query{type: type, name: name, statement: statement}
DBConnection.prepare_execute(conn, query, params, opts)
end
end

@doc """
Prepares and executes a query and returns the result or raises
`Mariaex.Error` if there was an error. See `execute/4`.
"""
@spec prepare_execute!(conn, Mariaex.Query.t, list, Keyword.t) ::
{Mariaex.Query.t, Mariaex.Result.t}
def prepare_execute!(conn, name, statement, params, opts \\ []) do
case prepare_execute(conn, name, statement, params, opts) do
{:ok, query, result} ->
{query, result}
{:error, err} ->
raise err
end
end

@doc """
Runs an (extended) prepared query and returns the result as
`{:ok, %Mariaex.Result{}}` or `{:error, %Mariaex.Error{}}` if there was an
error. Parameters are given as part of the prepared query, `%Mariaex.Query{}`.
`{:ok, %Mariaex.Query{}, %Mariaex.Result{}}` or `{:error, %Mariaex.Error{}}`
if there was an error. Parameters are given as part of the prepared query,
`%Mariaex.Query{}`.

See the README for information on how Mariaex encodes and decodes Elixir
values by default. See `Mariaex.Query` for the query data and
`Mariaex.Result` for the result data.
Expand All @@ -225,8 +279,6 @@ defmodule Mariaex do
* `:timeout` - Execute request timeout (default: `#{@timeout}`);
* `:decode_mapper` - Fun to map each row in the result to a term after
decoding, (default: `fn x -> x end`);
* `:pool` - The pool module to use, must match that set on
`start_link/1`, see `DBConnection`

## Examples

Expand All @@ -237,14 +289,9 @@ defmodule Mariaex do
Mariaex.execute(conn, query, ["%my%"])
"""
@spec execute(conn, Mariaex.Query.t, list, Keyword.t) ::
{:ok, Mariaex.Result.t} | {:error, Mariaex.Error.t}
{:ok, Mariaex.Query.t, Mariaex.Result.t} | {:error, Exception.t}
def execute(conn, %Query{} = query, params, opts \\ []) do
case DBConnection.execute(conn, query, params, defaults(opts)) do
{:error, %ArgumentError{} = err} ->
raise err
other ->
other
end
DBConnection.execute(conn, query, params, opts)
end

@doc """
Expand All @@ -253,12 +300,7 @@ defmodule Mariaex do
"""
@spec execute!(conn, Mariaex.Query.t, list, Keyword.t) :: Mariaex.Result.t
def execute!(conn, query, params, opts \\ []) do
case execute(conn, query, params, opts) do
{:ok, res} ->
res
{:error, err} ->
raise err
end
DBConnection.execute!(conn, query, params, opts)
end

@doc """
Expand All @@ -271,28 +313,24 @@ defmodule Mariaex do
(default: `#{@pool_timeout}`)
* `:queue` - Whether to wait for connection in a queue (default: `true`);
* `:timeout` - Prepare request timeout (default: `#{@timeout}`);
* `:pool` - The pool module to use, must match that set on
`start_link/1`, see `DBConnection`

## Examples

query = Mariaex.prepare!(conn, "SELECT id FROM posts WHERE title like $1")
Mariaex.close(conn, query)
"""
@spec close(conn, Mariaex.Query.t, Keyword.t) :: :ok | {:error, Mariaex.Error.t}
@spec close(conn, Mariaex.Query.t, Keyword.t) :: :ok | {:error, Exception.t}
def close(conn, query, opts \\ [])

def close(_, %Query{type: :text}, _) do
:ok
end
def close(conn, query, opts) do
case DBConnection.close(conn, query, defaults(opts)) do
case DBConnection.close(conn, query, opts) do
{:ok, _} ->
:ok
{:error, %ArgumentError{} = err} ->
raise err
other ->
other
{:error, _} = error ->
error
end
end

Expand Down Expand Up @@ -333,16 +371,13 @@ defmodule Mariaex do
(default: `#{@pool_timeout}`)
* `:queue` - Whether to wait for connection in a queue (default: `true`);
* `:timeout` - Transaction timeout (default: `#{@timeout}`);
* `:pool` - The pool module to use, must match that set on
`start_link/1`, see `DBConnection;
* `:mode` - Set to `:savepoint` to use savepoints instead of an SQL
transaction, otherwise set to `:transaction` (default: `:transaction`);


The `:timeout` is for the duration of the transaction and all nested
transactions and requests. This timeout overrides timeouts set by internal
transactions and requests. The `:pool` and `:mode` will be used for all
requests inside the transaction function.
transactions and requests. The `:mode` will be used for all requests inside
the transaction function.

## Example

Expand All @@ -353,7 +388,7 @@ defmodule Mariaex do
@spec transaction(conn, ((DBConnection.t) -> result), Keyword.t) ::
{:ok, result} | {:error, any} when result: var
def transaction(conn, fun, opts \\ []) do
DBConnection.transaction(conn, fun, defaults(opts))
DBConnection.transaction(conn, fun, opts)
end

@doc """
Expand Down Expand Up @@ -393,7 +428,7 @@ defmodule Mariaex do
def stream(conn, query, params, opts \\ [])

def stream(conn, %Query{} = query, params, opts) do
DBConnection.stream(conn, query, params, defaults(opts))
DBConnection.stream(conn, query, params, opts)
end
def stream(conn, statement, params, opts) do
case Keyword.get(opts, :query_type) do
Expand All @@ -403,7 +438,7 @@ defmodule Mariaex do
stream(conn, query, [], opts)
type when type in [:binary, nil] ->
query = %Query{type: type, statement: statement}
prepare_stream(conn, query, params, opts)
DBConnection.prepare_stream(conn, query, params, opts)
end
end

Expand All @@ -417,31 +452,12 @@ defmodule Mariaex do

## Helpers

defp prepare_execute(conn, query, params, opts) do
case DBConnection.prepare_execute(conn, query, params, defaults(opts)) do
defp run_query(op, conn, query, params, opts) do
case apply(DBConnection, op, [conn, query, params, opts]) do
{:ok, _, result} ->
{:ok, result}
{:error, %ArgumentError{} = err} ->
raise err
{:error, _} = error ->
error
end
end

defp prepare_binary(conn, query, opts) do
case DBConnection.prepare(conn, query, defaults(opts)) do
{:error, %ArgumentError{} = err} ->
raise err
other ->
other
end
end

defp prepare_stream(conn, query, params, opts) do
DBConnection.prepare_stream(conn, query, params, defaults(opts))
end

defp defaults(opts) do
Keyword.put_new(opts, :timeout, @timeout)
end
end
Loading