@powersync/react-native

Enumerations

Enumeration	Description
ColumnType	-
FetchStrategy	-
LockType	-
OpTypeEnum	-
PowerSyncControlCommand	-
PSInternalTable	-
RowUpdateType	Update table operation numbers from SQLite
SyncClientImplementation	-
SyncStreamConnectionMethod	-
UpdateType	Type of local change.
WatchedQueryListenerEvent	-

Classes

Class	Description
AbortOperation	Calls to Abortcontroller.abort(reason: any) will result in the reason being thrown. This is not necessarily an error, but extends error for better logging purposes.
AbstractPowerSyncDatabase	-
AbstractPowerSyncDatabaseOpenFactory	-
AbstractQueryProcessor	Performs underlying watching and yields a stream of results.
AbstractRemote	-
AbstractStreamingSyncImplementation	-
ArrayComparator	An efficient comparator for WatchedQuery created with Query#watch. This has the ability to determine if a query result has changes without necessarily processing all items in the result.
BaseObserver	-
Column	-
ConnectionManager	-
ControlledExecutor	-
CrudBatch	A batch of client-side changes.
CrudEntry	A single client-side change.
CrudTransaction	A batch of client-side changes.
DataStream	A very basic implementation of a data stream with backpressure support which does not use native JS streams or async iterators. This is handy for environments such as React Native which need polyfills for the above.
DifferentialQueryProcessor	Uses the PowerSync onChange event to trigger watched queries. Results are emitted on every change of the relevant tables.
FetchImplementationProvider	Class wrapper for providing a fetch implementation. The class wrapper is used to distinguish the fetchImplementation option in [AbstractRemoteOptions] from the general fetch method which is typeof "function"
GetAllQuery	Performs a AbstractPowerSyncDatabase.getAll operation for a watched query.
Index	-
IndexedColumn	-
OnChangeQueryProcessor	Uses the PowerSync onChange event to trigger watched queries. Results are emitted on every change of the relevant tables.
OplogEntry	-
OpType	Used internally for sync buckets.
PowerSyncDatabase	A PowerSync database which provides SQLite functionality which is automatically synced.
ReactNativeQuickSqliteOpenFactory	Opens a SQLite connection using React Native Quick SQLite
ReactNativeRemote	-
ReactNativeStreamingSyncImplementation	-
RNQSDBAdapter	Adapter for React Native Quick SQLite
RNQSPowerSyncDatabaseOpenFactory	-
Schema	A schema is a collection of tables. It is used to define the structure of a database.
SqliteBucketStorage	-
SyncDataBatch	-
SyncDataBucket	-
SyncProgress	Provides realtime progress on how PowerSync is downloading rows.
SyncStatus	-
Table	-
TableV2	Generate a new table from the columns and indexes
UploadQueueStats	-

Interfaces

AbstractQueryProcessorOptions<Data, Settings>

Internal

Extended by

• DifferentialQueryProcessorOptions
• OnChangeQueryProcessorOptions

Type Parameters

Type Parameter	Default type
Data	-
Settings extends WatchedQueryOptions	WatchedQueryOptions

Properties

Property	Type
db	AbstractPowerSyncDatabase
placeholderData	Data
watchOptions	Settings

---

AbstractStreamingSyncImplementationOptions

Internal

Extends

• AdditionalConnectionOptions

Properties

Property	Type	Description	Inherited from
adapter	BucketStorageAdapter	-	-
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	AdditionalConnectionOptions.crudUploadThrottleMs
identifier?	string	An identifier for which PowerSync DB this sync implementation is linked to. Most commonly DB name, but not restricted to DB name.	-
logger?	ILogger	-	-
remote	AbstractRemote	-	-
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	AdditionalConnectionOptions.retryDelayMs
uploadCrud	() => Promise<void>	-	-

---

AdditionalConnectionOptions

Internal

Extended by

• BasePowerSyncDatabaseOptions
• AbstractStreamingSyncImplementationOptions
• InternalConnectionOptions

Properties

Property	Type	Description
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.

---

AdditionalOptions

Extends

• HookWatchOptions

Properties

Property	Type	Description	Inherited from
rawTableNames?	boolean	Deprecated All tables specified in tables will be watched, including PowerSync tables with prefixes. Allows for watching any SQL table by not removing PowerSync table name prefixes	HookWatchOptions.rawTableNames
reportFetching?	boolean	-	HookWatchOptions.reportFetching
runQueryOnce?	boolean	-	-
tables?	string[]	-	HookWatchOptions.tables
throttleMs?	number	The minimum interval between queries.	HookWatchOptions.throttleMs
triggerImmediate?	boolean	Emits an empty result set immediately	HookWatchOptions.triggerImmediate

---

ArrayQueryDefinition<RowType>

Options for building a query with AbstractPowerSyncDatabase#query. This query will be executed with AbstractPowerSyncDatabase#getAll.

Type Parameters

Type Parameter	Default type
RowType	unknown

Properties

Property	Type	Description
mapper?	(row: Record<string, unknown>) => RowType	Maps the raw SQLite row to a custom typed object. Example mapper: (row) => ({ ...row, created_at: new Date(row.created_at as string), })
parameters?	readonly Readonly<QueryParam>[]	-
sql	string	-

---

BaseConnectionOptions

Internal

Extended by

• InternalConnectionOptions

Properties

Property	Type	Description
clientImplementation?	SyncClientImplementation	Whether to use a JavaScript implementation to handle received sync lines from the sync service, or whether this work should be offloaded to the PowerSync core extension. This defaults to the JavaScript implementation (SyncClientImplementation.JAVASCRIPT) since the (SyncClientImplementation.RUST) implementation is experimental at the moment.
connectionMethod?	SyncStreamConnectionMethod	The connection method to use when streaming updates from the PowerSync backend instance. Defaults to a HTTP streaming connection.
fetchStrategy?	FetchStrategy	The fetch strategy to use when streaming updates from the PowerSync backend instance.
params?	Record<string, JSONValue>	These parameters are passed to the sync rules, and will be available under theuser_parameters object.
serializedSchema?	any	The serialized schema - mainly used to forward information about raw tables to the sync client.

---

BaseObserverInterface<T>

Extended by

• BucketStorageAdapter
• StreamingSyncImplementation
• DBAdapter

Type Parameters

Type Parameter
T extends BaseListener

Methods

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<T>

Returns

Function

Returns

void

---

BasePowerSyncDatabaseOptions

Internal

Extends

• AdditionalConnectionOptions

Extended by

• PowerSyncDatabaseOptions
• PowerSyncDatabaseOptionsWithDBAdapter
• PowerSyncDatabaseOptionsWithOpenFactory
• PowerSyncDatabaseOptionsWithSettings

Properties

Property	Type	Description	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	AdditionalConnectionOptions.crudUploadThrottleMs
logger?	ILogger	-	-
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	-
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	AdditionalConnectionOptions.retryDelayMs
schema	Schema	Schema used for the local database.	-

---

BatchedUpdateNotification

Properties

Property	Type
groupedUpdates	Record<string, TableUpdateOperation[]>
rawUpdates	UpdateNotification[]
tables	string[]

---

BucketChecksum

Properties

Property	Type	Description
bucket	string	-
checksum	number	32-bit unsigned hash.
count?	number	Count of operations - informational only.
priority?	number	-

---

BucketDescription

Properties

Property	Type
name	string
priority	number

---

BucketRequest

Properties

Property	Type	Description
after	string	Base-10 number. Sync all data from this bucket with op_id > after.
name	string	-

---

BucketState

Properties

Property	Type
bucket	string
op_id	string

---

BucketStorageAdapter

Extends

• BaseObserverInterface<BucketStorageListener>.Disposable

Properties

Property	Type	Inherited from
dispose	() => void | Promise<void>	Disposable.dispose

Methods

control()

control(op, payload): Promise<string>

Invokes the powersync_control function for the sync client.

Parameters

Parameter	Type
op	PowerSyncControlCommand
payload	null | string | Uint8Array<ArrayBufferLike>

