@powersync/node

Enumerations

Enumeration	Description
AttachmentState	AttachmentState represents the current synchronization state of an attachment.
ColumnType	-
DiffTriggerOperation	SQLite operations to track changes for with TriggerManager
EncodingType	-
FetchStrategy	-
LockType	-
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.
AttachmentContext	AttachmentContext provides database operations for managing attachment records.
AttachmentQueue	AttachmentQueue manages the lifecycle and synchronization of attachments between local and remote storage. Provides automatic synchronization, upload/download queuing, attachment monitoring, verification and repair of local files, and cleanup of archived attachments.
AttachmentService	Service for querying and watching attachment records in the database.
AttachmentTable	AttachmentTable defines the schema for the attachment queue table.
BaseObserver	-
Column	-
ConnectionClosedError	Thrown when an underlying database connection is closed. This is particularly relevant when worker connections are marked as closed while operations are still in progress.
ConnectionManager	-
ControlledExecutor	-
CrudBatch	A batch of client-side changes.
CrudEntry	A single client-side change.
CrudTransaction	-
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	-
Mutex	An asynchronous mutex implementation.
NodeFileSystemAdapter	NodeFileSystemAdapter implements LocalStorageAdapter using Node.js filesystem. Suitable for Node.js environments and Electron applications.
OnChangeQueryProcessor	Uses the PowerSync onChange event to trigger watched queries. Results are emitted on every change of the relevant tables.
PowerSyncDatabase	A PowerSync database which provides SQLite functionality which is automatically synced.
Schema	A schema is a collection of tables. It is used to define the structure of a database.
Semaphore	An asynchronous semaphore implementation with associated items per lease.
SqliteBucketStorage	-
SyncingService	Orchestrates attachment synchronization between local and remote storage. Handles uploads, downloads, deletions, and state transitions.
SyncProgress	Provides realtime progress on how PowerSync is downloading rows.
SyncStatus	-
Table	-
TableV2	Generate a new table from the columns and indexes
TriggerManagerImpl	-
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

• RequiredAdditionalConnectionOptions

Properties

Property	Type	Description	Overrides	Inherited from
adapter	BucketStorageAdapter	-	-	-
crudUploadThrottleMs	number	Backend Connector CRUD operations are throttled to occur at most every crudUploadThrottleMs milliseconds.	-	RequiredAdditionalConnectionOptions.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.	-	RequiredAdditionalConnectionOptions.retryDelayMs
subscriptions	SubscribedStream[]	-	RequiredAdditionalConnectionOptions.subscriptions	-
uploadCrud	() => Promise<void>	-	-	-

---

AdditionalConnectionOptions

Internal

Extended by

• BasePowerSyncDatabaseOptions
• InternalConnectionOptions
• CreateSyncImplementationOptions

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.

---

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	-

---

AttachmentErrorHandler

Experimental Alpha

SyncErrorHandler provides custom error handling for attachment sync operations. Implementations determine whether failed operations should be retried or archived.

This is currently experimental and may change without a major version bump.

Methods

onDeleteError()

onDeleteError(attachment, error): Promise<boolean>

Alpha

Parameters

Parameter	Type	Description
attachment	AttachmentRecord	The attachment that failed to delete
error	unknown	The error encountered during the delete

Returns

Promise<boolean>

true to retry the operation, false to archive the attachment

---

onDownloadError()

onDownloadError(attachment, error): Promise<boolean>

Alpha

Parameters

Parameter	Type	Description
attachment	AttachmentRecord	The attachment that failed to download
error	unknown	The error encountered during the download

Returns

Promise<boolean>

true to retry the operation, false to archive the attachment

---

onUploadError()

onUploadError(attachment, error): Promise<boolean>

Alpha

Parameters

Parameter	Type	Description
attachment	AttachmentRecord	The attachment that failed to upload
error	unknown	The error encountered during the upload

Returns

Promise<boolean>

true to retry the operation, false to archive the attachment

---

AttachmentQueueOptions

Experimental Alpha

Configuration options for AttachmentQueue.

This is currently experimental and may change without a major version bump.

Properties

Property	Type	Description
archivedCacheLimit?	number	Alpha Maximum archived attachments before cleanup. Default: 100
db	AbstractPowerSyncDatabase	Alpha PowerSync database instance
downloadAttachments?	boolean	Alpha Whether to automatically download remote attachments. Default: true
errorHandler?	AttachmentErrorHandler	Alpha Handler for upload, download and delete errors
localStorage	LocalStorageAdapter	Alpha Local storage adapter for file persistence
logger?	ILogger	Alpha Logger instance. Defaults to db.logger
remoteStorage	RemoteStorageAdapter	Alpha Remote storage adapter for upload/download operations
syncIntervalMs?	number	Alpha Periodic polling interval in milliseconds for retrying failed uploads/downloads. Default: 30000
syncThrottleDuration?	number	Alpha Throttle duration in milliseconds for the reactive watch query that detects attachment changes. Prevents rapid-fire syncs during bulk changes. Default: 30
tableName?	string	Alpha Name of the table to store attachment records. Default: 'ps_attachment_queue'
watchAttachments	(onUpdate: (attachment) => Promise<void>, signal: AbortSignal) => void	Alpha Callback for monitoring attachment changes in your data model

---

AttachmentRecord

Alpha

AttachmentRecord represents an attachment in the local database.

Properties

Property	Type	Description
filename	string	Alpha
hasSynced?	boolean	Alpha
id	string	Alpha
localUri?	string	Alpha
mediaType?	string	Alpha
metaData?	string	Alpha
size?	number	Alpha
state	AttachmentState	Alpha
timestamp?	number	Alpha

---

AttachmentTableOptions

Alpha

Extends

• Omit<TableV2Options, "name" | "columns">

Properties

Property	Type	Description	Inherited from
ignoreEmptyUpdates?	boolean	Alpha	Omit.ignoreEmptyUpdates
indexes?	IndexShorthand	Alpha	Omit.indexes
insertOnly?	boolean	Alpha	Omit.insertOnly
localOnly?	boolean	Alpha	Omit.localOnly
trackMetadata?	boolean	Alpha	Omit.trackMetadata
trackPrevious?	boolean | TrackPreviousOptions	Alpha	Omit.trackPrevious
viewName?	string	Alpha	Omit.viewName

---

BaseConnectionOptions

Extended by

• InternalConnectionOptions

Properties

