Skip to main content

abstract AbstractPowerSyncDatabase

Extends

Extended by

Constructors

new AbstractPowerSyncDatabase()

new AbstractPowerSyncDatabase(options): AbstractPowerSyncDatabase

Parameters

ParameterType
optionsPowerSyncDatabaseOptionsWithDBAdapter

Returns

AbstractPowerSyncDatabase

Overrides

BaseObserver.constructor

new AbstractPowerSyncDatabase()

new AbstractPowerSyncDatabase(options): AbstractPowerSyncDatabase

Parameters

ParameterType
optionsPowerSyncDatabaseOptionsWithOpenFactory

Returns

AbstractPowerSyncDatabase

Overrides

BaseObserver<PowerSyncDBListener>.constructor

new AbstractPowerSyncDatabase()

new AbstractPowerSyncDatabase(options): AbstractPowerSyncDatabase

Parameters

ParameterType
optionsPowerSyncDatabaseOptionsWithSettings

Returns

AbstractPowerSyncDatabase

Overrides

BaseObserver<PowerSyncDBListener>.constructor

new AbstractPowerSyncDatabase()

new AbstractPowerSyncDatabase(options): AbstractPowerSyncDatabase

Parameters

ParameterType
optionsPowerSyncDatabaseOptions

Returns

AbstractPowerSyncDatabase

Overrides

BaseObserver<PowerSyncDBListener>.constructor

Properties

PropertyTypeDescription
closedbooleanReturns true if the connection is closed.
currentStatusSyncStatusCurrent connection status.
readyboolean-
sdkVersionstring-
syncStreamImplementation?StreamingSyncImplementation-

Accessors

connected

get connected(): boolean

Whether a connection to the PowerSync service is currently open.

Returns

boolean


database

get database(): DBAdapter

The underlying database.

For the most part, behavior is the same whether querying on the underlying database, or on AbstractPowerSyncDatabase.

Returns

DBAdapter


schema

get schema(): Schema<{}>

Schema used for the local database.

Returns

Schema<{}>

Methods

_initialize()

abstract _initialize(): Promise<void>

Allows for extended implementations to execute custom initialization logic as part of the total init process

Returns

Promise<void>


close()

close(options?): Promise<void>

Close the database, releasing resources.

Also disconnects any active connection.

Once close is called, this connection cannot be used again - a new one must be constructed.

Parameters

ParameterType
options?PowerSyncCloseOptions

Returns

Promise<void>


connect()

connect(connector, options?): Promise<void>

Connects to stream of events from the PowerSync instance.

Parameters

ParameterType
connectorPowerSyncBackendConnector
options?PowerSyncConnectionOptions

Returns

Promise<void>


disconnect()

disconnect(): Promise<void>

Close the sync connection.

Use connect to connect again.

Returns

Promise<void>


disconnectAndClear()

disconnectAndClear(options?): Promise<void>

Disconnect and clear the database. Use this when logging out. The database can still be queried after this is called, but the tables would be empty.

To preserve data in local-only tables, set clearLocal to false.

Parameters

ParameterType
options?DisconnectAndClearOptions

Returns

Promise<void>


execute()

execute(sql, parameters?): Promise<QueryResult>

Execute a write (INSERT/UPDATE/DELETE) query and optionally return results.

Parameters

ParameterType
sqlstring
parameters?any[]

Returns

Promise<QueryResult>


executeBatch()

executeBatch(sql, parameters?): Promise<QueryResult>

Execute a write query (INSERT/UPDATE/DELETE) multiple times with each parameter set and optionally return results. This is faster than executing separately with each parameter set.

Parameters

ParameterType
sqlstring
parameters?any[][]

Returns

Promise<QueryResult>


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

ParameterType
sqlstring
parameters?any[]

Returns

Promise<T>


getAll()

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

Execute a read-only query and return results.

Type parameters

Type parameter
T

Parameters

ParameterType
sqlstring
parameters?any[]

