SqliteClient

Defined in: packages/rxdb-adapter-sqlite/src/SqliteOfficialClient.ts:7

Shared base class for SQLite clients that wrap an oo1.DB-style runtime (@sqlite.org/sqlite-wasm, @sqliteai/sqlite-wasm, ...).

Subclasses only need to implement loadModule and clientName; everything else (queue management, init/disconnect lifecycle, change-event batching, custom function registration, OPFS fallback) lives here.

Extends

• Oo1ClientBase<SqliteLoadOptions>

Constructors

Constructor

new SqliteClient(): SqliteClient;

Returns

SqliteClient

Inherited from

Oo1ClientBase.constructor

Properties

db

protected db: Oo1Database;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:44

Inherited from

Oo1ClientBase.db

---

sqlite3

protected sqlite3: Oo1Static;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:43

Inherited from

Oo1ClientBase.sqlite3

Accessors

clientName

Get Signature

get protected clientName(): string;

Defined in: packages/rxdb-adapter-sqlite/src/SqliteOfficialClient.ts:8

Short identifier used in error messages (e.g. 'sqliteai').

Returns

string

Overrides

Oo1ClientBase.clientName

Methods

addEventListener()

addEventListener(type, handler): void;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:51

Public override that matches the exact SqliteClientLike signature. Delegates to the generic implementation in EventDispatcher.

Parameters

Parameter	Type
type	SQLiteChangeType
handler	(event) => void

Returns

void

Inherited from

Oo1ClientBase.addEventListener

---

disconnect()

disconnect(): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:54

Returns

Promise<void>

Inherited from

Oo1ClientBase.disconnect

---

dispatchEvent()

dispatchEvent<T>(type, data): void;

Defined in: packages/utils/dist/tools/event.d.ts:20

Type Parameters

Type Parameter
T extends keyof Oo1ClientEvents

Parameters

Parameter	Type
type	T
data	Oo1ClientEvents[T]

Returns

void

Inherited from

Oo1ClientBase.dispatchEvent

---

execute()

execute(sql, bindings?): Promise<SqliteSuccessResult>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:55

Parameters

Parameter	Type
sql	string
bindings?	SQLiteCompatibleType[]

Returns

Promise<SqliteSuccessResult>

Inherited from

Oo1ClientBase.execute

---

hasEventListener()

hasEventListener<T>(type, listener): boolean;

Defined in: packages/utils/dist/tools/event.d.ts:18

Type Parameters

Type Parameter
T extends keyof Oo1ClientEvents

Parameters

Parameter	Type
type	T
listener	EventListener<Oo1ClientEvents[T]>

Returns

boolean

Inherited from

Oo1ClientBase.hasEventListener

---

init()

init(dbName, options?): Promise<void>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:52

Parameters

Parameter	Type
dbName	string
options?	SqliteLoadOptions

Returns

Promise<void>

Inherited from

Oo1ClientBase.init

---

loadModule()

protected loadModule(options?): Promise<Oo1Static>;

Defined in: packages/rxdb-adapter-sqlite/src/SqliteOfficialClient.ts:12

Load and initialise the underlying sqlite-wasm module.

Parameters

Parameter	Type
options?	SqliteLoadOptions

Returns

Promise<Oo1Static>

Overrides

Oo1ClientBase.loadModule

---

normalizeRowId()

protected normalizeRowId(rowId): bigint;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:65

Normalise the rowId emitted by sqlite3_update_hook.

@sqlite.org/sqlite-wasm may yield a regular number for small rowIds, so the official client overrides this to coerce to bigint. Subclasses whose runtime always emits bigint can keep the default.

Parameters

Parameter	Type
rowId	number | bigint

Returns

bigint

Inherited from

Oo1ClientBase.normalizeRowId

---

removeAllEventListeners()

removeAllEventListeners(): void;

Defined in: packages/utils/dist/tools/event.d.ts:21

Returns

void

Inherited from

Oo1ClientBase.removeAllEventListeners

---

removeEventListener()

removeEventListener<T>(type, listener): void;

Defined in: packages/utils/dist/tools/event.d.ts:19

Type Parameters

Type Parameter
T extends keyof Oo1ClientEvents

Parameters

Parameter	Type
type	T
listener	EventListener<Oo1ClientEvents[T]>

Returns

void

Inherited from

Oo1ClientBase.removeEventListener

---

version()

version(): Promise<string>;

Defined in: packages/rxdb-adapter-sqlite-core/dist/Oo1ClientBase.d.ts:53

Returns

Promise<string>

Inherited from

Oo1ClientBase.version