Property	Type	Description
appMetadata?	Record<string, string>	A set of metadata to be included in service logs.
clientImplementation?	RUST	Deprecated The Rust sync client is used unconditionally, so this option can't be configured.
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.
includeDefaultStreams?	boolean	Whether to include streams that have auto_subscribe: true in their definition. This defaults to true.
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
• ConnectionPool

Type Parameters

Type Parameter
T extends BaseListener

Methods

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<T>

Returns

Function

Returns

void

---

BasePowerSyncDatabaseOptions

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 AdditionalConnectionOptions.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.	-

---

BaseTriggerDiffRecord<TOperationId>

Experimental Alpha

Diffs created by TriggerManager#createDiffTrigger are stored in a temporary table. This is the base record structure for all diff records.

Extended by

• TriggerDiffUpdateRecord
• TriggerDiffInsertRecord
• TriggerDiffDeleteRecord

Type Parameters

Type Parameter	Default type	Description
TOperationId extends string | number	number	The type for operation_id. Defaults to number as returned by default SQLite database queries. Use string for full 64-bit precision when using { castOperationIdAsText: true } option.

Properties

Property	Type	Description
id	string	Alpha The modified row's id column value.
operation	DiffTriggerOperation	Alpha The operation performed which created this record.
operation_id	TOperationId	Alpha Auto-incrementing primary key for the operation. Defaults to number as returned by database queries (wa-sqlite returns lower 32 bits). Can be string for full 64-bit precision when using { castOperationIdAsText: true } option.
timestamp	string	Alpha Time the change operation was recorded. This is in ISO 8601 format, e.g. 2023-10-01T12:00:00.000Z.

---

BatchedUpdateNotification

Properties

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

---

BetterSqlite3Options

Use the better-sqlite3 package as a SQLite driver for PowerSync.

Properties

Property	Type
type	"better-sqlite3"

---

BucketStorageAdapter

Internal

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>

---

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

---

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

---

updateLocalTarget()

updateLocalTarget(cb): Promise<boolean>

Parameters

Parameter	Type
cb	() => Promise<string>

Returns

Promise<boolean>

---

BucketStorageListener

Internal

Extends

• BaseListener

Indexable

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

Properties

Property	Type
crudUpdate	() => void

---

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	CreateSyncImplementationOptions

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	-

---

ConnectionPool

Extends

• BaseObserverInterface<DBAdapterListener>

Extended by

• DBAdapter

Properties

Property	Type	Description
close	() => void | Promise<void>	-
name	string	-
readLock	<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>	-

Methods

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<DBAdapterListener>

Returns

Function

Returns

void

Inherited from

BaseObserverInterface.registerListener

---

ControlledExecutorOptions

Internal

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.

---

CreateDiffTriggerOptions

Experimental Alpha

Options for TriggerManager#createDiffTrigger.

Extends

• BaseCreateDiffTriggerOptions

Properties

Property	Type	Description	Inherited from
columns?	string[]	Alpha Columns to track and report changes for. Defaults to all columns in the source table. Use an empty array to track only the ID and operation.	BaseCreateDiffTriggerOptions.columns
destination	string	Alpha Destination table to send changes to. This table is created internally as a SQLite temporary table. This table will be dropped once the trigger is removed.	-
hooks?	TriggerCreationHooks	Alpha Hooks which allow execution during the trigger creation process.	BaseCreateDiffTriggerOptions.hooks
setupContext?	LockContext	Alpha Context to use for the setup operation. This is useful for when the setup operation needs to be executed in a specific context.	-
source	string	Alpha PowerSync source table/view to trigger and track changes from. This should be present in the PowerSync database's schema.	BaseCreateDiffTriggerOptions.source
useStorage?	boolean	Alpha Use storage-backed (non-TEMP) tables and triggers that persist across sessions. These resources are still automatically disposed when no longer claimed.	BaseCreateDiffTriggerOptions.useStorage
when	Partial<Record<DiffTriggerOperation, string>>	Alpha Condition to filter when the triggers should fire. This corresponds to a SQLite WHEN clause in the trigger body. This is useful for only triggering on specific conditions. For example, you can use it to only trigger on certain values in the NEW row. Note that for PowerSync the row data is stored in a JSON column named data. The row id is available in the id column. NB! The WHEN clauses here are added directly to the SQLite trigger creation SQL. Any user input strings here should be sanitized externally. The when string template function performs some basic sanitization, extra external sanitization is recommended. Example { * 'INSERT': sanitizeSQLjson_extract(NEW.data, '$.list_id') = ${sanitizeUUID(list.id)}, * 'INSERT': TRUE, * 'UPDATE': sanitizeSQLNEW.id = 'abcd' AND json_extract(NEW.data, '$.status') = 'active', * 'DELETE': sanitizeSQLjson_extract(OLD.data, '$.list_id') = 'abcd' * }	BaseCreateDiffTriggerOptions.when

---

CreateLoggerOptions

Properties

Property	Type
logLevel?	ILogLevel

---

CreateSyncImplementationOptions

Internal

The subset of AbstractStreamingSyncImplementationOptions managed by the connection manager.

Extends

• AdditionalConnectionOptions

Properties

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

---

DBAdapter

Extends

• ConnectionPool.SqlExecutor.DBGetUtils

Properties

Property	Type	Description	Inherited from
close	() => void | Promise<void>	-	ConnectionPool.close
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.	SqlExecutor.execute
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	-	SqlExecutor.executeBatch
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' } ]	SqlExecutor.executeRaw
name	string	-	ConnectionPool.name
readLock	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-	ConnectionPool.readLock
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.	ConnectionPool.refreshSchema
writeLock	<T>(fn: (tx) => Promise<T>, options?: DBLockOptions) => Promise<T>	-	ConnectionPool.writeLock
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

ConnectionPool.registerListener

---

DBAdapterListener

Extends

• BaseListener

Indexable

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

Properties

Property	Type	Description
tablesUpdated	(updateNotification: | UpdateNotification | BatchedUpdateNotification) => 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
settingsWillUpdate?	() => void	WatchedQueryListener.settingsWillUpdate

---

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
appMetadata?	Record<string, string>	A set of metadata to be included in service logs.	BaseConnectionOptions.appMetadata
clientImplementation?	RUST	Deprecated The Rust sync client is used unconditionally, so this option can't be configured.	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
includeDefaultStreams?	boolean	Whether to include streams that have auto_subscribe: true in their definition. This defaults to true.	BaseConnectionOptions.includeDefaultStreams
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