Returns

Promise<string>

---

getBucketOperationProgress()

getBucketOperationProgress(): Promise<BucketOperationProgress>

Returns

Promise<BucketOperationProgress>

---

getBucketStates()

getBucketStates(): Promise<BucketState[]>

Returns

Promise<BucketState[]>

---

getClientId()

getClientId(): Promise<string>

Get an unique client id.

Returns

Promise<string>

---

getCrudBatch()

getCrudBatch(limit?): Promise<null | CrudBatch>

Parameters

Parameter	Type
limit?	number

Returns

Promise<null | CrudBatch>

---

getMaxOpId()

getMaxOpId(): string

Returns

string

---

hasCompletedSync()

hasCompletedSync(): Promise<boolean>

Returns

Promise<boolean>

---

hasCrud()

hasCrud(): Promise<boolean>

Returns

Promise<boolean>

---

hasMigratedSubkeys()

hasMigratedSubkeys(): Promise<boolean>

Returns

Promise<boolean>

---

init()

init(): Promise<void>

Returns

Promise<void>

---

migrateToFixedSubkeys()

migrateToFixedSubkeys(): Promise<void>

Returns

Promise<void>

---

nextCrudItem()

nextCrudItem(): Promise<undefined | CrudEntry>

Returns

Promise<undefined | CrudEntry>

---

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<BucketStorageListener>

Returns

Function

Returns

void

Inherited from

BaseObserverInterface.registerListener

---

removeBuckets()

removeBuckets(buckets): Promise<void>

Parameters

Parameter	Type
buckets	string[]

Returns

Promise<void>

---

saveSyncData()

saveSyncData(batch, fixedKeyFormat?): Promise<void>

Parameters

Parameter	Type
batch	SyncDataBatch
fixedKeyFormat?	boolean

Returns

Promise<void>

---

setTargetCheckpoint()

setTargetCheckpoint(checkpoint): Promise<void>

Parameters

Parameter	Type
checkpoint	Checkpoint

Returns

Promise<void>

---

startSession()

startSession(): void

Returns

void

---

syncLocalDatabase()

syncLocalDatabase(checkpoint, priority?): Promise<{
  checkpointValid: boolean;
  failures: any[];
  ready: boolean;
}>

Parameters

Parameter	Type
checkpoint	Checkpoint
priority?	number

Returns

Promise<{ checkpointValid: boolean; failures: any[]; ready: boolean; }>

---

updateLocalTarget()

updateLocalTarget(cb): Promise<boolean>

Parameters

Parameter	Type
cb	() => Promise<string>

Returns

Promise<boolean>

---

BucketStorageListener

Extends

• BaseListener

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type
crudUpdate	() => void

---

Checkpoint

Properties

Property	Type
buckets	BucketChecksum[]
last_op_id	string
write_checkpoint?	string

---

ChecksumCache

Properties

Property	Type
checksums	Map<string, { checksum: BucketChecksum; last_op_id: string; }>
lastOpId	string

---

ColumnOptions

Properties

Property	Type
name	string
type?	ColumnType

---

CompilableQuery<T>

Type Parameters

Type Parameter
T

Methods

compile()

compile(): CompiledQuery

Returns

CompiledQuery

---

execute()

execute(): Promise<T[]>

Returns

Promise<T[]>

---

CompilableQueryWatchHandler<T>

Type Parameters

Type Parameter
T

Properties

Property	Type
onError?	(error: Error) => void
onResult	(results: T[]) => void

---

CompiledQuery

Properties

Property	Modifier	Type
parameters	readonly	readonly unknown[]
sql	readonly	string

---

ConnectionManagerListener

Internal

Extends

• BaseListener

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type
syncStreamCreated	(sync: StreamingSyncImplementation) => void

---

ConnectionManagerOptions

Internal

Properties

Property	Type
logger	ILogger

Methods

createSyncImplementation()

createSyncImplementation(connector, options): Promise<ConnectionManagerSyncImplementationResult>

Parameters

Parameter	Type
connector	PowerSyncBackendConnector
options	InternalConnectionOptions

Returns

Promise<ConnectionManagerSyncImplementationResult>

---

ConnectionManagerSyncImplementationResult

Internal

Properties

Property	Type	Description
onDispose	() => void | Promise<void>	Additional cleanup function which is called after the sync stream implementation is disposed.
sync	StreamingSyncImplementation	-

---

ContinueCheckpointRequest

For sync2.json

Properties

Property	Type	Description
buckets	BucketRequest[]	Existing bucket states. Only these buckets are synchronized.
checkpoint_token	string	-
limit?	number	-

---

ControlledExecutorOptions

Properties

Property	Type	Description
throttleEnabled?	boolean	If throttling is enabled, it ensures only one task runs at a time, and only one additional task can be scheduled to run after the current task completes. The pending task will be overwritten by the latest task. Enabled by default.

---

CreateLoggerOptions

Properties

Property	Type
logLevel?	ILogLevel

---

CrudRequest

For crud.json

Properties

Property	Type
data	CrudEntry[]

---

CrudResponse

Properties

Property	Type	Description
checkpoint?	string	A sync response with a checkpoint >= this checkpoint would contain all the changes in this request. Any earlier checkpoint may or may not contain these changes. May be empty when the request contains no ops.

---

DataStreamListener<Data>

Extends

• BaseListener

Type Parameters

Type Parameter	Default type
Data extends any	any

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type
closed	() => void
data	(data: Data) => Promise<void>
error	(error: Error) => void
highWater	() => Promise<void>
lowWater	() => Promise<void>

---

DBAdapter

Extends

• BaseObserverInterface<DBAdapterListener>.DBGetUtils

Properties

Property	Type	Description
close	() => void | Promise<void>	-
execute	(query: string, params?: any[]) => Promise<QueryResult>	-
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	-
executeRaw	(query: string, params?: any[]) => Promise<any[][]>	-
name	string	-
readLock	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-
readTransaction	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-
refreshSchema	() => Promise<void>	This method refreshes the schema information across all connections. This is for advanced use cases, and should generally not be needed.
writeLock	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-
writeTransaction	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-

Methods

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>

Inherited from

DBGetUtils.get

---

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[]>

Inherited from

DBGetUtils.getAll

---

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>

Inherited from

DBGetUtils.getOptional

---

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<DBAdapterListener>

Returns

Function

Returns

void

Inherited from

BaseObserverInterface.registerListener

---

DBAdapterListener

Extends

• BaseListener

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type	Description
tablesUpdated	(updateNotification: | BatchedUpdateNotification | UpdateNotification) => void	Listener for table updates. Allows for single table updates in order to maintain API compatibility without the need for a major version bump The DB adapter can also batch update notifications if supported.

---

DBGetUtils

Extended by

• LockContext
• DBAdapter

Methods

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>

---

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[]>

---

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>

---

DBLockOptions

Properties

Property	Type
timeoutMs?	number

---

DifferentialQueryProcessorOptions<RowType>

Internal

Extends

• AbstractQueryProcessorOptions<RowType[], DifferentialWatchedQuerySettings<RowType>>

Type Parameters

Type Parameter
RowType

Properties

Property	Type	Inherited from
db	AbstractPowerSyncDatabase	AbstractQueryProcessorOptions.db
placeholderData	RowType[]	AbstractQueryProcessorOptions.placeholderData
rowComparator?	DifferentialWatchedQueryComparator<RowType>	-
watchOptions	DifferentialWatchedQuerySettings	AbstractQueryProcessorOptions.watchOptions

---

DifferentialWatchedQueryComparator<RowType>

Row comparator for differentially watched queries which keys and compares items in the result set.

Type Parameters

Type Parameter
RowType

Properties

Property	Type	Description
compareBy	(item: RowType) => string	Generates a token for comparing items with matching keys.
keyBy	(item: RowType) => string	Generates a unique key for the item.

---

DifferentialWatchedQueryListener<RowType>

Extends

• WatchedQueryListener<ReadonlyArray<Readonly<RowType>>>

Type Parameters

