Exqlite.Sqlite3 (Exqlite v0.5.11) View Source

The interface to the NIF implementation.

Link to this section Summary

Types

db()

reason()

row()

statement()

Functions

bind(conn, statement, args)

changes(conn)

Get the number of changes recently.

close(conn)

Closes the database and releases any underlying resources.

columns(conn, statement)

execute(conn, sql)

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

fetch_all(conn, statement)

fetch_all(conn, statement, chunk_size)

last_insert_rowid(conn)

multi_step(conn, statement)

multi_step(conn, statement, chunk_size)

open(path)

Opens a new sqlite database at the Path provided.

prepare(conn, sql)

shrink_memory(conn)

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

step(conn, statement)

transaction_status(conn)

Link to this section Types

db()

Specs

db() :: reference()

reason()

Specs

reason() :: atom() | String.t()

row()

Specs

row() :: []

statement()

Specs

statement() :: reference()

Link to this section Functions

bind(conn, statement, args)

Specs

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

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

changes(conn)

Specs

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

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

close(conn)

Specs

close(nil) :: :ok

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

Closes the database and releases any underlying resources.

columns(conn, statement)

Specs

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

execute(conn, sql)

Specs

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

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

fetch_all(conn, statement)

Specs

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

fetch_all(conn, statement, chunk_size)

Specs

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

last_insert_rowid(conn)

Specs

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

multi_step(conn, statement)

Specs

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

multi_step(conn, statement, chunk_size)

Specs

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

open(path)

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.

prepare(conn, sql)

Specs

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

shrink_memory(conn)

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.

step(conn, statement)

Specs

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

transaction_status(conn)

Specs

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