---

InternalSubscriptionAdapter

Internal

Methods

firstStatusMatching()

firstStatusMatching(predicate, abort?): Promise<void>

Parameters

Parameter	Type
predicate	(status) => any
abort?	AbortSignal

Returns

Promise<void>

---

resolveOfflineSyncStatus()

resolveOfflineSyncStatus(): Promise<void>

Returns

Promise<void>

---

rustSubscriptionsCommand()

rustSubscriptionsCommand(payload): Promise<void>

Parameters

Parameter	Type
payload	any

Returns

Promise<void>

---

LinkQueryOptions<Data, Settings>

Internal

Type Parameters

Type Parameter	Default type
Data	-
Settings extends WatchedQueryOptions	WatchedQueryOptions

Properties

Property	Type
abortSignal	AbortSignal
settings	Settings

---

LocalStorageAdapter

Experimental Alpha

LocalStorageAdapter defines the interface for local file storage operations. Implementations handle file I/O, directory management, and storage initialization.

This is currently experimental and may change without a major version bump.

Methods

clear()

clear(): Promise<void>

Alpha

Returns

Promise<void>

---

deleteFile()

deleteFile(filePath): Promise<void>

Alpha

Parameters

Parameter	Type	Description
filePath	string	Path where the file is stored

Returns

Promise<void>

---

fileExists()

fileExists(filePath): Promise<boolean>

Alpha

Parameters

Parameter	Type	Description
filePath	string	Path where the file is stored

Returns

Promise<boolean>

True if the file exists, false otherwise

---

getLocalUri()

getLocalUri(filename): string

Alpha

Parameters

Parameter	Type	Description
filename	string	The filename to get the path for

Returns

string

The full file path

---

initialize()

initialize(): Promise<void>

Alpha

Returns

Promise<void>

---

makeDir()

makeDir(path): Promise<void>

Alpha

Parameters

Parameter	Type	Description
path	string	The full path to the directory

Returns

Promise<void>

---

readFile()

readFile(filePath): Promise<ArrayBuffer>

Alpha

Parameters

Parameter	Type	Description
filePath	string	Path where the file is stored

Returns

Promise<ArrayBuffer>

ArrayBuffer containing the file data

---

rmDir()

rmDir(path): Promise<void>

Alpha

Parameters

Parameter	Type	Description
path	string	The full path to the directory

Returns

Promise<void>

---

saveFile()

saveFile(filePath, data): Promise<number>

Alpha

Parameters

Parameter	Type	Description
filePath	string	Path where the file will be stored
data	AttachmentData	Data to store (ArrayBuffer, Blob, or string)

Returns

Promise<number>

Number of bytes written

---

LockContext

Extends

• SqlExecutor.DBGetUtils

Extended by

• Transaction
• TriggerDiffHandlerContext

Properties

Property	Type	Description	Inherited from
connectionType?	"writer" | "queryOnly" | "readOnly"	How the connection has been opened. writer indicates that the lock context is capable of writing to the database. queryOnly indicates that the lock context has been opened in a readwrite mode, but a PRAGMA query_only = TRUE disabled writes. readOnly indicates that the lock context has been opened by passing SQLITE_OPEN_READONLY to sqlite3_open_v2.	-
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.	SqlExecutor.execute
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	-	SqlExecutor.executeBatch
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' } ]	SqlExecutor.executeRaw

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>

Internal

Abstract Lock to be implemented by various JS environments

Type Parameters

Type Parameter
T

Properties

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

---

NodeSqliteOptions

Use the experimental node:sqlite interface as a SQLite driver for PowerSync.

Note that this option is not currently tested and highly unstable.

Properties

Property	Type
type	"node:sqlite"

---

NodeSQLOpenOptions

The SQLOpenOptions available across all PowerSync SDKs for JavaScript extended with Node.JS-specific options.

Extends

• SQLOpenOptions

Properties

Property	Type	Description	Inherited from
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
implementation?	NodeDatabaseImplementation	-	-
initializeConnection?	(db: LockContext, isWriter: boolean) => Promise<void>	Initializes a created database connection. This can be used to e.g. set encryption keys, if an encrypted database should be used.	-
openWorker?	WorkerOpener	A callback to allow customizing how the Node.JS SDK loads workers. This can be customized to use workers at different paths. Param The arguments that would otherwise be passed to the Worker constructor.	-
readWorkerCount?	number	The Node.JS SDK will use one worker to run writing queries and additional workers to run reads. This option controls how many workers to use for reads.	-

---

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

---

ParsedQuery

Internal

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

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 | SQLOpenOptions | SQLOpenFactory	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 AdditionalConnectionOptions.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

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 AdditionalConnectionOptions.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

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 AdditionalConnectionOptions.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

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 AdditionalConnectionOptions.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

Internal

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 | SQLOpenOptions | SQLOpenFactory	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 AdditionalConnectionOptions.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 ProgressWithOperations.downloadedOperations of ProgressWithOperations.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>[]>

---

RemoteStorageAdapter

Experimental Alpha

RemoteStorageAdapter defines the interface for remote storage operations. Implementations handle uploading, downloading, and deleting files from remote storage.

This is currently experimental and may change without a major version bump.

Methods

deleteFile()

deleteFile(attachment): Promise<void>

Alpha

Parameters

Parameter	Type	Description
attachment	AttachmentRecord	The attachment describing the file to delete

Returns

Promise<void>

---

downloadFile()

downloadFile(attachment): Promise<ArrayBuffer>

Alpha

Parameters

Parameter	Type	Description
attachment	AttachmentRecord	The attachment describing the file to download

Returns

Promise<ArrayBuffer>

The binary data of the downloaded file

---

uploadFile()

uploadFile(fileData, attachment): Promise<void>

Alpha

Parameters

Parameter	Type	Description
fileData	ArrayBuffer	The binary content of the file to upload
attachment	AttachmentRecord	The associated attachment metadata

Returns

Promise<void>

---

RequiredAdditionalConnectionOptions

Internal

Extends

• Required<AdditionalConnectionOptions>

Extended by

• AbstractStreamingSyncImplementationOptions

Properties

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

---

SqlExecutor

Extended by

• LockContext
• DBAdapter

Properties

Property	Type	Description
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	-
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' } ]

---

SQLOnChangeOptions

Extended by

• SQLWatchOptions

Properties