Type Parameter
RowType

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type	Inherited from
closed?	() => void | Promise<void>	WatchedQueryListener.closed
onData?	(data: readonly Readonly<RowType>[]) => void | Promise<void>	WatchedQueryListener.onData
onDiff?	(diff: WatchedQueryDifferential<RowType>) => void | Promise<void>	-
onError?	(error: Error) => void | Promise<void>	WatchedQueryListener.onError
onStateChange?	(state: WatchedQueryState<readonly Readonly<RowType>[]>) => void | Promise<void>	WatchedQueryListener.onStateChange

---

DifferentialWatchedQueryOptions<RowType>

Options for building a differential watched query with the Query builder.

Extends

• WatchedQueryOptions

Extended by

• DifferentialWatchedQuerySettings

Type Parameters

Type Parameter
RowType

Properties

Property	Type	Default value	Description	Inherited from
placeholderData?	RowType[]	undefined	Initial result data which is presented while the initial loading is executing.	-
reportFetching?	boolean	undefined	If true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.	WatchedQueryOptions.reportFetching
rowComparator?	DifferentialWatchedQueryComparator<RowType>	DEFAULT_ROW_COMPARATOR	Row comparator used to identify and compare rows in the result set. If not provided, the default comparator will be used which keys items by their id property if available, otherwise it uses JSON stringification of the entire item for keying and comparison.	-
throttleMs?	number	undefined	The minimum interval between queries.	WatchedQueryOptions.throttleMs
triggerOnTables?	string[]	undefined	By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.	WatchedQueryOptions.triggerOnTables

---

DifferentialWatchedQuerySettings<RowType>

Settings for differential incremental watched queries using.

Extends

• DifferentialWatchedQueryOptions<RowType>

Type Parameters

Type Parameter
RowType

Properties

Property	Type	Default value	Description	Inherited from
placeholderData?	RowType[]	undefined	Initial result data which is presented while the initial loading is executing.	DifferentialWatchedQueryOptions.placeholderData
query	WatchCompatibleQuery<RowType[]>	undefined	The query here must return an array of items that can be differentiated.	-
reportFetching?	boolean	undefined	If true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.	DifferentialWatchedQueryOptions.reportFetching
rowComparator?	DifferentialWatchedQueryComparator<RowType>	DEFAULT_ROW_COMPARATOR	Row comparator used to identify and compare rows in the result set. If not provided, the default comparator will be used which keys items by their id property if available, otherwise it uses JSON stringification of the entire item for keying and comparison.	DifferentialWatchedQueryOptions.rowComparator
throttleMs?	number	undefined	The minimum interval between queries.	DifferentialWatchedQueryOptions.throttleMs
triggerOnTables?	string[]	undefined	By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.	DifferentialWatchedQueryOptions.triggerOnTables

---

DisconnectAndClearOptions

Properties

Property	Type	Description
clearLocal?	boolean	When set to false, data in local-only tables is preserved.

---

Disposable

Extended by

• BucketStorageAdapter
• StreamingSyncImplementation

Properties

Property	Type
dispose	() => void | Promise<void>

---

IndexColumnOptions

Properties

Property	Type
ascending?	boolean
name	string

---

IndexOptions

Properties

Property	Type
columns?	IndexedColumn[]
name	string

---

InternalConnectionOptions

Internal

Extends

• BaseConnectionOptions.AdditionalConnectionOptions

Properties

Property	Type	Description	Inherited from
clientImplementation?	SyncClientImplementation	Whether to use a JavaScript implementation to handle received sync lines from the sync service, or whether this work should be offloaded to the PowerSync core extension. This defaults to the JavaScript implementation (SyncClientImplementation.JAVASCRIPT) since the (SyncClientImplementation.RUST) implementation is experimental at the moment.	BaseConnectionOptions.clientImplementation
connectionMethod?	SyncStreamConnectionMethod	The connection method to use when streaming updates from the PowerSync backend instance. Defaults to a HTTP streaming connection.	BaseConnectionOptions.connectionMethod
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	AdditionalConnectionOptions.crudUploadThrottleMs
fetchStrategy?	FetchStrategy	The fetch strategy to use when streaming updates from the PowerSync backend instance.	BaseConnectionOptions.fetchStrategy
params?	Record<string, JSONValue>	These parameters are passed to the sync rules, and will be available under theuser_parameters object.	BaseConnectionOptions.params
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	AdditionalConnectionOptions.retryDelayMs
serializedSchema?	any	The serialized schema - mainly used to forward information about raw tables to the sync client.	BaseConnectionOptions.serializedSchema

---

LinkQueryOptions<Data, Settings>

Internal

Type Parameters

Type Parameter	Default type
Data	-
Settings extends WatchedQueryOptions	WatchedQueryOptions

Properties

Property	Type
abortSignal	AbortSignal
settings	Settings

---

LockContext

Extends

• DBGetUtils

Extended by

• Transaction

Properties

Property	Type	Description
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.
executeRaw	(query: string, params?: any[]) => Promise<any[][]>	Execute a single write statement and return raw results. Unlike execute, which returns an object with structured key-value pairs, executeRaw returns a nested array of raw values, where each row is represented as an array of column values without field names. Example result: [ [ '1', 'list 1', '33', 'Post content', '1' ] ] Where as execute's rows._array would have been: [ { id: '33', name: 'list 1', content: 'Post content', list_id: '1' } ]

Methods

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>

Inherited from

DBGetUtils.get

---

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[]>

Inherited from

DBGetUtils.getAll

---

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>

Inherited from

DBGetUtils.getOptional

---

LockOptions<T>

Abstract Lock to be implemented by various JS environments

Type Parameters

Type Parameter
T

Properties

Property	Type
callback	() => Promise<T>
signal?	AbortSignal
type	LockType

---

OnChangeQueryProcessorOptions<Data>

Internal

Extends

• AbstractQueryProcessorOptions<Data, WatchedQuerySettings<Data>>

Type Parameters

Type Parameter
Data

Properties

Property	Type	Inherited from
comparator?	WatchedQueryComparator<Data>	-
db	AbstractPowerSyncDatabase	AbstractQueryProcessorOptions.db
placeholderData	Data	AbstractQueryProcessorOptions.placeholderData
watchOptions	WatchedQuerySettings	AbstractQueryProcessorOptions.watchOptions

---

OplogEntryJSON

Properties

Property	Type
checksum	number
data?	string
object_id?	string
object_type?	string
op	string
op_id	string
subkey?	string

---

ParsedQuery

Properties

Property	Type
parameters	any[]
sqlStatement	string

---

PowerSyncBackendConnector

Properties

Property	Type	Description
fetchCredentials	() => Promise<null | PowerSyncCredentials>	Allows the PowerSync client to retrieve an authentication token from your backend which is used to authenticate against the PowerSync service. This should always fetch a fresh set of credentials - don't use cached values. Return null if the user is not signed in. Throw an error if credentials cannot be fetched due to a network error or other temporary error. This token is kept for the duration of a sync connection.
uploadData	(database: AbstractPowerSyncDatabase) => Promise<void>	Upload local changes to the app backend. Use AbstractPowerSyncDatabase.getCrudBatch to get a batch of changes to upload. Any thrown errors will result in a retry after the configured wait period (default: 5 seconds).

---

PowerSyncCloseOptions

Properties

Property	Type	Description
disconnect?	boolean	Disconnect the sync stream client if connected. This is usually true, but can be false for Web when using multiple tabs and a shared sync provider.

---

PowerSyncCredentials

Properties

Property	Type
endpoint	string
expiresAt?	Date
token	string

---

PowerSyncDatabaseOptions

Internal

Extends

• BasePowerSyncDatabaseOptions

Properties

Property	Type	Description	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	BasePowerSyncDatabaseOptions.crudUploadThrottleMs
database	| DBAdapter | SQLOpenFactory | SQLOpenOptions	Source for a SQLite database connection. This can be either: - A DBAdapter if providing an instantiated SQLite connection - A SQLOpenFactory which will be used to open a SQLite connection - SQLOpenOptions for opening a SQLite connection with a default SQLOpenFactory	-
logger?	ILogger	-	BasePowerSyncDatabaseOptions.logger
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	BasePowerSyncDatabaseOptions.retryDelay
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	BasePowerSyncDatabaseOptions.retryDelayMs
schema	Schema	Schema used for the local database.	BasePowerSyncDatabaseOptions.schema

