SqliteClient
Defined in: packages/rxdb-adapter-wa-sqlite/src/SqliteClient.ts:69
浏览器 wa-sqlite 客户端。
Extends
WaSqliteClientBase<LoadModuleOptions>
Constructors
Constructor
new SqliteClient(): WaSqliteClient;
Defined in: packages/rxdb-adapter-wa-sqlite/src/SqliteClient.ts:70
Returns
WaSqliteClient
Overrides
WaSqliteClientBase<LoadModuleOptions>.constructor
Methods
addEventListener()
addEventListener<T>(type, listener): void;
Defined in: packages/utils/dist/tools/event.d.ts:32
注册监听器。同一 listener 重复注册只保留一份（集合语义）。
Type Parameters
| Type Parameter |
|---|
T extends keyof WaSqliteClientEvents |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<WaSqliteClientEvents[T]> | 监听器 |
Returns
void
Inherited from
WaSqliteClientBase.addEventListener
beginSystemMigrationTransactionSql()
beginSystemMigrationTransactionSql(): string;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:138
获取系统迁移事务所需的最高强度锁语句。
Returns
string
Inherited from
WaSqliteClientBase.beginSystemMigrationTransactionSql
beginTransactionSql()
beginTransactionSql(): string;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:129
获取当前 VFS 所需的事务开始语句。
Returns
string
Inherited from
WaSqliteClientBase.beginTransactionSql
describeBlankDatabase()
describeBlankDatabase(): Promise<SqliteBlankDatabase>;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:152
在同一个模块上开一条临时 :memory: 连接，描述引擎新建空库本来的样子。
Returns
Promise<SqliteBlankDatabase>
空库的对象列表与描述
Throws
Error 客户端未就绪
Inherited from
WaSqliteClientBase.describeBlankDatabase
disconnect()
disconnect(): Promise<void>;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:165
等待现有任务结束并关闭数据库与 VFS。
Returns
Promise<void>
Inherited from
WaSqliteClientBase.disconnect
dispatchEvent()
dispatchEvent<T>(type, data): void;
Defined in: packages/utils/dist/tools/event.d.ts:60
同步派发事件。
遍历的是快照而非实时集合：监听器在处理过程中 addEventListener 不会自喂
本轮迭代（否则单次同步派发可被第三方监听器无限延长，UTL-011）。
Type Parameters
| Type Parameter |
|---|
T extends keyof WaSqliteClientEvents |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
data | WaSqliteClientEvents[T] | 事件数据 |
Returns
void
Throws
监听器抛出的任意异常，原样向上冒泡；其后的监听器不再执行
Inherited from
WaSqliteClientBase.dispatchEvent
execute()
execute(sql, bindings?): Promise<SqliteSuccessResult>;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:179
串行执行 SQL。
Parameters
| Parameter | Type |
|---|---|
sql | string |
bindings? | SQLiteCompatibleType[] |
Returns
Promise<SqliteSuccessResult>
Inherited from
WaSqliteClientBase.execute
hasEventListener()
hasEventListener<T>(type, listener): boolean;
Defined in: packages/utils/dist/tools/event.d.ts:40
查询监听器是否已注册。不会为未知事件名建立集合。
Type Parameters
| Type Parameter |
|---|
T extends keyof WaSqliteClientEvents |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<WaSqliteClientEvents[T]> | 监听器 |
Returns
boolean
是否已注册
Inherited from
WaSqliteClientBase.hasEventListener
init()
init(dbName, options): Promise<void>;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:90
初始化数据库。相同 identity 可重复调用，冲突配置会明确拒绝。
Parameters
| Parameter | Type |
|---|---|
dbName | string |
options | TOptions |
Returns
Promise<void>
Inherited from
WaSqliteClientBase.init
removeAllEventListeners()
removeAllEventListeners(): void;
Defined in: packages/utils/dist/tools/event.d.ts:62
清空所有事件名下的全部监听器。
Returns
void
Inherited from
WaSqliteClientBase.removeAllEventListeners
removeEventListener()
removeEventListener<T>(type, listener): void;
Defined in: packages/utils/dist/tools/event.d.ts:49
移除监听器。未知事件名或未注册的监听器都是无操作，且不会建立空集合。
若在 dispatchEvent 过程中移除，被移除者仍会收到本次事件（快照语义）。
Type Parameters
| Type Parameter |
|---|
T extends keyof WaSqliteClientEvents |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | T | 事件名 |
listener | EventListener<WaSqliteClientEvents[T]> | 监听器 |
Returns
void
Inherited from
WaSqliteClientBase.removeEventListener
setChangeEventsMuted()
setChangeEventsMuted(muted): void;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:124
暂停 / 恢复变更事件采集。
Parameters
| Parameter | Type | Description |
|---|---|---|
muted | boolean | true 时 update hook 直接忽略写入，不入批也不派发 |
Returns
void
Inherited from
WaSqliteClientBase.setChangeEventsMuted
version()
version(): Promise<string>;
Defined in: packages/rxdb-adapter-wa-sqlite/src/WaSqliteClientBase.ts:114
获取 SQLite 版本号。
Returns
Promise<string>
Inherited from
WaSqliteClientBase.version