Property	Type	Description
rawTableNames?	boolean	Deprecated All tables specified in SQLOnChangeOptions.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
• NodeSQLOpenOptions

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 SQLOnChangeOptions.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

---

StreamingSyncImplementation

Internal

Extends

• BaseObserverInterface<StreamingSyncImplementationListener>.Disposable

Properties

Property	Type	Inherited from
dispose	() => void | Promise<void>	Disposable.dispose
getWriteCheckpoint	() => Promise<string>	-
isConnected	boolean	-
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

---

markConnectionMayHaveChanged()

markConnectionMayHaveChanged(): void

Returns

void

---

registerListener()

registerListener(listener): () => void

Parameters

Parameter	Type
listener	Partial<StreamingSyncImplementationListener>

Returns

Function

Returns

void

Inherited from

BaseObserverInterface.registerListener

---

updateSubscriptions()

updateSubscriptions(subscriptions): void

Parameters

Parameter	Type
subscriptions	SubscribedStream[]

Returns

void

---

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

Internal

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.

---

SyncPriorityStatus

Properties

Property	Type
hasSynced?	boolean
lastSyncedAt?	Date
priority	number

---

SyncStream

A handle to a SyncStreamDescription that allows subscribing to the stream.

To obtain an instance of SyncStream, call AbstractPowerSyncDatabase.syncStream.

Extends

• SyncStreamDescription

Properties

Property	Type	Description	Inherited from
name	string	The name of the stream as it appears in the stream definition for the PowerSync service.	SyncStreamDescription.name
parameters	null | Record<string, any>	The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.	SyncStreamDescription.parameters

Methods

subscribe()

subscribe(options?): Promise<SyncStreamSubscription>

Adds a subscription to this stream, requesting it to be included when connecting to the sync service.

You should keep a reference to the returned SyncStreamSubscription object along as you need data for that stream. As soon as SyncStreamSubscription.unsubscribe is called for all subscriptions on this stream (including subscriptions created on other tabs), the SyncStreamSubscribeOptions.ttl starts ticking and will eventually evict the stream (unless SyncStream.subscribe is called again).

Parameters

Parameter	Type
options?	SyncStreamSubscribeOptions

Returns

Promise<SyncStreamSubscription>

---

unsubscribeAll()

unsubscribeAll(): Promise<void>

Clears all subscriptions attached to this stream and resets the TTL for the stream.

This is a potentially dangerous operations, as it interferes with other stream subscriptions.

Returns

Promise<void>

---

SyncStreamDescription

A description of a sync stream, consisting of its SyncStreamDescription.name and the SyncStreamDescription.parameters used when subscribing.

Extended by

• SyncSubscriptionDescription
• SyncStream
• SyncStreamSubscription

Properties

Property	Type	Description
name	string	The name of the stream as it appears in the stream definition for the PowerSync service.
parameters	null | Record<string, any>	The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.

---

SyncStreamStatus

Information about a sync stream subscription.

Properties

Property	Type
priority	null | number
progress	null | ProgressWithOperations
subscription	SyncSubscriptionDescription

---

SyncStreamSubscribeOptions

Properties

Property	Type	Description
priority?	0 | 2 | 1 | 3	A priority to assign to this subscription. This overrides the default priority that may have been set on streams. For details on priorities, see priotized sync.
ttl?	number	A "time to live" for this stream subscription, in seconds. The TTL control when a stream gets evicted after not having an active SyncStreamSubscription object attached to it.

---

SyncStreamSubscription

Extends

• SyncStreamDescription

Properties

Property	Type	Description	Inherited from
name	string	The name of the stream as it appears in the stream definition for the PowerSync service.	SyncStreamDescription.name
parameters	null | Record<string, any>	The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.	SyncStreamDescription.parameters

Methods

unsubscribe()

unsubscribe(): void

Removes this stream subscription.

Returns

void

---

waitForFirstSync()

waitForFirstSync(abort?): Promise<void>

A promise that resolves once data from in this sync stream has been synced and applied.

Parameters

Parameter	Type
abort?	AbortSignal

Returns

Promise<void>

---

SyncSubscriptionDescription

Information about a subscribed sync stream.

This includes the SyncStreamDescription, along with information about the current sync status.

Extends

• SyncStreamDescription

Properties

Property	Type	Description	Inherited from
active	boolean	-	-
expiresAt	null | Date	For sync streams that have a time-to-live, the current time at which the stream would expire if not subscribed to again.	-
hasExplicitSubscription	boolean	Whether this stream has been subscribed to explicitly. It's possible for both SyncSubscriptionDescription.isDefault and SyncSubscriptionDescription.hasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly.	-
hasSynced	boolean	Whether this stream subscription has been synced at least once.	-
isDefault	boolean	Whether this stream subscription is included by default, regardless of whether the stream has explicitly been subscribed to or not. It's possible for both SyncSubscriptionDescription.isDefault and SyncSubscriptionDescription.hasExplicitSubscription to be true at the same time - this happens when a default stream was subscribed explicitly.	-
lastSyncedAt	null | Date	If SyncSubscriptionDescription.hasSynced is true, the last time data from this stream has been synced.	-
name	string	The name of the stream as it appears in the stream definition for the PowerSync service.	SyncStreamDescription.name
parameters	null | Record<string, any>	The parameters used to subscribe to the stream, if any. The same stream can be subscribed to multiple times with different parameters.	SyncStreamDescription.parameters

---

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

---

TableOrRawTableOptions

Options that apply both to JSON-based tables and raw tables.

Properties

Property	Type
ignoreEmptyUpdates?	boolean
insertOnly?	boolean
localOnly?	boolean
trackMetadata?	boolean
trackPrevious?	boolean | TrackPreviousOptions

---

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

---

TrackDiffOptions

Experimental Alpha

Options for tracking changes to a table with TriggerManager#trackTableDiff.

Extends

• BaseCreateDiffTriggerOptions

Properties