---

PowerSyncDatabaseOptionsWithDBAdapter

Internal

Extends

• BasePowerSyncDatabaseOptions

Properties

Property	Type	Description	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	BasePowerSyncDatabaseOptions.crudUploadThrottleMs
database	DBAdapter	-	-
logger?	ILogger	-	BasePowerSyncDatabaseOptions.logger
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	BasePowerSyncDatabaseOptions.retryDelay
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	BasePowerSyncDatabaseOptions.retryDelayMs
schema	Schema	Schema used for the local database.	BasePowerSyncDatabaseOptions.schema

---

PowerSyncDatabaseOptionsWithOpenFactory

Internal

Extends

• BasePowerSyncDatabaseOptions

Properties

Property	Type	Description	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	BasePowerSyncDatabaseOptions.crudUploadThrottleMs
database	SQLOpenFactory	-	-
logger?	ILogger	-	BasePowerSyncDatabaseOptions.logger
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	BasePowerSyncDatabaseOptions.retryDelay
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	BasePowerSyncDatabaseOptions.retryDelayMs
schema	Schema	Schema used for the local database.	BasePowerSyncDatabaseOptions.schema

---

PowerSyncDatabaseOptionsWithSettings

Internal

Extends

• BasePowerSyncDatabaseOptions

Properties

Property	Type	Description	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	BasePowerSyncDatabaseOptions.crudUploadThrottleMs
database	SQLOpenOptions	-	-
logger?	ILogger	-	BasePowerSyncDatabaseOptions.logger
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	BasePowerSyncDatabaseOptions.retryDelay
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	BasePowerSyncDatabaseOptions.retryDelayMs
schema	Schema	Schema used for the local database.	BasePowerSyncDatabaseOptions.schema

---

PowerSyncDBListener

Extends

• StreamingSyncImplementationListener

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type	Description	Inherited from
closed	() => void | Promise<void>	-	-
closing	() => void | Promise<void>	-	-
initialized	() => void	-	-
schemaChanged	(schema: Schema) => void	-	-
statusChanged?	(status: SyncStatus) => void	Triggers whenever the status' members have changed in value	StreamingSyncImplementationListener.statusChanged
statusUpdated?	(statusUpdate: SyncStatusOptions) => void	Triggered whenever a status update has been attempted to be made or refreshed.	StreamingSyncImplementationListener.statusUpdated

---

PowerSyncOpenFactoryOptions

Extends

• Partial<PowerSyncDatabaseOptions>.SQLOpenOptions

Properties

Property	Type	Description	Overrides	Inherited from
crudUploadThrottleMs?	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	-	Partial.crudUploadThrottleMs
database?	| DBAdapter | SQLOpenFactory | SQLOpenOptions	Source for a SQLite database connection. This can be either: - A DBAdapter if providing an instantiated SQLite connection - A SQLOpenFactory which will be used to open a SQLite connection - SQLOpenOptions for opening a SQLite connection with a default SQLOpenFactory	-	Partial.database
dbFilename	string	Filename for the database.	-	SQLOpenOptions.dbFilename
dbLocation?	string	Directory where the database file is located. When set, the directory must exist when the database is opened, it will not be created automatically.	-	SQLOpenOptions.dbLocation
debugMode?	boolean	Enable debugMode to log queries to the performance timeline. Defaults to false. To enable in development builds, use: debugMode: process.env.NODE_ENV !== 'production'	-	SQLOpenOptions.debugMode
logger?	ILogger	-	-	Partial.logger
retryDelay?	number	Deprecated Use retryDelayMs instead as this will be removed in future releases.	-	Partial.retryDelay
retryDelayMs?	number	Delay for retrying sync streaming operations from the PowerSync backend after an error occurs.	-	Partial.retryDelayMs
schema	Schema	Schema used for the local database.	Partial.schema	-

---

ProgressWithOperations

Information about a progressing download made by the PowerSync SDK.

To obtain these values, use SyncProgress, available through SyncStatus#downloadProgress.

Properties

Property	Type	Description
downloadedFraction	number	Relative progress, as downloadedOperations of totalOperations. This will be a number between 0.0 and 1.0 (inclusive). When this number reaches 1.0, all changes have been received from the sync service. Actually applying these changes happens before the downloadProgress field is cleared from SyncStatus, so progress can stay at 1.0 for a short while before completing.
downloadedOperations	number	The amount of operations that have already been downloaded.
totalOperations	number	The total amount of operations to download for the current sync iteration to complete.

---

Query<RowType>

Type Parameters

Type Parameter
RowType

Methods

differentialWatch()

differentialWatch(options?): DifferentialWatchedQuery<RowType>

Creates a WatchedQuery which watches and emits results of the linked query.

This query method watches for changes in the underlying SQLite tables and runs the query on each table change. The difference between the current and previous result set is computed. The watched query will not emit changes if the result set is identical to the previous result set.

If the result set is different, the watched query will emit the new result set and emit a detailed diff of the changes via the onData and onDiff listeners.

The deep differentiation allows maintaining result set object references between result emissions. The DifferentialWatchedQuery#state data array will contain the previous row references for unchanged rows.

Parameters

Parameter	Type
options?	DifferentialWatchedQueryOptions<RowType>

Returns

DifferentialWatchedQuery<RowType>

Example

const watchedLists = powerSync.query({sql: 'SELECT * FROM lists'})
 .differentialWatch();

const disposeListener = watchedLists.registerListener({
 onData: (lists) => {
   console.log('The latest result set for the query is', lists);
 },
 onDiff: (diff) => {
   console.log('The lists result set has changed since the last emission', diff.added, diff.removed, diff.updated, diff.all)
 }
})

---

watch()

watch(options?): StandardWatchedQuery<readonly Readonly<RowType>[]>

Creates a WatchedQuery which watches and emits results of the linked query.

By default the returned watched query will emit changes whenever a change to the underlying SQLite tables is made. These changes might not be relevant to the query, but the query will emit a new result set.

A StandardWatchedQueryOptions#comparator can be provided to limit the data emissions. The watched query will still query the underlying DB on underlying table changes, but the result will only be emitted if the comparator detects a change in the results.

The comparator in this method is optimized and returns early as soon as it detects a change. Each data emission will correlate to a change in the result set, but note that the result set will not maintain internal object references to the previous result set. If internal object references are needed, consider using Query#differentialWatch instead.

Parameters

Parameter	Type
options?	StandardWatchedQueryOptions<RowType>

Returns

StandardWatchedQuery<readonly Readonly<RowType>[]>

---

SQLOnChangeOptions

Extended by

• SQLWatchOptions

Properties

Property	Type	Description
rawTableNames?	boolean	Deprecated All tables specified in tables will be watched, including PowerSync tables with prefixes. Allows for watching any SQL table by not removing PowerSync table name prefixes
signal?	AbortSignal	-
tables?	string[]	-
throttleMs?	number	The minimum interval between queries.
triggerImmediate?	boolean	Emits an empty result set immediately

---

SQLOpenFactory

Methods

openDB()

openDB(): DBAdapter

Opens a connection adapter to a SQLite DB

Returns

DBAdapter

---

SQLOpenOptions

Extended by

• PowerSyncOpenFactoryOptions

Properties

Property	Type	Description
dbFilename	string	Filename for the database.
dbLocation?	string	Directory where the database file is located. When set, the directory must exist when the database is opened, it will not be created automatically.
debugMode?	boolean	Enable debugMode to log queries to the performance timeline. Defaults to false. To enable in development builds, use: debugMode: process.env.NODE_ENV !== 'production'

---

SQLWatchOptions

Extends

• SQLOnChangeOptions

Properties

