Module sqlite3_nif

Description
Data Types
Function Index
Function Details

A low-level NIF interface to sqlite3.

Description

A low-level NIF interface to sqlite3.

Most of the exposed functions follow the C API to the letter so the official documentation should be considered as the primary source of information, while the C API introduction should be read as a "Getting Started Guide".

Data Types

open_flag()

open_flags()

open_flags() = open_flag() | integer()

open_flags() is Flag1 bor Flag2 bor ... where FlagN is one of the open_flag() values. See C function documentation for details.

sqlite3()

abstract datatype: sqlite3()

An opaque handle that represents a database connection object.

sqlite3_backup()

abstract datatype: sqlite3_backup()

A opaque handle to use with Backup API.

sqlite3_blob()

abstract datatype: sqlite3_blob()

A opaque handle to use with Blobs API.

sqlite3_error_code()

sqlite3_error_code() = integer()

sqlite3_error_code is an integer which corresponds to one of the constants specified at Result and Error Codes page.

sqlite3_snapshot()

abstract datatype: sqlite3_snapshot()

A opaque handle to use with Snapshot API.

sqlite3_stmt()

abstract datatype: sqlite3_stmt()

A opaque handle that represents a prepared statement.

sqlite3_str()

sqlite3_str() = iodata()

sqlite3_str() is iodata() which contains a UTF-8 encoded string.

Function Index

sqlite3_backup_finish/1	Release resources associated with the backup.
sqlite3_backup_init/4	Initialise Backup object.
sqlite3_backup_pagecount/1	Get the number of pages to be copied for the database.
sqlite3_backup_remaining/1	Get the remaining number of pages to copy.
sqlite3_backup_step/2	Copy the specified number of pages or all pages if `NumPages` is set to -1.
sqlite3_bind/2	Bind parameters to a compiled SQL statement.
sqlite3_blob_bytes/1	Size of the BLOB.
sqlite3_blob_close/1	Close a BLOB handle.
sqlite3_blob_open/6	Open a BLOB for incremental I/O.
sqlite3_blob_read/3	Read data from a BLOB incrementally.
sqlite3_blob_reopen/2	Move a BLOB handle to a new row.
sqlite3_blob_write/3	Write data into a BLOB incrementally.
sqlite3_busy_timeout/2	Set a busy timeout.
sqlite3_changes/1	Count the number of modified rows by the last statement.
sqlite3_clear_bindings/1	Reset all bindings on a prepared statement.
sqlite3_close_v2/1	Close a database connection.
sqlite3_compileoption_get/1	Get a compile option string number `N`.
sqlite3_compileoption_used/1	Ask if a specified compile option was set.
sqlite3_complete/1	Determine if an SQL statement is complete.
sqlite3_data_count/1	Number of columns in a result set.
sqlite3_db_cacheflush/1	Flush caches to disk mid-transaction.
sqlite3_db_config/3	Configure a database connection.
sqlite3_db_filename/2	Return the filename for a database connection.
sqlite3_db_readonly/2	Test if the DB is opened in read-only mode.
sqlite3_db_release_memory/1	Free memory used by a database connection.
sqlite3_db_status/3	Get database connection stats.
sqlite3_deserialize/3	Replace a DB schema with the contents of the serialized database.
sqlite3_errcode/1	Get the latest error code associated with the connection.
sqlite3_errmsg/1	Get the human-readable error message associated with the connection.
sqlite3_errstr/1	Convert error code to a human-readable message.
sqlite3_expanded_sql/1	Return SQL code associated with the compiled statement with the parameter list expanded.
sqlite3_extended_errcode/1	Get the latest extended error code associated with the connection.
sqlite3_extended_result_codes/2	Enable or disable extended result codes.
sqlite3_finalize/1	Free resources allocated for a prepared statement.
sqlite3_get_autocommit/1	Test for auto-commit mode.
sqlite3_interrupt/1	Interrupt a long-running query.
sqlite3_last_insert_rowid/1	Get the last insert rowid value.
sqlite3_libversion/0	Library version.
sqlite3_libversion_number/0	Library version as number.
sqlite3_limit/3	Change per-connection run-time limits.
sqlite3_load_extension/3	Load an extension.
sqlite3_normalized_sql/1	Return normalised SQL code associated with the compiled statement, whatever it means.
sqlite3_open_v2/3	Open a new database connection.
sqlite3_prepare_v2/2	Compile an SQL statement.
sqlite3_reset/1	Reset a prepared statement object.
sqlite3_serialize/2	Serialise a database into a binary.
sqlite3_set_last_insert_rowid/2
sqlite3_snapshot_cmp/2	Compare which snapshot coresspond to an earlier database state.
sqlite3_snapshot_free/1	Destroy a snapshot.
sqlite3_snapshot_get/2	Record a database snapshot.
sqlite3_snapshot_open/3	Start a read transaction on an historical snapshot.
sqlite3_snapshot_recover/2	Recover snapshots from a wal file.
sqlite3_sourceid/0	Timestamp and hash of the source code used to build the sqlite3 library.
sqlite3_sql/1	Return SQL code used for the compiled statement.
sqlite3_step/1	Evaluate a compiled SQL statement.
sqlite3_stmt_busy/1	Determine if a prepared statement has been reset.
sqlite3_stmt_isexplain/1	Query the EXPLAIN setting for a prepared statement.
sqlite3_stmt_readonly/1	Determine if an sql statement writes the database.
sqlite3_stmt_status/3	Prepared statement status.
sqlite3_total_changes/1	Count the total number of modified rows since the connection was opened.
sqlite3_txn_state/2	Determine the transaction state of a database.
sqlite3_wal_autocheckpoint/2	Configure an auto-checkpoint.
sqlite3_wal_checkpoint_v2/3	Checkpoint a database.