Property	Type	Description	Inherited from
columns?	string[]	Alpha Columns to track and report changes for. Defaults to all columns in the source table. Use an empty array to track only the ID and operation.	BaseCreateDiffTriggerOptions.columns
hooks?	TriggerCreationHooks	Alpha Hooks which allow execution during the trigger creation process.	BaseCreateDiffTriggerOptions.hooks
onChange	(context: TriggerDiffHandlerContext) => Promise<void>	Alpha Handler for processing diff operations. Automatically invoked once diff items are present. Diff items are automatically cleared after the handler is invoked.	-
source	string	Alpha PowerSync source table/view to trigger and track changes from. This should be present in the PowerSync database's schema.	BaseCreateDiffTriggerOptions.source
throttleMs?	number	Alpha The minimum interval, in milliseconds, between TrackDiffOptions.onChange invocations. Default DEFAULT_WATCH_THROTTLE_MS	-
useStorage?	boolean	Alpha Use storage-backed (non-TEMP) tables and triggers that persist across sessions. These resources are still automatically disposed when no longer claimed.	BaseCreateDiffTriggerOptions.useStorage
when	Partial<Record<DiffTriggerOperation, string>>	Alpha Condition to filter when the triggers should fire. This corresponds to a SQLite WHEN clause in the trigger body. This is useful for only triggering on specific conditions. For example, you can use it to only trigger on certain values in the NEW row. Note that for PowerSync the row data is stored in a JSON column named data. The row id is available in the id column. NB! The WHEN clauses here are added directly to the SQLite trigger creation SQL. Any user input strings here should be sanitized externally. The when string template function performs some basic sanitization, extra external sanitization is recommended. Example { * 'INSERT': sanitizeSQLjson_extract(NEW.data, '$.list_id') = ${sanitizeUUID(list.id)}, * 'INSERT': TRUE, * 'UPDATE': sanitizeSQLNEW.id = 'abcd' AND json_extract(NEW.data, '$.status') = 'active', * 'DELETE': sanitizeSQLjson_extract(OLD.data, '$.list_id') = 'abcd' * }	BaseCreateDiffTriggerOptions.when

---

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.	-
connectionType?	"writer" | "queryOnly" | "readOnly"	How the connection has been opened. writer indicates that the lock context is capable of writing to the database. queryOnly indicates that the lock context has been opened in a readwrite mode, but a PRAGMA query_only = TRUE disabled writes. readOnly indicates that the lock context has been opened by passing SQLITE_OPEN_READONLY to sqlite3_open_v2.	LockContext.connectionType
execute	(query: string, params?: any[]) => Promise<QueryResult>	Execute a single write statement.	LockContext.execute
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	-	LockContext.executeBatch
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

---

TriggerClaimManager

Experimental Internal

Manages claims on persisted SQLite triggers and destination tables to enable proper cleanup when they are no longer actively in use.

When using persisted triggers (especially for OPFS multi-tab scenarios), we need a reliable way to determine which resources are still actively in use across different connections/tabs so stale resources can be safely cleaned up without interfering with active triggers.

A cleanup process runs on database creation (and every 2 minutes) that:

1. Queries for existing managed persisted resources
2. Checks with the claim manager if any consumer is actively using those resources
3. Deletes unused resources

Properties

Property	Type	Description
checkClaim	(identifier: string) => Promise<boolean>	Experimental Checks if a claim is present for an identifier.
obtainClaim	(identifier: string) => Promise<() => Promise<void>>	Experimental Obtains or marks a claim on a certain identifier.

---

TriggerCreationHooks

Experimental Alpha

Hooks used in the creation of a table diff trigger.

Properties

Property	Type	Description
beforeCreate?	(context: LockContext) => Promise<void>	Alpha Executed inside a write lock before the trigger is created.

---

TriggerDiffDeleteRecord<TOperationId>

Experimental Alpha

Represents a diff record for a SQLite DELETE operation. This record contains the new value represented as a JSON string.

Extends

• BaseTriggerDiffRecord<TOperationId>

Type Parameters

Type Parameter	Default type
TOperationId extends string | number	number

Properties

Property	Type	Description	Overrides	Inherited from
id	string	Alpha The modified row's id column value.	-	BaseTriggerDiffRecord.id
operation	DELETE	Alpha The operation performed which created this record.	BaseTriggerDiffRecord.operation	-
operation_id	TOperationId	Alpha Auto-incrementing primary key for the operation. Defaults to number as returned by database queries (wa-sqlite returns lower 32 bits). Can be string for full 64-bit precision when using { castOperationIdAsText: true } option.	-	BaseTriggerDiffRecord.operation_id
timestamp	string	Alpha Time the change operation was recorded. This is in ISO 8601 format, e.g. 2023-10-01T12:00:00.000Z.	-	BaseTriggerDiffRecord.timestamp
value	string	Alpha The value of the row, before the DELETE operation, in JSON string format.	-	-

---

TriggerDiffHandlerContext

Experimental Alpha

Context for the onChange handler provided to TriggerManager#trackTableDiff.

Extends

• LockContext

Properties

Property	Type	Description	Inherited from
connectionType?	"writer" | "queryOnly" | "readOnly"	Alpha How the connection has been opened. writer indicates that the lock context is capable of writing to the database. queryOnly indicates that the lock context has been opened in a readwrite mode, but a PRAGMA query_only = TRUE disabled writes. readOnly indicates that the lock context has been opened by passing SQLITE_OPEN_READONLY to sqlite3_open_v2.	LockContext.connectionType
destinationTable	string	Alpha The name of the temporary destination table created by the trigger.	-
execute	(query: string, params?: any[]) => Promise<QueryResult>	Alpha Execute a single write statement.	LockContext.execute
executeBatch	(query: string, params?: any[][]) => Promise<QueryResult>	Alpha Experimental	LockContext.executeBatch
executeRaw	(query: string, params?: any[]) => Promise<any[][]>	Alpha 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
withDiff	<T>(query: string, params?: readonly Readonly<any>[], options?: WithDiffOptions) => Promise<T[]>	Alpha Allows querying the database with access to the table containing DIFF records. The diff table is accessible via the DIFF accessor. The DIFF table is of the form described in TriggerManager#createDiffTrigger CREATE TEMP DIFF ( operation_id INTEGER PRIMARY KEY AUTOINCREMENT, id TEXT, operation TEXT, timestamp TEXT, value TEXT, previous_value TEXT ); Note that the value and previous_value columns store the row state in JSON string format. To access the row state in an extracted form see TriggerDiffHandlerContext#withExtractedDiff. Examples --- This fetches the current state of todo rows which have a diff operation present. --- The state of the row at the time of the operation is accessible in the DIFF records. SELECT todos.* FROM DIFF JOIN todos ON DIFF.id = todos.id WHERE json_extract(DIFF.value, '$.status') = 'active' // With operation_id cast as TEXT for full precision const diffs = await context.withDiff<TriggerDiffRecord<string>>( 'SELECT * FROM DIFF', undefined, { castOperationIdAsText: true } ); // diffs[0].operation_id is now typed as string	-
withExtractedDiff	<T>(query: string, params?: readonly Readonly<any>[]) => Promise<T[]>	Alpha Allows querying the database with access to the table containing diff records. The diff table is accessible via the DIFF accessor. This is similar to TriggerDiffHandlerContext#withDiff but extracts the row columns from the tracked JSON value. The diff operation data is aliased as __ columns to avoid column conflicts. For DiffTriggerOperation#DELETE operations the previous_value columns are extracted for convenience. CREATE TEMP TABLE DIFF ( id TEXT, replicated_column_1 COLUMN_TYPE, replicated_column_2 COLUMN_TYPE, __operation TEXT, __timestamp TEXT, __previous_value TEXT ); Example SELECT todos.* FROM DIFF JOIN todos ON DIFF.id = todos.id --- The todo column names are extracted from json and are available as DIFF.name WHERE DIFF.name = 'example'	-

