Method RequestCheckpoint

Namespace

PowerSync.Common.Client

Assembly

PowerSync.Common.dll

RequestCheckpoint(CancellationToken)

Requests a checkpoint from the PowerSync service.

The returned request can be awaited using WaitForSync(CancellationToken) to confirm that the local database has applied server-side changes up to the checkpoint. This method requires an active or connecting sync client connected with Requests() and PowerSync service version 1.24.0 or later.

public Task<CheckpointRequest> RequestCheckpoint(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task<CheckpointRequest>

Exceptions

CheckpointRequestException

Thrown when requesting the checkpoint has failed, for example when the database is disconnected.