SqliteBackend

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:63

Abstract interface for SQLite WASM backend implementations.

Implementations:

• WaSqliteBackend (packages/rxdb-adapter-wa-sqlite)
• SqliteaiBackend (packages/rxdb-adapter-sqliteai)

Methods

changes()

changes(): number;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:107

Return the number of rows modified by the most recent INSERT/UPDATE/DELETE.

Returns

number

---

close()

close(): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:75

Close the database connection and release resources. After close(), all other methods must throw.

Returns

Promise<void>

---

createFunction()

createFunction(name, fn): void;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:97

Register a custom scalar SQL function.

Parameters

Parameter	Type	Description
name	string	Function name usable in SQL (e.g., 'regexp')
fn	(...args) => SQLiteCompatibleType	Implementation function

Returns

void

---

exec()

exec(sql, bindings?): Promise<SqliteExecResult>;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:83

Execute a SQL statement and return results.

Parameters

Parameter	Type	Description
sql	string	SQL statement(s) to execute
bindings?	SQLiteCompatibleType[]	Optional parameter bindings

Returns

Promise<SqliteExecResult>

Execution results with affected rows

---

open()

open(filename, options?): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:69

Initialize and open a SQLite database.

Parameters

Parameter	Type	Description
filename	string	Database filename (e.g., ':memory:', '/mydb.sqlite3')
options?	SqliteBackendOptions	Backend-specific initialization options

Returns

Promise<void>

---

setUpdateHook()

setUpdateHook(callback): void;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:90

Register or unregister a callback for data change notifications. Called on INSERT, UPDATE, DELETE operations.

Parameters

Parameter	Type	Description
callback	UpdateHookCallback | null	Hook function or null to unregister

Returns

void

---

version()

version(): Promise<string>;

Defined in: packages/rxdb-adapter-sqlite-core/src/sqlite-backend.interface.ts:102

Return the SQLite version string.

Returns

Promise<string>