Methods

get()

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

Alpha

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

Alpha

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>

Alpha

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
sql	string
parameters?	any[]

Returns

Promise<null | T>

Inherited from

LockContext.getOptional

---

TriggerDiffInsertRecord<TOperationId>

Experimental Alpha

Represents a diff record for a SQLite INSERT operation. This record contains the new value represented as a JSON string.

Extends

• BaseTriggerDiffRecord<TOperationId>

Type Parameters

Type Parameter	Default type
TOperationId extends string | number	number

Properties

Property	Type	Description	Overrides	Inherited from
id	string	Alpha The modified row's id column value.	-	BaseTriggerDiffRecord.id
operation	INSERT	Alpha The operation performed which created this record.	BaseTriggerDiffRecord.operation	-
operation_id	TOperationId	Alpha Auto-incrementing primary key for the operation. Defaults to number as returned by database queries (wa-sqlite returns lower 32 bits). Can be string for full 64-bit precision when using { castOperationIdAsText: true } option.	-	BaseTriggerDiffRecord.operation_id
timestamp	string	Alpha Time the change operation was recorded. This is in ISO 8601 format, e.g. 2023-10-01T12:00:00.000Z.	-	BaseTriggerDiffRecord.timestamp
value	string	Alpha The value of the row, at the time of INSERT, in JSON string format.	-	-

---

TriggerDiffUpdateRecord<TOperationId>

Experimental Alpha

Represents a diff record for a SQLite UPDATE operation. This record contains the new value and optionally the previous value. Values are stored as JSON strings.

Extends

• BaseTriggerDiffRecord<TOperationId>

Type Parameters

Type Parameter	Default type
TOperationId extends string | number	number

Properties

Property	Type	Description	Overrides	Inherited from
id	string	Alpha The modified row's id column value.	-	BaseTriggerDiffRecord.id
operation	UPDATE	Alpha The operation performed which created this record.	BaseTriggerDiffRecord.operation	-
operation_id	TOperationId	Alpha Auto-incrementing primary key for the operation. Defaults to number as returned by database queries (wa-sqlite returns lower 32 bits). Can be string for full 64-bit precision when using { castOperationIdAsText: true } option.	-	BaseTriggerDiffRecord.operation_id
previous_value	string	Alpha The previous value of the row in JSON string format.	-	-
timestamp	string	Alpha Time the change operation was recorded. This is in ISO 8601 format, e.g. 2023-10-01T12:00:00.000Z.	-	BaseTriggerDiffRecord.timestamp
value	string	Alpha The updated state of the row in JSON string format.	-	-

---

TriggerManager

Experimental Alpha

Methods

createDiffTrigger()

createDiffTrigger(options): Promise<TriggerRemoveCallback>

Experimental

Parameters

Parameter	Type
options	CreateDiffTriggerOptions

Returns

Promise<TriggerRemoveCallback>

A callback to remove the trigger and drop the destination table.

Example

const dispose = await database.triggers.createDiffTrigger({
  source: 'lists',
  destination: 'ps_temp_lists_diff',
  columns: ['name'],
  when: {
   [DiffTriggerOperation.INSERT]: 'TRUE',
   [DiffTriggerOperation.UPDATE]: 'TRUE',
   [DiffTriggerOperation.DELETE]: 'TRUE'
  }
});

---

trackTableDiff()

trackTableDiff(options): Promise<TriggerRemoveCallback>

Experimental

Parameters

Parameter	Type
options	TrackDiffOptions

Returns

Promise<TriggerRemoveCallback>

A callback to cleanup the trigger and stop tracking changes.

NB: The triggers created by this method might be invalidated by AbstractPowerSyncDatabase#updateSchema calls. These triggers should manually be dropped and recreated when updating the schema.

Example

 const dispose = database.triggers.trackTableDiff({
       source: 'todos',
       columns: ['list_id'],
       when: {
         [DiffTriggerOperation.INSERT]: sanitizeSQL`json_extract(NEW.data, '$.list_id') = ${sanitizeUUID(someIdVariable)}`
       },
       onChange: async (context) => {
         // Fetches the todo records that were inserted during this diff
         const newTodos = await context.withDiff<Database['todos']>(`
           SELECT
             todos.*
           FROM
             DIFF
             JOIN todos ON DIFF.id = todos.id
         `);

         // Process newly created todos
       },
       hooks: {
         beforeCreate: async (lockContext) => {
           // This hook is executed inside the write lock before the trigger is created.
           // It can be used to synchronize the current state of the table with processor logic.
           // Any changes after this callback are guaranteed to trigger the `onChange` handler.

           // Read the current state of the todos table
           const currentTodos = await lockContext.getAll<Database['todos']>(
             `
               SELECT
                 *
               FROM
                 todos
               WHERE
                 list_id = ?
             `,
             ['123']
           );

           // Process existing todos
         }
       }
     });

---

TriggerManagerConfig

Experimental Internal

Properties

Property	Type	Description
claimManager	TriggerClaimManager	Experimental

---

TriggerRemoveCallbackOptions

Experimental Alpha

Options for TriggerRemoveCallback.

Properties

Property	Type	Description
context?	LockContext	Alpha Experimental

---

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>

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>
settingsWillUpdate?	() => 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

---

WithDiffOptions

Experimental Alpha

Options for TriggerDiffHandlerContext#withDiff.

Properties

