Specs

bind(db(), statement(), nil) :: :ok | {:error, reason()}

bind(db(), statement(), list()) :: :ok | {:error, reason()}

Specs

changes(db()) :: {:ok, integer()} | {:error, reason()}

Get the number of changes recently.

Note: If triggers are used, the count may be larger than expected.

See: https://sqlite.org/c3ref/changes.html

Specs

close(nil) :: :ok

close(db()) :: :ok | {:error, reason()}

Closes the database and releases any underlying resources.

Specs

columns(db(), statement()) :: {:ok, [binary()]} | {:error, reason()}

Specs

deserialize(db(), String.t(), binary()) :: :ok | {:error, reason()}

Disconnect from database and then reopen as an in-memory database based on the serialized binary.

Specs

enable_load_extension(db(), boolean()) :: :ok | {:error, reason()}

Allow loading native extensions.

Specs

execute(db(), String.t()) :: :ok | {:error, reason()}

Executes an sql script. Multiple stanzas can be passed at once.

Specs

fetch_all(db(), statement()) :: {:ok, [row()]} | {:error, reason()}

Specs

fetch_all(db(), statement(), integer()) :: {:ok, [row()]} | {:error, reason()}

Specs

last_insert_rowid(db()) :: {:ok, integer()}

Specs

multi_step(db(), statement()) ::
  :busy | {:rows, [row()]} | {:done, [row()]} | {:error, reason()}

Specs

multi_step(db(), statement(), integer()) ::
  :busy | {:rows, [row()]} | {:done, [row()]} | {:error, reason()}

Specs

open(String.t()) :: {:ok, db()} | {:error, reason()}

Opens a new sqlite database at the Path provided.

If path can be ":memory" to keep the sqlite database in memory.

Specs

prepare(db(), String.t()) :: {:ok, statement()} | {:error, reason()}

Specs

release(db(), statement()) :: :ok | {:error, reason()}

Once finished with the prepared statement, call this to release the underlying resources.

This should be called whenever you are done operating with the prepared statement. If the system has a high load the garbage collector may not clean up the prepared statements in a timely manner and causing higher than normal levels of memory pressure.

If you are operating on limited memory capacity systems, definitely call this.

Specs

serialize(db(), String.t()) :: {:ok, binary()} | {:error, reason()}

Serialize the contents of the database to a binary.

Specs

shrink_memory(db()) :: :ok | {:error, reason()}

Causes the database connection to free as much memory as it can. This is useful if you are on a memory restricted system.

Specs

step(db(), statement()) :: :done | :busy | {:row, [row()]} | {:error, reason()}

Specs

transaction_status(db()) :: {:ok, :idle | :transaction}