Property	Type	Description	Inherited from
comparator?	WatchedQueryComparator<QueryResult>	Optional comparator which will be used to compare the results of the query. The watched query will only yield results if the comparator returns false.	-
rawTableNames?	boolean	Deprecated All tables specified in tables will be watched, including PowerSync tables with prefixes. Allows for watching any SQL table by not removing PowerSync table name prefixes	SQLOnChangeOptions.rawTableNames
signal?	AbortSignal	-	SQLOnChangeOptions.signal
tables?	string[]	-	SQLOnChangeOptions.tables
throttleMs?	number	The minimum interval between queries.	SQLOnChangeOptions.throttleMs
triggerImmediate?	boolean	Emits an empty result set immediately	SQLOnChangeOptions.triggerImmediate

---

StandardWatchedQueryOptions<RowType>

Options for Query#watch.

Extends

• WatchedQueryOptions

Type Parameters

Type Parameter
RowType

Properties

Property	Type	Description	Inherited from
comparator?	WatchedQueryComparator<RowType[]>	The underlying watched query implementation (re)evaluates the query on any SQLite table change. Providing this optional comparator can be used to filter duplicate result set emissions when the result set is unchanged. The comparator compares the previous and current result set. For an efficient comparator see ArrayComparator. Example comparator: new ArrayComparator({ compareBy: (item) => JSON.stringify(item) })	-
placeholderData?	RowType[]	The initial data state reported while the query is loading for the first time. Default []	-
reportFetching?	boolean	If true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.	WatchedQueryOptions.reportFetching
throttleMs?	number	The minimum interval between queries.	WatchedQueryOptions.throttleMs
triggerOnTables?	string[]	By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.	WatchedQueryOptions.triggerOnTables

---

StreamingSyncCheckpoint

Properties

Property	Type
checkpoint	Checkpoint

---

StreamingSyncCheckpointComplete

Properties

Property	Type
checkpoint_complete	{ last_op_id: string; }
checkpoint_complete.last_op_id	string

---

StreamingSyncCheckpointDiff

Properties

Property	Type
checkpoint_diff	{ last_op_id: string; removed_buckets: string[]; updated_buckets: BucketChecksum[]; write_checkpoint: string; }
checkpoint_diff.last_op_id	string
checkpoint_diff.removed_buckets	string[]
checkpoint_diff.updated_buckets	BucketChecksum[]
checkpoint_diff.write_checkpoint?	string

---

StreamingSyncCheckpointPartiallyComplete

Properties

Property	Type
partial_checkpoint_complete	{ last_op_id: string; priority: number; }
partial_checkpoint_complete.last_op_id	string
partial_checkpoint_complete.priority	number

---

StreamingSyncDataJSON

Properties

Property	Type
data	SyncDataBucketJSON

---

StreamingSyncImplementation

Extends

• BaseObserverInterface<StreamingSyncImplementationListener>.Disposable

Properties

Property	Type	Inherited from
dispose	() => void | Promise<void>	Disposable.dispose
getWriteCheckpoint	() => Promise<string>	-
hasCompletedSync	() => Promise<boolean>	-
isConnected	boolean	-
lastSyncedAt?	Date	-
syncStatus	SyncStatus	-
triggerCrudUpload	() => void	-

Methods

connect()

connect(options?): Promise<void>

Connects to the sync service

Parameters

Parameter	Type
options?	InternalConnectionOptions

Returns

Promise<void>

---

disconnect()

disconnect(): Promise<void>

Disconnects from the sync services.

Returns

Promise<void>

Throws

if not connected or if abort is not controlled internally

---

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<StreamingSyncImplementationListener>

Returns

Function

Returns

void

Inherited from

BaseObserverInterface.registerListener

---

waitForReady()

waitForReady(): Promise<void>

Returns

Promise<void>

---

waitForStatus()

waitForStatus(status): Promise<void>

Parameters

Parameter	Type
status	SyncStatusOptions

Returns

Promise<void>

---

waitUntilStatusMatches()

waitUntilStatusMatches(predicate): Promise<void>

Parameters

Parameter	Type
predicate	(status) => boolean

Returns

Promise<void>

---

StreamingSyncImplementationListener

Extends

• BaseListener

Extended by

• PowerSyncDBListener

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type	Description
statusChanged?	(status: SyncStatus) => void	Triggers whenever the status' members have changed in value
statusUpdated?	(statusUpdate: SyncStatusOptions) => void	Triggered whenever a status update has been attempted to be made or refreshed.

---

StreamingSyncKeepalive

Properties

Property	Type	Description
token_expires_in	number	If specified, token expires in this many seconds.

---

StreamingSyncRequest

Properties

Property	Type	Description
buckets?	BucketRequest[]	Existing bucket states.
client_id?	string	-
include_checksum	boolean	Whether or not to compute a checksum for each checkpoint
only?	string[]	If specified, limit the response to only include these buckets.
parameters?	Record<string, JSONValue>	Client parameters to be passed to the sync rules.
raw_data	boolean	Changes the response to stringified data in each OplogEntry

---

SyncLocalDatabaseResult

Properties

Property	Type
checkpointFailures?	string[]
checkpointValid	boolean
ready	boolean

---

SyncNewCheckpointRequest

Properties

Property	Type	Description
buckets?	BucketRequest[]	Existing bucket states. Used if include_data is specified.
limit?	number	-
request_checkpoint	{ include_checksum: boolean; include_data: boolean; }	-
request_checkpoint.include_checksum	boolean	Whether or not to compute a checksum.
request_checkpoint.include_data	boolean	Whether or not to include an initial data request.

---

SyncPriorityStatus

Properties

Property	Type
hasSynced?	boolean
lastSyncedAt?	Date
priority	number

---

SyncResponse

Properties

Property	Type	Description
checkpoint?	Checkpoint	-
checkpoint_token?	string	-
data?	SyncDataBucketJSON[]	Data for the buckets returned. May not have an an entry for each bucket in the request.
has_more	boolean	True if the response limit has been reached, and another request must be made.

---

TableOptions

Extends

• SharedTableOptions

Properties

Property	Type	Description	Inherited from
columns	Column[]	-	-
ignoreEmptyUpdates?	boolean	-	SharedTableOptions.ignoreEmptyUpdates
indexes?	Index[]	-	-
insertOnly?	boolean	-	SharedTableOptions.insertOnly
localOnly?	boolean	-	SharedTableOptions.localOnly
name	string	The synced table name, matching sync rules	-
trackMetadata?	boolean	-	SharedTableOptions.trackMetadata
trackPrevious?	boolean | TrackPreviousOptions	-	SharedTableOptions.trackPrevious
viewName?	string	-	SharedTableOptions.viewName

---

TableUpdateOperation

Extended by

• UpdateNotification

Properties

Property	Type
opType	RowUpdateType
rowId	number

---

TableV2Options

Extends

• SharedTableOptions

Properties

Property	Type	Inherited from
ignoreEmptyUpdates?	boolean	SharedTableOptions.ignoreEmptyUpdates
indexes?	IndexShorthand	-
insertOnly?	boolean	SharedTableOptions.insertOnly
localOnly?	boolean	SharedTableOptions.localOnly
trackMetadata?	boolean	SharedTableOptions.trackMetadata
trackPrevious?	boolean | TrackPreviousOptions	SharedTableOptions.trackPrevious
viewName?	string	SharedTableOptions.viewName

---

TrackPreviousOptions

Whether to include previous column values when PowerSync tracks local changes.

Including old values may be helpful for some backend connector implementations, which is why it can be enabled on per-table or per-columm basis.

Properties

Property	Type	Description
columns?	string[]	When defined, a list of column names for which old values should be tracked.
onlyWhenChanged?	boolean	When enabled, only include values that have actually been changed by an update.

---

Transaction

Extends

• LockContext

Properties

