use db_timeout as Application config name

Also adds the @SPEC's back in for the lower-arity version of functions

Author: mmmries

lib/sqlitex.ex

@@ -35,24 +35,25 @@ defmodule Sqlitex do
   following in your `config.exs`:
 
   ```
-  config :sqlitex,
-    esqlite3_timeout: 10_000 # or other positive integer number of ms
+  config :sqlitex, db_timeout: 10_000 # or other positive integer number of ms
   ```
   """
 
   alias Sqlitex.Config
 
+  @spec close(connection) :: :ok
   @spec close(connection, Keyword.t) :: :ok
   def close(db, opts \\ []) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout())
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
     :esqlite3.close(db, timeout)
   end
 
+  @spec open(charlist | String.t) :: {:ok, connection} | {:error, {atom, charlist}}
   @spec open(charlist | String.t, Keyword.t) :: {:ok, connection} | {:error, {atom, charlist}}
   def open(path, opts \\ [])
   def open(path, opts) when is_binary(path), do: open(string_to_charlist(path), opts)
   def open(path, opts) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout())
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
     :esqlite3.open(path, timeout)
   end
 
@@ -63,9 +64,10 @@ defmodule Sqlitex do
     res
   end
 
+  @spec exec(connection, string_or_charlist) :: :ok | sqlite_error
   @spec exec(connection, string_or_charlist, Keyword.t) :: :ok | sqlite_error
   def exec(db, sql, opts \\ []) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout())
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
     :esqlite3.exec(sql, db, timeout)
   end
 

lib/sqlitex/config.ex

@@ -1,9 +1,7 @@
 defmodule Sqlitex.Config do
   @moduledoc false
 
-  def esqlite3_timeout do
-    Application.get_env(:sqlitex, :esqlite3_timeout, default_esqlite3_timeout())
+  def db_timeout do
+    Application.get_env(:sqlitex, :db_timeout, 5_000)
   end
-
-  def default_esqlite3_timeout, do: 5_000
 end

lib/sqlitex/query.ex

@@ -16,7 +16,7 @@ defmodule Sqlitex.Query do
     to bind as a list.
   * `into` - The collection to put results into.  This defaults to a list.
   * `db_timeout` - The timeout (in ms) to apply to each of the underlying SQLite operations. Defaults
-    to 5000, or to `Application.get_env(:sqlitex, :esqlite3_timeout)` if set.
+    to `Application.get_env(:sqlitex, :db_timeout)` or `5000`ms if not configured.
 
   ## Returns
   * [results...] on success
@@ -65,7 +65,7 @@ defmodule Sqlitex.Query do
   * `bind` - If your query has parameters in it, you should provide the options
     to bind as a list.
   * `db_timeout` - The timeout (in ms) to apply to each of the underlying SQLite operations. Defaults
-    to 5000, or to `Application.get_env(:sqlitex, :esqlite3_timeout)` if set.
+    to `Application.get_env(:sqlitex, :db_timeout)` or `5000`ms if not configured.
 
   ## Returns
   * {:ok, %{rows: [[1, 2], [2, 3]], columns: [:a, :b], types: [:INTEGER, :INTEGER]}} on success

lib/sqlitex/server.ex

@@ -59,11 +59,11 @@ defmodule Sqlitex.Server do
     that are cached when calling `prepare/3`.
   - `db_timeout: (positive_integer)` to override `:esqlite3`'s default timeout of 5000 ms for
     interactions with the database. This can also be set in `config.exs` as
-    `config :sqlitex, esqlite3_timeout: 5_000`.
+    `config :sqlitex, db_timeout: 5_000`.
   """
   def start_link(db_path, opts \\ []) do
     stmt_cache_size = Keyword.get(opts, :stmt_cache_size, 20)
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout())
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
     GenServer.start_link(__MODULE__, {db_path, stmt_cache_size, timeout}, opts)
   end
 

lib/sqlitex/statement.ex

@@ -85,15 +85,15 @@ defmodule Sqlitex.Statement do
 
   Also accepts the following keyword options:
 
-  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :esqlite3_timeout value in Application env.
+  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :db_timeout value in Application env.
 
   ## Returns
 
   * `{:ok, statement}` on success
   * See `:esqlite3.prepare` for errors.
   """
   def prepare(db, sql, opts \\ []) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout)
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
 
     with {:ok, stmt} <- do_prepare(db, sql, timeout),
          {:ok, stmt} <- get_column_names(stmt, timeout),
@@ -124,7 +124,7 @@ defmodule Sqlitex.Statement do
 
   Also accepts the following keyword options:
 
-  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :esqlite3_timeout value in Application env.
+  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :db_timeout value in Application env.
 
   ## Returns
 
@@ -142,7 +142,7 @@ defmodule Sqlitex.Statement do
   * `%Decimal` -  Converted into a number.
   """
   def bind_values(statement, values, opts \\ []) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout)
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
 
     case :esqlite3.bind(statement.statement, translate_bindings(values), timeout) do
       {:error, _} = error -> error
@@ -215,15 +215,15 @@ defmodule Sqlitex.Statement do
 
   Also accepts the following keyword options:
 
-  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :esqlite3_timeout value in Application env.
+  * `db_timeout` - The time in ms allowed for the statement to run. Defaults to 5000, or the :db_timeout value in Application env.
 
   ## Returns
 
   * `:ok`
   * `{:error, error}`
   """
   def exec(statement, opts \\ []) do
-    timeout = Keyword.get(opts, :db_timeout, Config.esqlite3_timeout)
+    timeout = Keyword.get(opts, :db_timeout, Config.db_timeout())
 
     case :esqlite3.step(statement.statement, timeout) do
       # esqlite3.step returns some odd values, so lets translate them:

test/server/statement_cache_test.exs

@@ -10,19 +10,19 @@ defmodule Sqlitex.Server.StatementCacheTest do
     cache = S.new(db, 3)
     assert %S{cached_stmts: %{}, db: _, limit: 3, lru: [], size: 0} = cache
 
-    {cache, stmt1a} = S.prepare(cache, "SELECT 42", [db_timeout: 5_000])
+    {cache, stmt1a} = S.prepare(cache, "SELECT 42")
     assert %Stmt{column_names: [:"42"], column_types: [nil]} = stmt1a
 
     {cache, stmt2a} = S.prepare(cache, "SELECT 43", [db_timeout: 5_000])
     assert %Stmt{column_names: [:"43"], column_types: [nil]} = stmt2a
 
-    {cache, stmt3} = S.prepare(cache, "SELECT 44", [db_timeout: 5_000])
+    {cache, stmt3} = S.prepare(cache, "SELECT 44")
     assert %Stmt{column_names: [:"44"], column_types: [nil]} = stmt3
 
     {cache, stmt1b} = S.prepare(cache, "SELECT 42", [db_timeout: 5_000])
     assert stmt1a == stmt1b # shouldn't have been purged
 
-    {cache, stmt4} = S.prepare(cache, "SELECT 353", [db_timeout: 5_000])
+    {cache, stmt4} = S.prepare(cache, "SELECT 353")
     assert %Stmt{column_names: [:"353"], column_types: [nil]} = stmt4
 
     {_cache, stmt2b} = S.prepare(cache, "SELECT 42", [db_timeout: 5_000])