Function Details

sqlite3_backup_finish/1

sqlite3_backup_finish(Backup) -> Result

Backup = sqlite3_backup()
Result = sqlite3_error_code()

Release resources associated with the backup. Note, there is no need to call the function because the Backup object is reference-counted and will be released automatically.

sqlite3_backup_init/4

sqlite3_backup_init(DstConn, DstDbName, SrcConn, SrcDbName) -> Result

DstConn = sqlite3()
DstDbName = sqlite3_str()
SrcConn = sqlite3()
SrcDbName = sqlite3_str()
Result = {ok, Backup} | {error, ErrorCode}
Backup = sqlite3_backup()
ErrorCode = sqlite3_error_code()

Initialise Backup object.

sqlite3_backup_pagecount/1

sqlite3_backup_pagecount(Backup) -> Result

Backup = sqlite3_backup()
Result = integer()

Get the number of pages to be copied for the database.

sqlite3_backup_remaining/1

sqlite3_backup_remaining(Backup) -> Result

Backup = sqlite3_backup()
Result = integer()

Get the remaining number of pages to copy.

sqlite3_backup_step/2

sqlite3_backup_step(Backup::sqlite3_backup(), NumPages) -> Result

NumPages = integer()
Result = sqlite3_error_code()

Copy the specified number of pages or all pages if NumPages is set to -1.

sqlite3_bind/2

sqlite3_bind(Stmt::sqlite3_stmt(), Terms::[Val]) -> Result

Val = number() | true | false | Null | {text, sqlite3_str()} | {blob, iodata()}
Null = nil | undefined
Result = ok | {error, Reason}
Reason = sqlite3_error_code() | {wrong_parameter_type, pos_integer()} | wrong_parameter_count

Bind parameters to a compiled SQL statement.

sqlite3_blob_bytes/1

sqlite3_blob_bytes(Blob::sqlite3_blob()) -> integer()

Size of the BLOB.

sqlite3_blob_close/1

sqlite3_blob_close(Blob::sqlite3_blob()) -> sqlite3_error_code()

Close a BLOB handle. Note, normally, there is no need to call the function since the object is reference-counted and will be released automatically.

sqlite3_blob_open/6

sqlite3_blob_open(Db::sqlite3(), DbName, TabName, ColumnName, RowId, Flags) -> Result

DbName = sqlite3_str()
TabName = sqlite3_str()
ColumnName = sqlite3_str()
RowId = integer()
Flags = integer()
Result = {ok, sqlite3_blob()} | {error, sqlite3_error_code()}

Open a BLOB for incremental I/O.

sqlite3_blob_read/3