Returns

Promise<T[]>


getCrudBatch()

getCrudBatch(limit): Promise<null | CrudBatch>

Get a batch of crud data to upload.

Returns null if there is no data to upload.

Use this from the PowerSyncBackendConnector.uploadData callback.

Once the data have been successfully uploaded, call CrudBatch.complete before requesting the next batch.

Use limit to specify the maximum number of updates to return in a single batch.

This method does include transaction ids in the result, but does not group data by transaction. One batch may contain data from multiple transactions, and a single transaction may be split over multiple batches.

Parameters

ParameterType
limitnumber

Returns

Promise<null | CrudBatch>


getNextCrudTransaction()

getNextCrudTransaction(): Promise<null | CrudTransaction>

Get the next recorded transaction to upload.

Returns null if there is no data to upload.

Use this from the PowerSyncBackendConnector.uploadData callback.

Once the data have been successfully uploaded, call CrudTransaction.complete before requesting the next transaction.

Unlike getCrudBatch, this only returns data from a single transaction at a time. All data for the transaction is loaded into memory.

Returns

Promise<null | CrudTransaction>


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

ParameterType
sqlstring
parameters?any[]

Returns

Promise<null | T>


getUploadQueueStats()

getUploadQueueStats(includeSize?): Promise<UploadQueueStats>

Get upload queue size estimate and count.

Parameters

ParameterType
includeSize?boolean

Returns

Promise<UploadQueueStats>


init()

init(): Promise<void>

Wait for initialization to complete. While initializing is automatic, this helps to catch and report initialization errors.

Returns

Promise<void>


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


onChange()

onChange(options)

onChange(options?): AsyncIterable<WatchOnChangeEvent>

This version of onChange uses AsyncGenerator, for documentation see onChangeWithAsyncGenerator. Can be overloaded to use a callback handler instead, for documentation see onChangeWithCallback.

Parameters
ParameterType
options?SQLWatchOptions
Returns

AsyncIterable<WatchOnChangeEvent>

Example
async monitorChanges() {
for await (const event of this.powersync.onChange({tables: ['todos']})) {
console.log('Detected change event:', event);
}
}

onChange(handler, options)

onChange(handler?, options?): () => void

See onChangeWithCallback.

Parameters
ParameterType
handler?WatchOnChangeHandler
options?SQLWatchOptions
Returns

Function

Returns

void

Example
monitorChanges() {
this.powersync.onChange({
onChange: (event) => {
console.log('Change detected:', event);
}
}, { tables: ['todos'] });
}

onChangeWithAsyncGenerator()

onChangeWithAsyncGenerator(options?): AsyncIterable<WatchOnChangeEvent>

Create a Stream of changes to any of the specified tables.

This is preferred over watchWithAsyncGenerator when multiple queries need to be performed together when data is changed.

Note, do not declare this as async *onChange as it will not work in React Native

Parameters

ParameterType
options?SQLWatchOptions

Returns

AsyncIterable<WatchOnChangeEvent>


onChangeWithCallback()

onChangeWithCallback(handler?, options?): () => void

Invoke the provided callback on any changes to any of the specified tables.

This is preferred over watchWithCallback when multiple queries need to be performed together when data is changed.

Note that the onChange callback member of the handler is required.

Returns dispose function to stop watching.

Parameters

ParameterType
handler?WatchOnChangeHandler
options?SQLWatchOptions

Returns

Function

Returns

void


readLock()

readLock<T>(callback): Promise<T>

Takes a read lock, without starting a transaction. In most cases, readTransaction should be used instead.

Type parameters

Type parameter
T

Parameters

ParameterType
callback(db) => Promise<T>

Returns

Promise<T>


readTransaction()

readTransaction<T>(callback, lockTimeout?): Promise<T>

Open a read-only transaction. Read transactions can run concurrently to a write transaction. Changes from any write transaction are not visible to read transactions started before it.

Type parameters

Type parameter
T

Parameters