Property	Type	Description
castOperationIdAsText?	boolean	Alpha If true, casts operation_id as TEXT in the internal CTE to preserve full 64-bit precision. Use this when you need to ensure operation_id is treated as a string to avoid precision loss for values exceeding JavaScript's Number.MAX_SAFE_INTEGER. When enabled, use TriggerDiffRecord to type the result correctly.

Type Aliases

AbstractRemoteOptions

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

Internal

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.

---

AttachmentData

type AttachmentData = ArrayBuffer | string;

Alpha

---

AttachmentTableRecord

type AttachmentTableRecord = RowType<AttachmentTable>;

Alpha

AttachmentTableRecord represents the row type of the attachment table.

---

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>;

---

ColumnsType

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

---

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>

---

ExtractedTriggerDiffRecord<T, TOperationId>

type ExtractedTriggerDiffRecord<T, TOperationId> = T & { [K in keyof Omit<BaseTriggerDiffRecord<TOperationId>, "id"> as `__${string & K}`]: TriggerDiffRecord<TOperationId>[K] } & {
  __previous_value: string;
};

Experimental Alpha

Querying the DIFF table directly with TriggerDiffHandlerContext#withExtractedDiff will return records with the tracked columns extracted from the JSON value. This type represents the structure of such records.

Type declaration

Name	Type
__previous_value?	string

Type Parameters

Type Parameter	Default type	Description
T	-	The type for the extracted columns from the tracked JSON value.
TOperationId extends string | number	number	The type for operation_id. Defaults to number as returned by database queries. Use string for full 64-bit precision when using { castOperationIdAsText: true } option.

Example

// Default: operation_id is number
const diffs = await context.withExtractedDiff<ExtractedTriggerDiffRecord<{id: string, name: string}>>('SELECT * FROM DIFF');

// With string operation_id for full precision
const diffsWithString = await context.withExtractedDiff<ExtractedTriggerDiffRecord<{id: string, name: string}, string>>(
  'SELECT * FROM DIFF',
  undefined,
  { castOperationIdAsText: true }
);

---

FetchImplementation

type FetchImplementation = typeof fetch;

Internal

---

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

---

NodeAdditionalConnectionOptions

type NodeAdditionalConnectionOptions = AdditionalConnectionOptions & NodeCustomConnectionOptions;

---

NodeDatabaseImplementation

type NodeDatabaseImplementation = 
  | BetterSqlite3Options
  | NodeSqliteOptions;

---

NodePowerSyncConnectionOptions

type NodePowerSyncConnectionOptions = PowerSyncConnectionOptions & NodeAdditionalConnectionOptions;

---

NodePowerSyncDatabaseOptions

type NodePowerSyncDatabaseOptions = PowerSyncDatabaseOptions & {
  database:   | DBAdapter
     | SQLOpenFactory
     | NodeSQLOpenOptions;
  remoteOptions: Partial<AbstractRemoteOptions>;
};

Type declaration

Name	Type	Description
database	| DBAdapter | SQLOpenFactory | NodeSQLOpenOptions	-
remoteOptions?	Partial<AbstractRemoteOptions>	Options to override how the SDK will connect to the sync service. This option is intended to be used for internal tests.

---

OpId

type OpId = string;

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

Not sortable as a string.

---

PendingStatement

type PendingStatement = {
  params: PendingStatementParameter[];
  sql: string;
};

A statement that the PowerSync client should use to insert or delete data into a table managed by the user.

Type declaration

Name	Type
params	PendingStatementParameter[]
sql	string

---

PendingStatementParameter

type PendingStatementParameter = 
  | "Id"
  | {
  Column: string;
 }
  | "Rest";

A parameter to use as part of PendingStatement.

For delete statements, only the "Id" value is supported - the sync client will replace it with the id of the row to be synced.

For insert and replace operations, the values of columns in the table are available as parameters through {Column: 'name'}. The "Rest" parameter gets resolved to a JSON object covering all values from the synced row that haven't been covered by a Column parameter.

---

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 reported by SQLite for a write query. When using the default client-side JSON-based view system, rowsAffected may be 0 for successful UPDATE and DELETE statements. Use a RETURNING clause and inspect rows when you need to confirm which rows changed.

---

RawTableType

type RawTableType = RawTableTypeWithStatements | InferredRawTableType;

Instructs PowerSync to sync data into a "raw" table.

Since raw tables are not backed by JSON, running complex queries on them may be more efficient. Further, they allow using client-side table and column constraints.

To collect local writes to raw tables with PowerSync, custom triggers are required. See https://docs.powersync.com/usage/use-case-examples/raw-tables for details and an example on using raw tables.

---

RemoteConnector

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

Internal

Type declaration

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

---

RequiredPowerSyncConnectionOptions

type RequiredPowerSyncConnectionOptions = Required<BaseConnectionOptions>;

Internal

---

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>

---

SchemaTableType<S>

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

Type Parameters

Type Parameter
S extends SchemaType

---

SimpleAsyncIterator<T>

type SimpleAsyncIterator<T> = Pick<AsyncIterator<T>, "next">;

Internal

An async iterator that can't be cancelled.

To keep data flow simple, we always pass an explicit cancellation token when subscribing to async streams. Once the AbortSignal aborts, iterators are supposed to clean up and then emit a final {done: true} event. This means that there's no way to distinguish between streams that have completed normally and streams that have been cancelled, but that is acceptable for our uses of this.

Type Parameters

Type Parameter
T

---

SocketSyncStreamOptions

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

Internal

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

---

StreamingSyncRequestParameterType

type StreamingSyncRequestParameterType = JSONValue;

---

SubscribedStream

type SubscribedStream = {
  name: string;
  params: Record<string, any> | null;
};

Internal

Type declaration

Name	Type
name	string
params	Record<string, any> | null

---

SyncDataFlowStatus

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

---

SyncStatusOptions

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

Internal

Type declaration

Name	Type	Description
clientImplementation?	SyncClientImplementation	Deprecated This field is no longer set, since SyncClientImplementation.RUST is the only option.
connected?	boolean	-
connecting?	boolean	-
dataFlow?	SyncDataFlowStatus	-
hasSynced?	boolean	-
lastSyncedAt?	Date	-
priorityStatusEntries?	SyncPriorityStatus[]	-

---

SyncStreamOptions

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

Internal

Type declaration

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

---

TriggerDiffRecord<TOperationId>

type TriggerDiffRecord<TOperationId> = 
  | TriggerDiffUpdateRecord<TOperationId>
  | TriggerDiffInsertRecord<TOperationId>