Property	Type	Description	Inherited from
commit	() => Promise<QueryResult>	Commit multiple changes to the local DB using the Transaction context.	-
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.	LockContext.execute
executeRaw	(query: string, params?: any[]) => Promise<any[][]>	Execute a single write statement and return raw results. Unlike execute, which returns an object with structured key-value pairs, executeRaw returns a nested array of raw values, where each row is represented as an array of column values without field names. Example result: [ [ '1', 'list 1', '33', 'Post content', '1' ] ] Where as execute's rows._array would have been: [ { id: '33', name: 'list 1', content: 'Post content', list_id: '1' } ]	LockContext.executeRaw
rollback	() => Promise<QueryResult>	Roll back multiple attempted changes using the Transaction context.	-

Methods

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>

Inherited from

LockContext.get

---

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[]>

Inherited from

LockContext.getAll

---

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>

Inherited from

LockContext.getOptional

---

UpdateNotification

Notification of an update to one or more tables, for the purpose of realtime change notifications.

Extends

• TableUpdateOperation

Properties

Property	Type	Inherited from
opType	RowUpdateType	TableUpdateOperation.opType
rowId	number	TableUpdateOperation.rowId
table	string	-

---

WatchCompatibleQuery<ResultType>

Similar to CompatibleQuery, except the execute method does not enforce an Array result type.

Type Parameters

Type Parameter
ResultType

Methods

compile()

compile(): CompiledQuery

Returns

CompiledQuery

---

execute()

execute(options): Promise<ResultType>

Parameters

Parameter	Type
options	WatchExecuteOptions

Returns

Promise<ResultType>

---

WatchedQuery<Data, Settings, Listener>

Extends

• MetaBaseObserverInterface<Listener>

Type Parameters

Type Parameter	Default type
Data	unknown
Settings extends WatchedQueryOptions	WatchedQueryOptions
Listener extends WatchedQueryListener<Data>	WatchedQueryListener<Data>

Properties

Property	Modifier	Type	Description	Inherited from
closed	readonly	boolean	-	-
listenerMeta	public	ListenerMetaManager<Listener>	-	MetaBaseObserverInterface.listenerMeta
state	readonly	WatchedQueryState<Data>	Current state of the watched query.	-

Methods

close()

close(): Promise<void>

Close the watched query and end all subscriptions.

Returns

Promise<void>

---

registerListener()

registerListener(listener): () => void

Subscribe to watched query events.

Parameters

Parameter	Type
listener	Listener

Returns

Function

A function to unsubscribe from the events.

Returns

void

Overrides

MetaBaseObserverInterface.registerListener

---

updateSettings()

updateSettings(options): Promise<void>

Updates the underlying query options. This will trigger a re-evaluation of the query and update the state.

Parameters

Parameter	Type
options	Settings

Returns

Promise<void>

---

WatchedQueryComparator<Data>

A basic comparator for incrementally watched queries. This performs a single comparison which determines if the result set has changed. The WatchedQuery will only emit the new result if a change has been detected.

Type Parameters

Type Parameter
Data

Properties

Property	Type
checkEquality	(current: Data, previous: Data) => boolean

---

WatchedQueryDifferential<RowType>

Represents the result of a watched query that has been diffed. DifferentialWatchedQueryState#diff is of the WatchedQueryDifferential form.

Type Parameters

Type Parameter
RowType

Properties

Property	Modifier	Type	Description
added	readonly	readonly Readonly<RowType>[]	-
all	readonly	readonly Readonly<RowType>[]	The entire current result set. Array item object references are preserved between updates if the item is unchanged. e.g. In the query SELECT name, make FROM assets ORDER BY make ASC; If a previous result set contains an item (A) {name: 'pc', make: 'Cool PC'} and an update has been made which adds another item (B) to the result set (the item A is unchanged) - then the updated result set will be contain the same object reference, to item A, as the previous result set. This is regardless of the item A's position in the updated result set.
removed	readonly	readonly Readonly<RowType>[]	-
unchanged	readonly	readonly Readonly<RowType>[]	-
updated	readonly	readonly WatchedQueryRowDifferential<Readonly<RowType>>[]	-

---

WatchedQueryListener<Data>

Extends

• BaseListener

Extended by

• DifferentialWatchedQueryListener

Type Parameters

Type Parameter
Data

Indexable

[key: string]: undefined | (...event) => any

Properties

Property	Type
closed?	() => void | Promise<void>
onData?	(data: Data) => void | Promise<void>
onError?	(error: Error) => void | Promise<void>
onStateChange?	(state: WatchedQueryState<Data>) => void | Promise<void>

---

WatchedQueryOptions

Extended by

• StandardWatchedQueryOptions
• DifferentialWatchedQueryOptions
• WatchedQuerySettings

Properties

Property	Type	Description
reportFetching?	boolean	If true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.
throttleMs?	number	The minimum interval between queries.
triggerOnTables?	string[]	By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.

---

WatchedQueryRowDifferential<RowType>

Represents an updated row in a differential watched query. It contains both the current and previous state of the row.

Type Parameters

Type Parameter
RowType

Properties

Property	Modifier	Type
current	readonly	RowType
previous	readonly	RowType

---

WatchedQuerySettings<DataType>

Settings for WatchedQuery instances created via Query#watch.

Extends

• WatchedQueryOptions

Type Parameters

Type Parameter
DataType

Properties

Property	Type	Description	Inherited from
query	WatchCompatibleQuery<DataType>	-	-
reportFetching?	boolean	If true (default) the watched query will update its state to report on the fetching state of the query. Setting to false reduces the number of state changes if the fetch status is not relevant to the consumer.	WatchedQueryOptions.reportFetching
throttleMs?	number	The minimum interval between queries.	WatchedQueryOptions.throttleMs
triggerOnTables?	string[]	By default, watched queries requery the database on any change to any dependent table of the query. Supplying an override here can be used to limit the tables which trigger querying the database.	WatchedQueryOptions.triggerOnTables

---

WatchedQueryState<Data>

State for WatchedQuery instances.

Type Parameters

Type Parameter
Data

Properties

Property	Modifier	Type	Description
data	readonly	Data	The last data returned by the query.
error	readonly	null | Error	The last error that occurred while executing the query.
isFetching	readonly	boolean	Indicates whether the query is currently fetching data, is true during the initial load and any time when the query is re-evaluating (useful for large queries).
isLoading	readonly	boolean	Indicates the initial loading state (hard loading). Loading becomes false once the first set of results from the watched query is available or an error occurs.
lastUpdated	readonly	null | Date	The last time the query was updated.

---

WatchExecuteOptions

Options provided to the execute method of a WatchCompatibleQuery.

Properties

Property	Type
db	AbstractPowerSyncDatabase
parameters	any[]
sql	string

---

WatchHandler

Properties

Property	Type
onError?	(error: Error) => void
onResult	(results: QueryResult) => void

---

WatchOnChangeEvent

Properties

Property	Type
changedTables	string[]

---

WatchOnChangeHandler

Properties

Property	Type
onChange	(event: WatchOnChangeEvent) => void | Promise<void>
onError?	(error: Error) => void

Type Aliases

AbstractRemoteOptions

type AbstractRemoteOptions = {
  fetchImplementation:   | FetchImplementation
     | FetchImplementationProvider;
  fetchOptions: {};
  socketUrlTransformer: (url) => string;
};

Type declaration

Name	Type	Description
fetchImplementation	| FetchImplementation | FetchImplementationProvider	Optionally provide the fetch implementation to use. Note that this usually needs to be bound to the global scope. Binding should be done before passing here.
fetchOptions?	{}	Optional options to pass directly to all fetch calls. This can include fields such as dispatcher (e.g. for proxy support), cache, or any other fetch-compatible options.
socketUrlTransformer	(url) => string	Transforms the PowerSync base URL which might contain http(s):// to the corresponding WebSocket variant e.g. ws(s)://

---

ArrayComparatorOptions<ItemType>

type ArrayComparatorOptions<ItemType> = {
  compareBy: (item) => string;
};

Options for ArrayComparator

Type Parameters

Type Parameter
ItemType

Type declaration

Name	Type	Description
compareBy	(item) => string	Returns a string to uniquely identify an item in the array.

---

BaseColumnType<T>

