Module esqlite3_nif

Description
Data Types
Function Index
Function Details

Low level Erlang API for sqlite3 databases.

Authors: Maas-Maarten Zeeman (mmzeeman@xs4all.nl).

Description

Low level Erlang API for sqlite3 databases.

Data Types

cell()

cell() = undefined | integer() | float() | binary()

error()

error() = {error, extended_errcode()}

error_info()

error_info() = #{errcode := integer(), extended_errcode := extended_errcode(), errstr := unicode:unicode_binary(), errmsg := unicode:unicode_binary(), error_offset := integer()}

esqlite3_backup_ref()

esqlite3_backup_ref() = reference()

Reference to a online backup object. See https://sqlite.org/c3ref/backup.html for more details.

esqlite3_ref()

esqlite3_ref() = reference()

Reference to a database connection handle. See https://sqlite.org/c3ref/sqlite3.html for more details.

esqlite3_stmt_ref()

esqlite3_stmt_ref() = reference()

Reference to a prepared statement object. See https://sqlite.org/c3ref/stmt.html for more details.

extended_errcode()

extended_errcode() = integer()

Extended sqlite3 error code. See https://sqlite.org/rescode.html for more details.

row()

row() = [cell()]

rowid()

rowid() = integer()

sql()

sql() = iodata()

Make sure the iodata contains utf-8 encoded data.

Function Index

open/1	Open the specified sqlite3 database.
close/1	Close the connection.
error_info/1	Get an error messages for the last occurred error.
set_update_hook/2	Set an update hook.
exec/2	Execute a sql statement.
prepare/3	Compile a sql statement.
bind_int/3	Bind an integer to a position in a prepared statement.
bind_int64/3	Bind a 64 bit integer to a position in a prepared statement.
bind_double/3	Bind an double/float to a position in a prepared statement.
bind_text/3	Bind a utf-8 string to a position in a prepared statement.
bind_blob/3	Bind a blob to a position in a prepared statement.
bind_null/2	Bind a null to a position in a prepared statement.
bind_parameter_index/2
step/1
reset/1
column_names/1	Retrieve the column names of the prepared statement.
column_decltypes/1	Retrieve the declared datatypes of all columns.
backup_init/4	Initialize a backup procedure of a database.
backup_remaining/1
backup_pagecount/1
backup_step/2
backup_finish/1
interrupt/1	Interrupt all active queries.
last_insert_rowid/1	Get the last insert rowid.
changes/1	Get number of changes insert, delete of the most recent completed INSERT, DELETE or UPDATE statement.
get_autocommit/1	Get autocommit.
memory_stats/1	Get memory statistics.
status/2	Get sqlite status information.

Function Details

open/1

open(Filename) -> OpenResult

Filename = string()
OpenResult = {ok, esqlite3_ref()} | error()

Open the specified sqlite3 database. It is possible to use sqlite's uri filenames to open files. See: https://sqlite.org/uri.html for more information.

close/1

close(Connection) -> CloseResult

Connection = esqlite3_ref()
CloseResult = ok | {error, term()}

Close the connection.

error_info/1

error_info(Connection) -> ErrorInfo

Connection = esqlite3_ref()
ErrorInfo = error_info()

Get an error messages for the last occurred error.

set_update_hook/2

set_update_hook(Connection, Pid) -> Result

Connection = esqlite3_ref()
Pid = pid()
Result = ok

Set an update hook

exec/2

exec(Connection, Sql) -> ExecResult

Connection = esqlite3_ref()
Sql = sql()
ExecResult = ok | error()

Execute a sql statement

prepare/3

prepare(Connection, Sql, PrepareFlags) -> PrepareResult

Connection = esqlite3_ref()
Sql = sql()
PrepareFlags = non_neg_integer()
PrepareResult = {ok, esqlite3_stmt_ref()} | error()

Compile a sql statement.

bind_int/3

bind_int(Statement, Index, Value) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Value = integer()
Result = ok | error()

Bind an integer to a position in a prepared statement.

bind_int64/3

bind_int64(Statement, Index, Value) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Value = integer()
Result = ok | error()

Bind a 64 bit integer to a position in a prepared statement.

bind_double/3

bind_double(Statement, Index, Value) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Value = float()
Result = ok | error()

Bind an double/float to a position in a prepared statement.

bind_text/3

bind_text(Statement, Index, Value) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Value = iodata()
Result = ok | error()

Bind a utf-8 string to a position in a prepared statement.

bind_blob/3

bind_blob(Statement, Index, Value) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Value = iodata()
Result = ok | error()

Bind a blob to a position in a prepared statement.

bind_null/2

bind_null(Statement, Index) -> Result

Statement = esqlite3_stmt_ref()
Index = integer()
Result = ok | error()

Bind a null to a position in a prepared statement.

bind_parameter_index/2

bind_parameter_index(Statement, ParameterName) -> Result

Statement = esqlite3_stmt_ref()
ParameterName = iodata()
Result = {ok, integer()} | error

step/1

step(Statement) -> StepResult

Statement = esqlite3_stmt_ref()
StepResult = row() | '$done' | error()

reset/1

reset(Statement) -> ResetResult

Statement = esqlite3_stmt_ref()
ResetResult = ok | error()

column_names/1

column_names(Statement) -> Names

Statement = esqlite3_stmt_ref()
Names = [unicode:unicode_binary()]

Retrieve the column names of the prepared statement

column_decltypes/1

column_decltypes(Statement) -> Types

Statement = esqlite3_stmt_ref()
Types = [undefined | unicode:unicode_binary()]

Retrieve the declared datatypes of all columns.

backup_init/4

backup_init(Destination, DestinationName, Source, SourceName) -> InitResult

Destination = esqlite3_ref()
DestinationName = iodata()
Source = esqlite3_ref()
SourceName = iodata()
InitResult = {ok, esqlite3_backup_ref()} | error()

Initialize a backup procedure of a database.

backup_remaining/1

backup_remaining(Backup) -> Remaining

Backup = esqlite3_backup_ref()
Remaining = integer()

backup_pagecount/1

backup_pagecount(Backup) -> Pagecount

Backup = esqlite3_backup_ref()
Pagecount = integer()

backup_step/2

backup_step(Backup, NPage) -> Result

Backup = esqlite3_backup_ref()
NPage = integer()
Result = ok | '$done' | error()

backup_finish/1

backup_finish(Backup) -> Result

Backup = esqlite3_backup_ref()
Result = ok | error()

interrupt/1

interrupt(Db::esqlite3_ref()) -> ok

Interrupt all active queries.

last_insert_rowid/1

last_insert_rowid(Connection::esqlite3_ref()) -> rowid()

Get the last insert rowid.

changes/1

changes(Connection::esqlite3_ref()) -> integer()

Get number of changes insert, delete of the most recent completed INSERT, DELETE or UPDATE statement.

get_autocommit/1

get_autocommit(Connection::esqlite3_ref()) -> true | false

Get autocommit

memory_stats/1

memory_stats(HighwaterResetFlag) -> Stats

HighwaterResetFlag = integer()
Stats = #{used := integer(), highwater := integer()}

Get memory statistics

status/2

status(Op, HighwaterResetFlag) -> Stats

Op = integer()
HighwaterResetFlag = integer()
Stats = #{used := non_neg_integer(), highwater := non_neg_integer()}

Get sqlite status information.


  MEMORY_USED        0
  PAGECACHE_USED     1
  PAGECACHE_OVERFLOW 2
  MALLOC_SIZE        5
  PARSER_STACK       6
  PAGECACHE_SIZE     7
  MALLOC_COUNT       8

Generated by EDoc