跳到主要内容

SqliteBackend

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

SQLite WASM 后端实现的抽象接口。

实现:

  • 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:99

返回最近一次 INSERT/UPDATE/DELETE 影响的行数。

Returns​

number


close()​

close(): Promise<void>;

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

关闭数据库连接并释放资源。 close() 之后调用其他方法必须抛错。

Returns​

Promise<void>


createFunction()​

createFunction(name, fn): void;

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

注册自定义标量 SQL 函数。

Parameters​

ParameterTypeDescription
namestringSQL 中可用的函数名(例如 'regexp')
fn(...args) => SQLiteCompatibleType实现函数

Returns​

void


exec()​

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

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

执行 SQL 语句并返回结果。

Parameters​

ParameterTypeDescription
sqlstring要执行的 SQL 语句
bindings?SQLiteCompatibleType[]可选的参数绑定

Returns​

Promise<SqliteExecResult>

包含受影响行数的执行结果


open()​

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

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

初始化并打开 SQLite 数据库。

Parameters​

ParameterTypeDescription
filenamestring数据库文件名(例如 ':memory:'、'/mydb.sqlite3')
options?SqliteBackendOptions与后端相关的初始化选项

Returns​

Promise<void>


setUpdateHook()​

setUpdateHook(callback): void;

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

注册或注销数据变更通知回调。 在 INSERT、UPDATE、DELETE 操作时调用。

Parameters​

ParameterTypeDescription
callbackUpdateHookCallback | null钩子函数,传 null 注销

Returns​

void


version()​

version(): Promise<string>;

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

返回 SQLite 版本字符串。

Returns​

Promise<string>