type BaseColumnType<T> = {
  type: ColumnType;
};

Type Parameters

Type Parameter
T extends number | string | null

Type declaration

Name	Type
type	ColumnType

---

BaseListener

type BaseListener = Record<string, (...event) => any | undefined>;

---

BSONImplementation

type BSONImplementation = typeof BSON;

---

BucketOperationProgress

type BucketOperationProgress = Record<string, SavedProgress>;

---

ColumnsType

type ColumnsType = Record<string, BaseColumnType<any>>;

---

CrudUploadNotification

type CrudUploadNotification = {
  crud_upload_completed: null;
};

Type declaration

Name	Type
crud_upload_completed	null

---

DataStreamCallback()<Data>

type DataStreamCallback<Data> = (data) => Promise<void>;

Type Parameters

Type Parameter	Default type
Data extends any	any

Parameters

Parameter	Type
data	Data

Returns

Promise<void>

---

DataStreamOptions<ParsedData, SourceData>

type DataStreamOptions<ParsedData, SourceData> = {
  closeOnError: boolean;
  logger: ILogger;
  mapLine: (line) => ParsedData;
  pressure: {
     highWaterMark: number;
     lowWaterMark: number;
    };
};

Type Parameters

Type Parameter
ParsedData
SourceData

Type declaration

Name	Type	Description
closeOnError?	boolean	Close the stream if any consumer throws an error
logger?	ILogger	-
mapLine?	(line) => ParsedData	-
pressure?	{ highWaterMark: number; lowWaterMark: number; }	-
pressure.highWaterMark?	number	-
pressure.lowWaterMark?	number	-

---

DifferentialWatchedQuery<RowType>

type DifferentialWatchedQuery<RowType> = WatchedQuery<ReadonlyArray<Readonly<RowType>>, DifferentialWatchedQuerySettings<RowType>, DifferentialWatchedQueryListener<RowType>>;

Type Parameters

Type Parameter
RowType

---

ExtractColumnValueType<T>

type ExtractColumnValueType<T> = T extends BaseColumnType<infer R> ? R : unknown;

Type Parameters

Type Parameter
T extends BaseColumnType<any>

---

FetchImplementation

type FetchImplementation = typeof fetch;

---

GetAllQueryOptions<RowType>

type GetAllQueryOptions<RowType> = {
  mapper: (rawRow) => RowType;
  parameters: ReadonlyArray<unknown>;
  sql: string;
};

Options for GetAllQuery.

Type Parameters

Type Parameter	Default type
RowType	unknown

Type declaration

Name	Type	Description
mapper?	(rawRow) => RowType	Optional mapper function to convert raw rows into the desired RowType. Example (rawRow) => ({ id: rawRow.id, created_at: new Date(rawRow.created_at), })
parameters?	ReadonlyArray<unknown>	-
sql	string	-

---

IndexShorthand

type IndexShorthand = Record<string, string[]>;

---

MutableWatchedQueryState<Data>

type MutableWatchedQueryState<Data> = { -readonly [P in keyof WatchedQueryState<Data>]: MutableDeep<WatchedQueryState<Data>[P]> };

Internal

Mutable version of WatchedQueryState. This is used internally to allow updates to the state.

Type Parameters

Type Parameter
Data

---

OpId

type OpId = string;

64-bit unsigned integer stored as a string in base-10.

Not sortable as a string.

---

OpTypeJSON

type OpTypeJSON = string;

---

PowerSyncConnectionOptions

type PowerSyncConnectionOptions = Omit<InternalConnectionOptions, "serializedSchema">;

Configurable options to be used when connecting to the PowerSync backend instance.

---

QueryParam

type QueryParam = string | number | boolean | null | undefined | bigint | Uint8Array;

Query parameters for ArrayQueryDefinition#parameters

---

QueryResult

type QueryResult = {
  insertId: number;
  rows: {
     _array: any[];
     item: (idx) => any;
     length: number;
    };
  rowsAffected: number;
};

Object returned by SQL Query executions.

Type declaration

Name	Type	Description
insertId?	number	Represents the auto-generated row id if applicable.
rows?	{ _array: any[]; item: (idx) => any; length: number; }	if status is undefined or 0 this object will contain the query results
rows._array	any[]	Raw array with all dataset
rows.item	(idx) => any	A convenience function to acess the index based the row object
rows.length	number	The length of the dataset
rowsAffected	number	Number of affected rows if result of a update query.

---

RemoteConnector

type RemoteConnector = {
  fetchCredentials: () => Promise<PowerSyncCredentials | null>;
  invalidateCredentials: () => void;
};

Type declaration

Name	Type
fetchCredentials	() => Promise<PowerSyncCredentials | null>
invalidateCredentials?	() => void

---

RequiredAdditionalConnectionOptions

type RequiredAdditionalConnectionOptions = Required<AdditionalConnectionOptions>;

Internal

---

RequiredPowerSyncConnectionOptions

type RequiredPowerSyncConnectionOptions = Required<BaseConnectionOptions>;

---

RowType<T>

type RowType<T> = { [K in keyof T["columnMap"]]: ExtractColumnValueType<T["columnMap"][K]> } & {
  id: string;
};

Type declaration

Name	Type
id	string

Type Parameters

Type Parameter
T extends TableV2<any>

---

SavedProgress

type SavedProgress = {
  atLast: number;
  sinceLast: number;
};

Type declaration

Name	Type
atLast	number
sinceLast	number

---

SchemaTableType<S>

type SchemaTableType<S> = { [K in keyof S]: RowType<S[K]> };

Type Parameters

Type Parameter
S extends SchemaType

---

SocketSyncStreamOptions

type SocketSyncStreamOptions = SyncStreamOptions & {
  fetchStrategy: FetchStrategy;
};

Type declaration

Name	Type
fetchStrategy	FetchStrategy

---

StandardWatchedQuery<DataType>

type StandardWatchedQuery<DataType> = WatchedQuery<DataType, WatchedQuerySettings<DataType>>;

WatchedQuery returned from Query#watch.

Type Parameters

Type Parameter
DataType

---

StreamingSyncLine

type StreamingSyncLine = 
  | StreamingSyncDataJSON
  | StreamingSyncCheckpoint
  | StreamingSyncCheckpointDiff
  | StreamingSyncCheckpointComplete
  | StreamingSyncCheckpointPartiallyComplete
  | StreamingSyncKeepalive;

---

StreamingSyncLineOrCrudUploadComplete

type StreamingSyncLineOrCrudUploadComplete = 
  | StreamingSyncLine
  | CrudUploadNotification;

---

StreamingSyncRequestParameterType

type StreamingSyncRequestParameterType = JSONValue;

---

SuspenseQueryResult<T>

type SuspenseQueryResult<T> = Pick<QueryResult<T>, "data" | "refresh">;

Type Parameters

Type Parameter
T

---

SyncDataBucketJSON

type SyncDataBucketJSON = {
  after: string;
  bucket: string;
  data: OplogEntryJSON[];
  has_more: boolean;
  next_after: string;
};

Type declaration

Name	Type
after?	string
bucket	string
data	OplogEntryJSON[]
has_more?	boolean
next_after?	string

---

SyncDataFlowStatus

type SyncDataFlowStatus = Partial<{
  downloadError: Error;
  downloading: boolean;
  downloadProgress: InternalProgressInformation | null;
  uploadError: Error;
  uploading: boolean;
}>;

---

SyncRequest

type SyncRequest = 
  | ContinueCheckpointRequest
  | SyncNewCheckpointRequest;

---

SyncStatusOptions

type SyncStatusOptions = {
  connected: boolean;
  connecting: boolean;
  dataFlow: SyncDataFlowStatus;
  hasSynced: boolean;
  lastSyncedAt: Date;
  priorityStatusEntries: SyncPriorityStatus[];
};

Type declaration

Name	Type
connected?	boolean
connecting?	boolean
dataFlow?	SyncDataFlowStatus
hasSynced?	boolean
lastSyncedAt?	Date
priorityStatusEntries?	SyncPriorityStatus[]

---

