WASQLiteDBAdapter

Adapter for WA-SQLite

Extends

• BaseObserver< DBAdapterListener >

Implements

• DBAdapter

Constructors

new WASQLiteDBAdapter(options)

new WASQLiteDBAdapter(options): WASQLiteDBAdapter

Parameters

Parameter	Type
options	WASQLiteDBAdapterOptions

Returns

WASQLiteDBAdapter

Overrides

BaseObserver.constructor

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:39

Properties

Property	Modifier	Type	Inherited from
dbGetHelpers	private	null | DBGetUtils	-
initialized	private	Promise< void >	-
listeners	protected	Set< Partial< DBAdapterListener > >	BaseObserver.listeners
logger	private	ILogger	-
options	protected	WASQLiteDBAdapterOptions	-
workerMethods	private	null | DBWorkerInterface	-

Accessors

flags

get protected flags(): WASQLiteFlags

Returns

WASQLiteFlags

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:52

---

name

get name(): string

Returns

string

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:48

Methods

_execute()

private _execute(sql, bindings?): Promise< QueryResult >

Wraps the worker execute function, awaiting for it to be available

Parameters

Parameter	Type
sql	string
bindings?	any[]

Returns

Promise< QueryResult >

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:88

---

_executeBatch()

private _executeBatch(query, params?): Promise< QueryResult >

Wraps the worker executeBatch function, awaiting for it to be available

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise< QueryResult >

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:103

---

acquireLock()

protected acquireLock(callback): Promise< any >

Parameters

Parameter	Type
callback	() => Promise< any >

Returns

Promise< any >

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:146

---

close()

close(): void

Attempts to close the connection. Shared workers might not actually close the connection if other tabs are still using it.

Returns

void

Implementation of

DBAdapter.close

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:117

---

execute()

execute(query, params?): Promise< QueryResult >

Parameters

Parameter	Type
query	string
params?	any[]

Returns

Promise< QueryResult >

Implementation of

DBAdapter.execute

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:77

---

executeBatch()

executeBatch(query, params?): Promise< QueryResult >

Parameters

Parameter	Type
query	string
params?	any[][]

Returns

Promise< QueryResult >

Implementation of

DBAdapter.executeBatch

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:81

---

generateDBHelpers()

private generateDBHelpers<T>(tx): T & DBGetUtils

Type parameters

Type parameter
T extends object

Parameters

Parameter	Type
tx	T

Returns

T & DBGetUtils

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:197

---

get()

get<T>(sql, parameters?): Promise< T >

Execute a read-only query and return the first result, error if the ResultSet is empty.

Type parameters

Type parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise< T >

Implementation of

DBAdapter.get

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:131

---

getAll()

getAll<T>(sql, parameters?): Promise< T[] >

Execute a read-only query and return results.

Type parameters

Type parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise< T[] >

Implementation of

DBAdapter.getAll

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:121

---

getOptional()

getOptional<T>(sql, parameters?): Promise< null | T >

Execute a read-only query and return the first result, or null if the ResultSet is empty.

Type parameters

Type parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise< null | T >

Implementation of

DBAdapter.getOptional

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:126

---

getWorker()

getWorker(): void

Returns

void

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:56

---

init()

protected init(): Promise< void >

Returns

Promise< void >

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:58

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise< void >

Parameters

Parameter	Type
cb	(listener) => Promise< any >

Returns

Promise< void >

Inherited from

BaseObserver.iterateAsyncListeners

Source

packages/common/lib/utils/BaseObserver.d.ts:18

---

iterateListeners()

iterateListeners(cb): void

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

BaseObserver.iterateListeners

Source

packages/common/lib/utils/BaseObserver.d.ts:17

---

readLock()

readLock<T>(fn, options?): Promise< T >

Type parameters

Type parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise< T >
options?	DBLockOptions

Returns

Promise< T >

Implementation of

DBAdapter.readLock

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:136

---

readTransaction()

readTransaction<T>(fn, options?): Promise< T >

Type parameters

Type parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise< T >
options?	DBLockOptions

Returns

Promise< T >

Implementation of

DBAdapter.readTransaction

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:150

---

registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

Parameter	Type
listener	Partial< DBAdapterListener >

Returns

Function

Returns

void

Implementation of

DBAdapter.registerListener

Inherited from

BaseObserver.registerListener

Source

packages/common/lib/utils/BaseObserver.d.ts:16

---

wrapTransaction()

private wrapTransaction<T>(cb): (tx) => Promise< T >

Wraps a lock context into a transaction context

Type parameters

Type parameter
T

Parameters

Parameter	Type
cb	(tx) => Promise< T >

Returns

Function

Parameters

Parameter	Type
tx	LockContext

Returns

Promise< T >

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:161

---

writeLock()

writeLock<T>(fn, options?): Promise< T >

Type parameters

Type parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise< T >
options?	DBLockOptions

Returns

Promise< T >

Implementation of

DBAdapter.writeLock

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:141

---

writeTransaction()

writeTransaction<T>(fn, options?): Promise< T >

Type parameters

Type parameter
T

Parameters

Parameter	Type
fn	(tx) => Promise< T >
options?	DBLockOptions

Returns

Promise< T >

Implementation of

DBAdapter.writeTransaction

Source

packages/web/src/db/adapters/wa-sqlite/WASQLiteDBAdapter.ts:154