Skip to main content

WASqliteConnection

Internal

WA-SQLite connection which directly interfaces with WA-SQLite. This is usually instantiated inside a worker.

Extends

Implements

Constructors

new WASqliteConnection()

new WASqliteConnection(options): WASqliteConnection

Parameters

ParameterType
optionsResolvedWASQLiteOpenFactoryOptions

Returns

WASqliteConnection

Overrides

BaseObserver.constructor

Methods

close()

close(): Promise<void>

Returns

Promise<void>

Implementation of

AsyncDatabaseConnection.close

execute()

execute(sql, bindings?): Promise<ProxiedQueryResult>

This executes single SQL statements inside a requested lock.

Parameters

ParameterType
sqlstring | TemplateStringsArray
bindings?any[]

Returns

Promise<ProxiedQueryResult>

Implementation of

AsyncDatabaseConnection.execute

executeBatch()

executeBatch(sql, bindings?): Promise<ProxiedQueryResult>

This executes SQL statements in a batch.

Parameters

ParameterType
sqlstring
bindings?any[][]

Returns

Promise<ProxiedQueryResult>

Implementation of

AsyncDatabaseConnection.executeBatch

fireUpdates()

fireUpdates(shouldBroadcast): void

Parameters

ParameterTypeDefault value
shouldBroadcastbooleantrue

Returns

void


getConfig()

getConfig(): Promise<ResolvedWASQLiteOpenFactoryOptions>

Returns

Promise<ResolvedWASQLiteOpenFactoryOptions>

Implementation of

AsyncDatabaseConnection.getConfig

init()

init(): Promise<void>

Returns

Promise<void>

Implementation of

AsyncDatabaseConnection.init

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

ParameterType
cb(listener) => Promise<any>

Returns

Promise<void>

Inherited from

BaseObserver.iterateAsyncListeners


iterateListeners()

iterateListeners(cb): void

Parameters

ParameterType
cb(listener) => any

Returns

void

Inherited from

BaseObserver.iterateListeners


registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

ParameterType
listenerPartial<WASQLiteConnectionListener>

Returns

Function

Returns

void

Inherited from

BaseObserver.registerListener


registerOnTableChange()

registerOnTableChange(callback): Promise<() => void>

Parameters

ParameterType
callbackOnTableChangeCallback

Returns

Promise<() => void>

Implementation of

AsyncDatabaseConnection.registerOnTableChange