SqliteBucketStorage

Extends

• BaseObserver<BucketStorageListener>

Implements

• BucketStorageAdapter

Constructors

new SqliteBucketStorage()

new SqliteBucketStorage(db, logger?): SqliteBucketStorage

Parameters

Parameter	Type
db	DBAdapter
logger?	ILogger

Returns

SqliteBucketStorage

Overrides

BaseObserver.constructor

Properties

Property	Modifier	Type
tableNames	public	Set<string>
_subkeyMigrationKey	static	string

Methods

_getClientId()

_getClientId(): Promise<string>

Returns

Promise<string>

---

control()

control(op, payload): Promise<string>

Invokes the powersync_control function for the sync client.

Parameters

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

Returns

Promise<string>

Implementation of

BucketStorageAdapter.control

---

dispose()

dispose(): Promise<void>

Returns

Promise<void>

Implementation of

BucketStorageAdapter.dispose

Overrides

BaseObserver.dispose

---

getBucketOperationProgress()

getBucketOperationProgress(): Promise<BucketOperationProgress>

Returns

Promise<BucketOperationProgress>

Implementation of

BucketStorageAdapter.getBucketOperationProgress

---

getBucketStates()

getBucketStates(): Promise<BucketState[]>

Returns

Promise<BucketState[]>

Implementation of

BucketStorageAdapter.getBucketStates

---

getClientId()

getClientId(): Promise<string>

Get an unique client id.

Returns

Promise<string>

Implementation of

BucketStorageAdapter.getClientId

---

getCrudBatch()

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

Get a batch of objects to send to the server. When the objects are successfully sent to the server, call .complete()

Parameters

Parameter	Type
limit?	number

Returns

Promise<null | CrudBatch>

Implementation of

BucketStorageAdapter.getCrudBatch

---

getMaxOpId()

getMaxOpId(): string

Returns

string

Implementation of

BucketStorageAdapter.getMaxOpId

---

hasCompletedSync()

hasCompletedSync(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

BucketStorageAdapter.hasCompletedSync

---

hasCrud()

hasCrud(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

BucketStorageAdapter.hasCrud

---

hasMigratedSubkeys()

hasMigratedSubkeys(): Promise<boolean>

Returns

Promise<boolean>

Implementation of

BucketStorageAdapter.hasMigratedSubkeys

---

init()

init(): Promise<void>

Returns

Promise<void>

Implementation of

BucketStorageAdapter.init

---

iterateAsyncListeners()

iterateAsyncListeners(cb): Promise<void>

Parameters

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

Returns

Promise<void>

Inherited from

BaseObserver.iterateAsyncListeners

---

iterateListeners()

iterateListeners(cb): void

Parameters

Parameter	Type
cb	(listener) => any

Returns

void

Inherited from

BaseObserver.iterateListeners

---

migrateToFixedSubkeys()

migrateToFixedSubkeys(): Promise<void>

Returns

Promise<void>

Implementation of

BucketStorageAdapter.migrateToFixedSubkeys

---

nextCrudItem()

nextCrudItem(): Promise<undefined | CrudEntry>

Returns

Promise<undefined | CrudEntry>

Implementation of

BucketStorageAdapter.nextCrudItem

---

registerListener()

registerListener(listener): () => void

Register a listener for updates to the PowerSync client.

Parameters

Parameter	Type
listener	Partial<BucketStorageListener>

Returns

Function

Returns

void

Implementation of

BucketStorageAdapter.registerListener

Inherited from

BaseObserver.registerListener

---

removeBuckets()

removeBuckets(buckets): Promise<void>

Parameters

Parameter	Type
buckets	string[]

Returns

Promise<void>

Implementation of

BucketStorageAdapter.removeBuckets

---

saveSyncData()

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

Parameters

Parameter	Type
batch	SyncDataBatch
fixedKeyFormat?	boolean

Returns

Promise<void>

Implementation of

BucketStorageAdapter.saveSyncData

---

setTargetCheckpoint()

setTargetCheckpoint(checkpoint): Promise<void>

Set a target checkpoint.

Parameters

Parameter	Type
checkpoint	Checkpoint

Returns

Promise<void>

Implementation of

BucketStorageAdapter.setTargetCheckpoint

---

startSession()

startSession(): void

Reset any caches.

Returns

void

Implementation of

BucketStorageAdapter.startSession

---

syncLocalDatabase()

syncLocalDatabase(checkpoint, priority?): Promise<SyncLocalDatabaseResult>

Parameters

Parameter	Type
checkpoint	Checkpoint
priority?	number

Returns

Promise<SyncLocalDatabaseResult>

Implementation of

BucketStorageAdapter.syncLocalDatabase

---

updateLocalTarget()

updateLocalTarget(cb): Promise<boolean>

Parameters

Parameter	Type
cb	() => Promise<string>

Returns

Promise<boolean>

Implementation of

BucketStorageAdapter.updateLocalTarget

---

validateChecksums()

validateChecksums(checkpoint, priority): Promise<SyncLocalDatabaseResult>

Parameters

Parameter	Type
checkpoint	Checkpoint
priority	undefined | number

Returns

Promise<SyncLocalDatabaseResult>

---

writeTransaction()

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

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
callback	(tx) => Promise<T>
options?	{ timeoutMs: number; }
options.timeoutMs?	number

Returns

Promise<T>