SyncStreamOptions

type SyncStreamOptions = {
  abortSignal: AbortSignal;
  data: StreamingSyncRequest;
  fetchOptions: Request;
  headers: Record<string, string>;
  path: string;
};

Type declaration

Name	Type
abortSignal?	AbortSignal
data	StreamingSyncRequest
fetchOptions?	Request
headers?	Record<string, string>
path	string

Variables

column

const column: {
  integer: BaseColumnType<number | null>;
  real: BaseColumnType<number | null>;
  text: BaseColumnType<string | null>;
};

Type declaration

Name	Type
integer	BaseColumnType<number | null>
real	BaseColumnType<number | null>
text	BaseColumnType<string | null>

---

DEFAULT_CRUD_BATCH_LIMIT

const DEFAULT_CRUD_BATCH_LIMIT: 100 = 100;

---

DEFAULT_CRUD_UPLOAD_THROTTLE_MS

const DEFAULT_CRUD_UPLOAD_THROTTLE_MS: 1000 = 1000;

---

DEFAULT_INDEX_COLUMN_OPTIONS

const DEFAULT_INDEX_COLUMN_OPTIONS: Partial<IndexColumnOptions>;

---

DEFAULT_INDEX_OPTIONS

const DEFAULT_INDEX_OPTIONS: Partial<IndexOptions>;

---

DEFAULT_LOCK_TIMEOUT_MS

const DEFAULT_LOCK_TIMEOUT_MS: 120000 = 120000;

Requesting nested or recursive locks can block the application in some circumstances. This default lock timeout will act as a failsafe to throw an error if a lock cannot be obtained.

---

DEFAULT_POWERSYNC_CLOSE_OPTIONS

const DEFAULT_POWERSYNC_CLOSE_OPTIONS: PowerSyncCloseOptions;

---

DEFAULT_POWERSYNC_DB_OPTIONS

const DEFAULT_POWERSYNC_DB_OPTIONS: {
  crudUploadThrottleMs: number;
  retryDelayMs: number;
};

Type declaration

Name	Type
crudUploadThrottleMs	number
retryDelayMs	number

---

DEFAULT_PRESSURE_LIMITS

const DEFAULT_PRESSURE_LIMITS: {
  highWater: number;
  lowWater: number;
};

Type declaration

Name	Type
highWater	number
lowWater	number

---

DEFAULT_REMOTE_LOGGER

const DEFAULT_REMOTE_LOGGER: Logger.ILogger;

---

DEFAULT_REMOTE_OPTIONS

const DEFAULT_REMOTE_OPTIONS: AbstractRemoteOptions;

---

DEFAULT_RETRY_DELAY_MS

const DEFAULT_RETRY_DELAY_MS: 5000 = 5000;

---

DEFAULT_ROW_COMPARATOR

const DEFAULT_ROW_COMPARATOR: DifferentialWatchedQueryComparator<any>;

Default implementation of the DifferentialWatchedQueryComparator for watched queries. It keys items by their id property if available, alternatively it uses JSON stringification of the entire item for the key and comparison.

---

DEFAULT_STREAM_CONNECTION_OPTIONS

const DEFAULT_STREAM_CONNECTION_OPTIONS: RequiredPowerSyncConnectionOptions;

---

DEFAULT_STREAMING_SYNC_OPTIONS

const DEFAULT_STREAMING_SYNC_OPTIONS: {
  crudUploadThrottleMs: number;
  retryDelayMs: number;
};

Type declaration

Name	Type
crudUploadThrottleMs	number
retryDelayMs	number

---

DEFAULT_SYNC_CLIENT_IMPLEMENTATION

const DEFAULT_SYNC_CLIENT_IMPLEMENTATION: JAVASCRIPT = SyncClientImplementation.JAVASCRIPT;

The default SyncClientImplementation to use.

Please use this field instead of SyncClientImplementation.JAVASCRIPT directly. A future version of the PowerSync SDK will enable SyncClientImplementation.RUST by default and remove the JavaScript option.

---

DEFAULT_TABLE_OPTIONS

const DEFAULT_TABLE_OPTIONS: {
  ignoreEmptyUpdates: boolean;
  indexes: never[];
  insertOnly: boolean;
  localOnly: boolean;
  trackMetadata: boolean;
  trackPrevious: boolean;
};

Type declaration

Name	Type
ignoreEmptyUpdates	boolean
indexes	never[]
insertOnly	boolean
localOnly	boolean
trackMetadata	boolean
trackPrevious	boolean

---

DEFAULT_WATCH_QUERY_OPTIONS

const DEFAULT_WATCH_QUERY_OPTIONS: WatchedQueryOptions;

---

DEFAULT_WATCH_THROTTLE_MS

const DEFAULT_WATCH_THROTTLE_MS: 30 = 30;

---

EMPTY_DIFFERENTIAL

const EMPTY_DIFFERENTIAL: {
  added: never[];
  all: never[];
  removed: never[];
  unchanged: never[];
  updated: never[];
};

An empty differential result set. This is used as the initial state for differential incrementally watched queries.

Type declaration

Name	Type
added	never[]
all	never[]
removed	never[]
unchanged	never[]
updated	never[]

---

FalsyComparator

const FalsyComparator: WatchedQueryComparator<unknown>;

Watched query comparator that always reports changed result sets.

---

InvalidSQLCharacters

const InvalidSQLCharacters: RegExp;

---

LogLevel

const LogLevel: {
  DEBUG: Logger.ILogLevel;
  ERROR: Logger.ILogLevel;
  INFO: Logger.ILogLevel;
  OFF: Logger.ILogLevel;
  TIME: Logger.ILogLevel;
  TRACE: Logger.ILogLevel;
  WARN: Logger.ILogLevel;
};

Type declaration

Name	Type
DEBUG	Logger.ILogLevel
ERROR	Logger.ILogLevel
INFO	Logger.ILogLevel
OFF	Logger.ILogLevel
TIME	Logger.ILogLevel
TRACE	Logger.ILogLevel
WARN	Logger.ILogLevel

---

MAX_AMOUNT_OF_COLUMNS

const MAX_AMOUNT_OF_COLUMNS: 1999 = 1999;

---

MAX_OP_ID

const MAX_OP_ID: "9223372036854775807" = "9223372036854775807";

---

PowerSyncContext

const PowerSyncContext: React.Context<AbstractPowerSyncDatabase>;

---

STREAMING_POST_TIMEOUT_MS

const STREAMING_POST_TIMEOUT_MS: 30000 = 30_000;

Functions

Function	Description
compilableQueryWatch	-
createBaseLogger	Retrieves the base (default) logger instance.
createLogger	Creates and configures a new named logger based on the base logger.
extractTableUpdates	-
isBatchedUpdateNotification	-
isContinueCheckpointRequest	-
isDBAdapter	Tests if input is a DBAdapter
isPowerSyncDatabaseOptionsWithSettings	Tests if the input is a PowerSyncDatabaseOptionsWithSettings
isSQLOpenFactory	Tests if input is a SQLOpenFactory
isSQLOpenOptions	Tests if the input is a SQLOpenOptions
isStreamingKeepalive	-
isStreamingSyncCheckpoint	-
isStreamingSyncCheckpointComplete	-
isStreamingSyncCheckpointDiff	-
isStreamingSyncCheckpointPartiallyComplete	-
isStreamingSyncData	-
isSyncNewCheckpointRequest	-
parseQuery	-
runOnSchemaChange	-
usePowerSync	Custom hook that provides access to the PowerSync context.
usePowerSyncQuery	-
usePowerSyncStatus	-
usePowerSyncWatchedQuery	-
useQuery	A hook to access the results of a watched query.
useStatus	Custom hook that provides access to the current status of PowerSync.
useSuspenseQuery	A hook to access the results of a watched query that suspends until the initial result has loaded.
useWatchedQuerySubscription	A hook to access and subscribe to the results of an existing WatchedQuery instance.
useWatchedQuerySuspenseSubscription	A hook to access and subscribe to the results of an existing WatchedQuery.