kotlin-node/node.sqlite/DatabaseSync

DatabaseSync

external class DatabaseSync : Disposable(source)

This class represents a single connection to a SQLite database. All APIs exposed by this class execute synchronously.

Since

v22.5.0

Constructors

DatabaseSync

constructor(path: PathLike, options: DatabaseSyncOptions = definedExternally)

Constructs a new DatabaseSync instance.

Properties

isOpen

val isOpen: Boolean

Whether the database is currently open or not.

isTransaction

val isTransaction: Boolean

Whether the database is currently within a transaction. This method is a wrapper around sqlite3_get_autocommit().

Functions

aggregate

fun <T> aggregate(name: String, options: AggregateOptions<T>)

applyChangeset

fun applyChangeset(changeset: Uint8Array<*>, options: ApplyChangesetOptions = definedExternally): Boolean

An exception is thrown if the database is not open. This method is a wrapper around sqlite3changeset_apply().

fun close()

Closes the database connection. An exception is thrown if the database is not open. This method is a wrapper around sqlite3_close_v2().

createSession

fun createSession(options: CreateSessionOptions = definedExternally): Session

Creates and attaches a session to the database. This method is a wrapper around sqlite3session_create() and sqlite3session_attach().

createTagStore

fun createTagStore(maxSize: Number = definedExternally): SQLTagStore

Creates a new SQLTagStore, which is an LRU (Least Recently Used) cache for storing prepared statements. This allows for the efficient reuse of prepared statements by tagging them with a unique identifier.

enableLoadExtension

fun enableLoadExtension(allow: Boolean)

Enables or disables the loadExtension SQL function, and the loadExtension() method. When allowExtension is false when constructing, you cannot enable loading extensions for security reasons.

exec

fun exec(sql: String)

This method allows one or more SQL statements to be executed without returning any results. This method is useful when executing SQL statements read from a file. This method is a wrapper around sqlite3_exec().

function

fun function(name: String, func: Function<SQLInputValue>)

fun function(name: String, options: FunctionOptions, func: Function<SQLInputValue>)

This method is used to create SQLite user-defined functions. This method is a wrapper around sqlite3_create_function_v2().

loadExtension

fun loadExtension(path: String)

Loads a shared library into the database connection. This method is a wrapper around sqlite3_load_extension(). It is required to enable the allowExtension option when constructing the DatabaseSync instance.

location

fun location(dbName: String = definedExternally): String?

This method is a wrapper around sqlite3_db_filename()

open

fun open()

Opens the database specified in the path argument of the DatabaseSyncconstructor. This method should only be used when the database is not opened via the constructor. An exception is thrown if the database is already open.

prepare

fun prepare(sql: String): StatementSync

Compiles a SQL statement into a prepared statement. This method is a wrapper around sqlite3_prepare_v2().

setAuthorizer

fun setAuthorizer(callback: (actionCode: Number, arg1: String?, arg2: String?, dbName: String?, triggerOrView: String?) -> Double?)

Sets an authorizer callback that SQLite will invoke whenever it attempts to access data or modify the database schema through prepared statements. This can be used to implement security policies, audit access, or restrict certain operations. This method is a wrapper around sqlite3_set_authorizer().