sqlite3_blob_read(Blob::sqlite3_blob(), N, Offset) -> Result

N = non_neg_integer()
Offset = non_neg_integer()
Result = {ok, binary()} | {error, sqlite3_error_code()}

Read data from a BLOB incrementally.

sqlite3_blob_reopen/2

sqlite3_blob_reopen(Blob::sqlite3_blob(), Rowid) -> sqlite3_error_code()

Rowid = integer()

Move a BLOB handle to a new row.

sqlite3_blob_write/3

sqlite3_blob_write(Blob, Data, Offset) -> Result

Blob = sqlite3_blob()
Data = iodata()
Offset = non_neg_integer()
Result = ok | {error, sqlite3_error_code()}

Write data into a BLOB incrementally.

sqlite3_busy_timeout/2

sqlite3_busy_timeout(Db::sqlite3(), Duration::integer()) -> sqlite3_error_code()

Set a busy timeout.

sqlite3_changes/1

sqlite3_changes(Db::sqlite3()) -> integer()

Count the number of modified rows by the last statement.

sqlite3_clear_bindings/1

sqlite3_clear_bindings(Stmt::sqlite3_stmt()) -> sqlite3_error_code()

Reset all bindings on a prepared statement.

sqlite3_close_v2/1

sqlite3_close_v2(Db::sqlite3()) -> sqlite3_error_code()

Close a database connection. Note, it is not mandatory to close an open connection using the function since it is reference counted and will be closed automatically. The only case where it may be required to close it is when some action is expected to be performed by SQLite engine (e.g. WAL file is removed when all connections to a DB file are closed).

sqlite3_compileoption_get/1

sqlite3_compileoption_get(N::integer()) -> binary() | nil

Get a compile option string number N. Can be used to receive the total number of compile opitons.

sqlite3_compileoption_used/1

sqlite3_compileoption_used(OptName) -> integer()

OptName = sqlite3_str()

Ask if a specified compile option was set.

sqlite3_complete/1

sqlite3_complete(Sql::sqlite3_str()) -> integer()

Determine if an SQL statement is complete.

sqlite3_data_count/1

sqlite3_data_count(Stmt::sqlite3_stmt()) -> integer()

Number of columns in a result set.

sqlite3_db_cacheflush/1

sqlite3_db_cacheflush(Db::sqlite3()) -> sqlite3_error_code()

Flush caches to disk mid-transaction.

sqlite3_db_config/3

sqlite3_db_config(Db::sqlite3(), Opt, Val) -> Result

Opt = '?SQLITE_DBCONFIG_MAINDBNAME' | '?SQLITE_DBCONFIG_ENABLE_FKEY' | '?SQLITE_DBCONFIG_ENABLE_TRIGGER' | '?SQLITE_DBCONFIG_ENABLE_FTS3_TOKENIZER' | '?SQLITE_DBCONFIG_ENABLE_LOAD_EXTENSION' | '?SQLITE_DBCONFIG_NO_CKPT_ON_CLOSE' | '?SQLITE_DBCONFIG_ENABLE_QPSG' | '?SQLITE_DBCONFIG_TRIGGER_EQP' | '?SQLITE_DBCONFIG_RESET_DATABASE' | '?SQLITE_DBCONFIG_DEFENSIVE' | '?SQLITE_DBCONFIG_WRITABLE_SCHEMA' | '?SQLITE_DBCONFIG_LEGACY_ALTER_TABLE' | '?SQLITE_DBCONFIG_DQS_DML' | '?SQLITE_DBCONFIG_DQS_DDL' | '?SQLITE_DBCONFIG_ENABLE_VIEW' | '?SQLITE_DBCONFIG_LEGACY_FILE_FORMAT' | '?SQLITE_DBCONFIG_TRUSTED_SCHEMA'
Val = integer() | sqlite3_str()
Result = sqlite3_error_code() | {sqlite3_error_code(), integer()}

Configure a database connection.

sqlite3_db_filename/2

sqlite3_db_filename(Db::sqlite3(), DbName) -> DbFileName

DbName = sqlite3_str()
DbFileName = binary()

Return the filename for a database connection.

sqlite3_db_readonly/2

sqlite3_db_readonly(Db::sqlite3(), DbName) -> Result