| TriggerDiffDeleteRecord<TOperationId>;

Experimental Alpha

Diffs created by TriggerManager#createDiffTrigger are stored in a temporary table. This is the record structure for all diff records.

Querying the DIFF table directly with TriggerDiffHandlerContext#withDiff will return records with the structure of this type.

Type Parameters

Type Parameter	Default type	Description
TOperationId extends string | number	number	The type for operation_id. Defaults to number as returned by database queries. Use string for full 64-bit precision when using { castOperationIdAsText: true } option.

Example

// Default: operation_id is number
const diffs = await context.withDiff<TriggerDiffRecord>('SELECT * FROM DIFF');

// With string operation_id for full precision
const diffsWithString = await context.withDiff<TriggerDiffRecord<string>>(
  'SELECT * FROM DIFF',
  undefined,
  { castOperationIdAsText: true }
);

---

TriggerRemoveCallback()

type TriggerRemoveCallback = (options?) => Promise<void>;

Experimental Alpha

Callback to drop a trigger after it has been created.

Parameters

Parameter	Type
options?	TriggerRemoveCallbackOptions

Returns

Promise<void>

---

UnlockFn()

type UnlockFn = () => void;

Internal

Returns

void

---

WatchedAttachmentItem

type WatchedAttachmentItem = 
  | {
  fileExtension: never;
  filename: string;
  id: string;
  mediaType: string;
  metaData: string;
 }
  | {
  fileExtension: string;
  filename: never;
  id: string;
  mediaType: string;
  metaData: string;
};

Alpha

WatchedAttachmentItem represents an attachment reference in your application's data model. Use either filename OR fileExtension (not both).

---

WorkerOpener()

type WorkerOpener = (...args) => InstanceType<typeof Worker>;

Parameters

Parameter	Type
...args	ConstructorParameters<typeof Worker>

Returns

InstanceType<typeof Worker>

Variables

ATTACHMENT_TABLE

const ATTACHMENT_TABLE: "attachments" = "attachments";

Alpha

The default name of the local table storing attachment data.

---

ATTACHMENT_TABLE_COLUMNS

const ATTACHMENT_TABLE_COLUMNS: {
  filename: BaseColumnType;
  has_synced: BaseColumnType;
  local_uri: BaseColumnType;
  media_type: BaseColumnType;
  meta_data: BaseColumnType;
  size: BaseColumnType;
  state: BaseColumnType;
  timestamp: BaseColumnType;
};

Alpha

Type declaration

Name	Type
filename	BaseColumnType
has_synced	BaseColumnType
local_uri	BaseColumnType
media_type	BaseColumnType
meta_data	BaseColumnType
size	BaseColumnType
state	BaseColumnType
timestamp	BaseColumnType

---

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;

Internal

---

DEFAULT_CRUD_UPLOAD_THROTTLE_MS

const DEFAULT_CRUD_UPLOAD_THROTTLE_MS: 1000 = 1000;

Internal

---

DEFAULT_INDEX_COLUMN_OPTIONS

const DEFAULT_INDEX_COLUMN_OPTIONS: Partial<IndexColumnOptions>;

Internal

---

DEFAULT_INDEX_OPTIONS

const DEFAULT_INDEX_OPTIONS: Partial<IndexOptions>;

Internal

---

DEFAULT_LOCK_TIMEOUT_MS

const DEFAULT_LOCK_TIMEOUT_MS: 120000 = 120000;

Internal

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;

Internal

---

DEFAULT_POWERSYNC_DB_OPTIONS

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

Internal

Type declaration

Name	Type
crudUploadThrottleMs	number
retryDelayMs	number

---

DEFAULT_REMOTE_LOGGER

const DEFAULT_REMOTE_LOGGER: Logger.ILogger;

Internal

---

DEFAULT_REMOTE_OPTIONS

const DEFAULT_REMOTE_OPTIONS: AbstractRemoteOptions;

Internal

---

DEFAULT_RETRY_DELAY_MS

const DEFAULT_RETRY_DELAY_MS: 5000 = 5000;

Internal

---

DEFAULT_ROW_COMPARATOR

const DEFAULT_ROW_COMPARATOR: DifferentialWatchedQueryComparator<any>;

Internal

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;

Internal

---

DEFAULT_STREAMING_SYNC_OPTIONS

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

Internal

Type declaration

Name	Type
crudUploadThrottleMs	number
retryDelayMs	number

---

DEFAULT_SYNC_CLIENT_IMPLEMENTATION

const DEFAULT_SYNC_CLIENT_IMPLEMENTATION: RUST = SyncClientImplementation.RUST;

The default SyncClientImplementation to use, SyncClientImplementation.RUST.

Deprecated

Deprecated since SyncClientImplementation.RUST is the only option.

---

DEFAULT_TABLE_OPTIONS

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

Internal

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;

Internal

---

DEFAULT_WATCH_THROTTLE_MS

const DEFAULT_WATCH_THROTTLE_MS: 30 = 30;

Internal

---

EMPTY_DIFFERENTIAL

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

Internal

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;

Internal

---

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;

Internal

powersync-sqlite-core limits the number of column per table to 1999, due to internal SQLite limits. In earlier versions this was limited to 63.

---

MAX_OP_ID

const MAX_OP_ID: "9223372036854775807" = "9223372036854775807";

Internal

---

MEMORY_TRIGGER_CLAIM_MANAGER

const MEMORY_TRIGGER_CLAIM_MANAGER: TriggerClaimManager;

Internal Experimental

Functions

Function	Description
attachmentFromSql	Maps a database row to an AttachmentRecord.
compilableQueryWatch	-
createBaseLogger	Retrieves the base (default) logger instance.
createLogger	Creates and configures a new named logger based on the base logger.
DBAdapterDefaultMixin	A mixin to implement DBAdapter by delegating to ConnectionPool#readLock and ConnectionPool#writeLock.
DBGetUtilsDefaultMixin	Implements DBGetUtils on a SqlExecutor.
extractTableUpdates	-
isBatchedUpdateNotification	-
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
parseQuery	-
runOnSchemaChange	-
sanitizeSQL	SQL string template function for TrackDiffOptions#when and CreateDiffTriggerOptions#when.
sanitizeUUID	Helper function for sanitizing UUID input strings. Typically used with sanitizeSQL.
timeoutSignal	Creates a signal aborting after the set timeout.