ParameterType
callback(tx) => Promise<T>
lockTimeout?number

Returns

Promise<T>


registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

ParameterType
listenerPartial<PowerSyncDBListener>

Returns

Function

Returns

void

Inherited from

BaseObserver.registerListener


resolveTables()

resolveTables(
sql,
parameters?,
options?): Promise<string[]>

Parameters

ParameterType
sqlstring
parameters?any[]
options?SQLWatchOptions

Returns

Promise<string[]>


updateSchema()

updateSchema(schema): Promise<void>

Replace the schema with a new version. This is for advanced use cases - typically the schema should just be specified once in the constructor.

Cannot be used while connected - this should only be called before AbstractPowerSyncDatabase.connect.

Parameters

ParameterType
schemaSchema<SchemaType>

Returns

Promise<void>


waitForFirstSync()

waitForFirstSync(signal?): Promise<void>

Parameters

ParameterType
signal?AbortSignal

Returns

Promise<void>

A promise which will resolve once the first full sync has completed.


waitForReady()

waitForReady(): Promise<void>

Returns

Promise<void>

A promise which will resolve once initialization is completed.


watch()

watch(sql, parameters, options)

watch(
sql,
parameters?,
options?): AsyncIterable<QueryResult>

This version of watch uses AsyncGenerator, for documentation see watchWithAsyncGenerator. Can be overloaded to use a callback handler instead, for documentation see watchWithCallback.

Parameters
ParameterType
sqlstring
parameters?any[]
options?SQLWatchOptions
Returns

AsyncIterable<QueryResult>

Example
async *attachmentIds() {
for await (const result of this.powersync.watch(
`SELECT photo_id as id FROM todos WHERE photo_id IS NOT NULL`,
[]
)) {
yield result.rows?._array.map((r) => r.id) ?? [];
}
}

watch(sql, parameters, handler, options)

watch(
sql,
parameters?,
handler?,
options?): void

See watchWithCallback.

Parameters
ParameterType
sqlstring
parameters?any[]
handler?WatchHandler
options?SQLWatchOptions
Returns

void

Example
onAttachmentIdsChange(onResult) {
this.powersync.watch(
`SELECT photo_id as id FROM todos WHERE photo_id IS NOT NULL`,
[],
{
onResult: (result) => onResult(result.rows?._array.map((r) => r.id) ?? [])
}
);
}

watchWithAsyncGenerator()

watchWithAsyncGenerator(
sql,
parameters?,
options?): AsyncIterable<QueryResult>

Execute a read query every time the source tables are modified. Use SQLWatchOptions.throttleMs to specify the minimum interval between queries. Source tables are automatically detected using EXPLAIN QUERY PLAN.

Parameters

ParameterType
sqlstring
parameters?any[]
options?SQLWatchOptions

Returns

AsyncIterable<QueryResult>


watchWithCallback()

watchWithCallback(
sql,
parameters?,
handler?,
options?): void

Execute a read query every time the source tables are modified. Use SQLWatchOptions.throttleMs to specify the minimum interval between queries. Source tables are automatically detected using EXPLAIN QUERY PLAN.

Note that the onChange callback member of the handler is required.

Parameters

ParameterType
sqlstring
parameters?any[]
handler?WatchHandler
options?SQLWatchOptions

Returns

void


writeLock()

writeLock<T>(callback): Promise<T>

Takes a global lock, without starting a transaction. In most cases, writeTransaction should be used instead.

Type parameters

Type parameter
T

Parameters

ParameterType
callback(db) => Promise<T>

Returns

Promise<T>


writeTransaction()

writeTransaction<T>(callback, lockTimeout?): Promise<T>

Open a read-write transaction. This takes a global lock - only one write transaction can execute against the database at a time. Statements within the transaction must be done on the provided Transaction interface.

Type parameters

Type parameter
T

Parameters

ParameterType
callback(tx) => Promise<T>
lockTimeout?number

Returns

Promise<T>