Class PowerSyncDatabase

Namespace

PowerSync.Common.Client

Assembly

PowerSync.Common.dll

public class PowerSyncDatabase : IPowerSyncDatabase, ICloseableAsync

Inheritance

object

PowerSyncDatabase

Implements

IPowerSyncDatabase

ICloseableAsync

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PowerSyncDatabase(PowerSyncDatabaseOptions)

Fields

BucketStorageAdapter

ConnectionManager

IsReadyTask

masterCts

syncStreamStatusCts

Properties

Closed

Connected

Connecting

ConnectionOptions

Connector

CurrentStatus

Database

Events

Logger

Ready

SdkVersion

SyncStreamImplementation

Methods

Close()

Close the database, releasing resources.

Also disconnects any active connection.

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

Connect(IPowerSyncBackendConnector, PowerSyncConnectionOptions?)

Disconnect()

DisconnectAndClear(bool)

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

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

Execute(string, object?[]?)

ExecuteBatch(string, object?[][]?)

Get(string, object?[]?)

GetAll(string, object?[]?)

GetAll<T>(string, object?[]?)

GetClientId()

Get an unique client id for this database.

The id is not reset when the database is cleared, only when the database is deleted.

GetCrudBatch(int)

Get a batch of crud data to upload.

Returns null if there is no data to upload.

Use this from the UploadData(IPowerSyncDatabase) callback.

Once the data have been successfully uploaded, call Complete(string?) before requesting the next batch.

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

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

GetNextCrudTransaction()

Get the next recorded transaction to upload.

Returns null if there is no data to upload.

Use this from the UploadData(IPowerSyncDatabase) callback.

Once the data have been successfully uploaded, call Complete(string?) before requesting the next transaction.

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

GetOptional(string, object?[]?)

GetOptional<T>(string, object?[]?)

GetUploadQueueStats(bool)

Get upload queue size estimate and count.

Get<T>(string, object?[]?)

HandleCrudCheckpoint(long, string?)

Init()

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

Initialize(PowerSyncDatabaseOptions)

OnChange(SQLWatchOptions?)

Emits an event whenever any of the tables in Tables are modified.

ReadLock<T>(Func<ILockContext, Task<T>>, DBLockOptions?)

ReadTransaction<T>(Func<ITransaction, Task<T>>, DBLockOptions?)

ResolveOfflineSyncStatus()

SyncStream(string, Dictionary<string, object>?)

Create a sync stream to query its status or to subscribe to it.

Sync streams are currently in alpha.

UpdateSchema(Schema)

Replace the schema with a new version. This is for advanced use cases - typically the schema should just be specified once in the constructor. Cannot be used while connected - this should only be called before Connect(IPowerSyncBackendConnector, PowerSyncConnectionOptions?).

WaitForFirstSync(PrioritySyncRequest?)

Wait for the first sync operation to complete.

WaitForReady()

Resolves once initialization is completed.

WaitForStatus(Func<SyncStatus, bool>, CancellationToken?)

Waits for the first sync status for which the predicate callback returns true.

Watch<T>(string, object?[]?, SQLWatchOptions?)

Executes a read query every time the source tables are modified.

The query's source tables are resolved automatically (or taken from Tables when provided), and are re-resolved whenever the schema changes, so watches keep working across UpdateSchema(Schema) calls.

WriteLock(Func<ILockContext, Task>, DBLockOptions?)

WriteLock<T>(Func<ILockContext, Task<T>>, DBLockOptions?)

WriteTransaction(Func<ITransaction, Task>, DBLockOptions?)

WriteTransaction<T>(Func<ITransaction, Task<T>>, DBLockOptions?)

generateBucketStorageAdapter()