View Source Exqlite.Sqlite3NIF (Exqlite v0.22.0)

This is the module where all of the NIF entry points reside. Calling this directly should be avoided unless you are aware of what you are doing.

Summary

Types

db()

reason()

row()

statement()

Functions

bind(conn, statement, args)

changes(conn)

close(conn)

columns(conn, statement)

deserialize(conn, database, serialized)

enable_load_extension(conn, flag)

execute(conn, sql)

interrupt(conn)

last_insert_rowid(conn)

load_nif()

multi_step(conn, statement, chunk_size)

open(path, flags)

prepare(conn, sql)

release(conn, statement)

serialize(conn, database)

set_log_hook(pid)

set_update_hook(conn, pid)

step(conn, statement)

transaction_status(conn)

Types

db()

@type db() :: reference()

reason()

@type reason() :: :atom | String.Chars.t()

row()

@type row() :: list()

statement()

@type statement() :: reference()

Functions

bind(conn, statement, args)

@spec bind(db(), statement(), list()) ::
  :ok | {:error, reason()} | {:error, {atom(), any()}}

changes(conn)

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

close(conn)

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

columns(conn, statement)

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

deserialize(conn, database, serialized)

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

enable_load_extension(conn, flag)

@spec enable_load_extension(db(), integer()) :: :ok | {:error, reason()}

execute(conn, sql)

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

interrupt(conn)

@spec interrupt(db()) :: :ok | {:error, reason()}

last_insert_rowid(conn)

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

load_nif()

multi_step(conn, statement, chunk_size)

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

open(path, flags)

@spec open(String.Chars.t(), integer()) :: {:ok, db()} | {:error, reason()}

prepare(conn, sql)

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

release(conn, statement)

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

serialize(conn, database)

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

set_log_hook(pid)

@spec set_log_hook(pid()) :: :ok | {:error, reason()}

set_update_hook(conn, pid)

@spec set_update_hook(db(), pid()) :: :ok | {:error, reason()}

step(conn, statement)

@spec step(db(), statement()) :: :done | :busy | {:row, row()} | {:error, reason()}

transaction_status(conn)

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