DbName = sqlite3_str()
Result = -1 | 0 | 1

Test if the DB is opened in read-only mode.

sqlite3_db_release_memory/1

sqlite3_db_release_memory(Db::sqlite3()) -> sqlite3_error_code()

Free memory used by a database connection.

sqlite3_db_status/3

sqlite3_db_status(Db::sqlite3(), StatusOpt, ResetFlag) -> Result

StatusOpt = '?SQLITE_DBSTATUS_LOOKASIDE_USED' | '?SQLITE_DBSTATUS_CACHE_USED' | '?SQLITE_DBSTATUS_SCHEMA_USED' | '?SQLITE_DBSTATUS_STMT_USED' | '?SQLITE_DBSTATUS_LOOKASIDE_HIT' | '?SQLITE_DBSTATUS_LOOKASIDE_MISS_SIZE' | '?SQLITE_DBSTATUS_LOOKASIDE_MISS_FULL' | '?SQLITE_DBSTATUS_CACHE_HIT' | '?SQLITE_DBSTATUS_CACHE_MISS' | '?SQLITE_DBSTATUS_CACHE_WRITE' | '?SQLITE_DBSTATUS_DEFERRED_FKS' | '?SQLITE_DBSTATUS_CACHE_USED_SHARED' | '?SQLITE_DBSTATUS_CACHE_SPILL'
ResetFlag = 0 | 1
Result = {CurVal, HighVal} | {error, sqlite3_error_code()}
CurVal = integer()
HighVal = integer()

Get database connection stats.

sqlite3_deserialize/3

sqlite3_deserialize(Db::sqlite3(), DbName, Serialization) -> Result

DbName = sqlite3_str()
Serialization = binary()
Result = sqlite3_error_code()

Replace a DB schema with the contents of the serialized database.

sqlite3_errcode/1

sqlite3_errcode(Db::sqlite3()) -> sqlite3_error_code()

Get the latest error code associated with the connection.

sqlite3_errmsg/1

sqlite3_errmsg(Db::sqlite3()) -> binary()

Get the human-readable error message associated with the connection.

sqlite3_errstr/1

sqlite3_errstr(ErrorCode::sqlite3_error_code()) -> binary()

Convert error code to a human-readable message.

sqlite3_expanded_sql/1

sqlite3_expanded_sql(Stmt::sqlite3_stmt()) -> binary()

Return SQL code associated with the compiled statement with the parameter list expanded.

sqlite3_extended_errcode/1

sqlite3_extended_errcode(Db::sqlite3()) -> sqlite3_error_code()

Get the latest extended error code associated with the connection.

sqlite3_extended_result_codes/2

sqlite3_extended_result_codes(Db::sqlite3(), OnOff) -> sqlite3_error_code()

OnOff = 0 | 1

Enable or disable extended result codes.

LimitId = '?SQLITE_LIMIT_LENGTH' | '?SQLITE_LIMIT_SQL_LENGTH' | '?SQLITE_LIMIT_COLUMN' | '?SQLITE_LIMIT_EXPR_DEPTH' | '?SQLITE_LIMIT_COMPOUND_SELECT' | '?SQLITE_LIMIT_VDBE_OP' | '?SQLITE_LIMIT_FUNCTION_ARG' | '?SQLITE_LIMIT_ATTACHED' | '?SQLITE_LIMIT_LIKE_PATTERN_LENGTH' | '?SQLITE_LIMIT_VARIABLE_NUMBER' | '?SQLITE_LIMIT_TRIGGER_DEPTH' | '?SQLITE_LIMIT_WORKER_THREADS'
NewVal = integer()

Change per-connection run-time limits.

sqlite3_load_extension/3

sqlite3_load_extension(Db::sqlite3(), ExtFile, EntryPoint) -> Result

ExtFile = sqlite3_str()
EntryPoint = sqlite3_str()
Result = ok | {error, string()}

Load an extension.

sqlite3_normalized_sql/1

sqlite3_normalized_sql(Stmt::sqlite3_stmt()) -> binary()

Return normalised SQL code associated with the compiled statement, whatever it means.

sqlite3_open_v2/3

sqlite3_open_v2(FileName, Flags, Vfs) -> Result

FileName = sqlite3_str()
Flags = open_flags()
Vfs = sqlite3_str()
Result = {ok, sqlite3()} | {error, sqlite3_error_code()}

Open a new database connection.

sqlite3_prepare_v2/2

sqlite3_prepare_v2(Db::sqlite3(), Sql) -> Result

Sql = sqlite3_str()
Result = {ok, sqlite3_stmt(), Leftover} | {error, sqlite3_error_code()}
Leftover = binary()

Compile an SQL statement.

sqlite3_reset/1

sqlite3_reset(Stmt::sqlite3_stmt()) -> sqlite3_error_code()

Reset a prepared statement object.

sqlite3_serialize/2

sqlite3_serialize(Db::sqlite3(), DbName) -> Result

DbName = sqlite3_str()
Result = {ok, Serialization::binary()} | {error, alloc_memory}

Serialise a database into a binary.

sqlite3_set_last_insert_rowid/2

sqlite3_set_last_insert_rowid(Db::sqlite3(), NewRowid::integer()) -> ok

sqlite3_snapshot_cmp/2

sqlite3_snapshot_cmp(Snapshot1, Snapshot2) -> Result

Snapshot1 = sqlite3_snapshot()
Snapshot2 = sqlite3_snapshot()
Result = integer()

Compare which snapshot coresspond to an earlier database state.

sqlite3_snapshot_free/1

sqlite3_snapshot_free(Snapshot::sqlite3_snapshot()) -> ok

Destroy a snapshot. Note, normally, there is no need to call the function since the snapshot object is reference-counted and destroyed automatically.

sqlite3_snapshot_get/2

sqlite3_snapshot_get(Db::sqlite3(), DbName) -> Result

DbName = sqlite3_str()
Result = {ok, sqlite3_snapshot()} | {error, sqlite3_error_code()}

Record a database snapshot.

sqlite3_snapshot_open/3

sqlite3_snapshot_open(Db::sqlite3(), DbName::sqlite3_str(), Snapshot::sqlite3_snapshot()) -> sqlite3_error_code()

Start a read transaction on an historical snapshot.

sqlite3_snapshot_recover/2

sqlite3_snapshot_recover(Db::sqlite3(), DbName) -> Result

DbName = sqlite3_str()
Result = sqlite3_error_code()

Recover snapshots from a wal file.

Result = ok | Row | {error, sqlite3_error_code()}
Row = tuple()

Evaluate a compiled SQL statement.

StmtStatus = '?SQLITE_STMTSTATUS_FULLSCAN_STEP' | '?SQLITE_STMTSTATUS_SORT' | '?SQLITE_STMTSTATUS_AUTOINDEX' | '?SQLITE_STMTSTATUS_VM_STEP' | '?SQLITE_STMTSTATUS_REPREPARE' | '?SQLITE_STMTSTATUS_RUN' | '?SQLITE_STMTSTATUS_MEMUSED'
ResetFlag = 0 | 1
Result = integer()

Prepared statement status.

sqlite3_total_changes/1

sqlite3_total_changes(Db::sqlite3()) -> integer()

Count the total number of modified rows since the connection was opened.

sqlite3_txn_state/2

sqlite3_txn_state(Db::sqlite3(), DbName) -> Result

DbName = sqlite3_str()
Result = -1 | '?SQLITE_TXN_NONE' | '?SQLITE_TXN_READ' | '?SQLITE_TXN_WRITE'

Determine the transaction state of a database.

sqlite3_wal_autocheckpoint/2

sqlite3_wal_autocheckpoint(Db::sqlite3(), NFrames) -> sqlite3_error_code()

NFrames = integer()

Configure an auto-checkpoint.

sqlite3_wal_checkpoint_v2/3

sqlite3_wal_checkpoint_v2(Db::sqlite3(), DbName, Mode) -> Result

DbName = sqlite3_str()
Mode = '?SQLITE_CHECKPOINT_PASSIVE' | '?SQLITE_CHECKPOINT_FULL' | '?SQLITE_CHECKPOINT_RESTART' | '?SQLITE_CHECKPOINT_TRUNCATE'
Result = {ok, {LogSize, TotalFrames}} | {error, sqlite3_error_code()}
LogSize = integer()
TotalFrames = integer()

Checkpoint a database.

Generated by EDoc