Skip to main content

Module api

Module api 

Source
Expand description

Driver-facing API shapes (JSON-able), mirroring the conformance ClientInstance contract: sync reports, conflicts, rejections, row states, subscription states. Serialized as camelCase to cross the shim boundary unchanged.

Structs§

ClientChangeBatch
JSON bindings carry the u64 revision as a decimal string (§7.5).
ClientDiagnosticsHost
ClientDiagnosticsLease
ClientDiagnosticsReplica
ClientDiagnosticsRequest
ClientDiagnosticsSchema
ClientDiagnosticsSnapshot
ClientDiagnosticsStorage
ClientLimits
Client limits (§4.2 request knobs).
CommandEffects
CommitOperation
Schema-agnostic local operation retained with a failed final outcome.
CommitOutcome
CommitOutcomeQuery
ConflictRecord
CoverageSnapshot
DiagnosticLastChange
DiagnosticLastRound
DiagnosticRoundCounters
DiagnosticSubscription
ExpectedDiagnosticSubscription
LeaseState
§7.3.5: the client’s opaque auth-lease state — leaseId/expiresAtMs from the last LEASE frame, and errorCode once a round was rejected with a request-level lease code (stop-and-surface; no data purge).
LocalDataPurgeInput
Durable local idempotency key plus exact routing targets. The host owns directive authenticity and subscription gating; the client owns SQLite.
LocalDataPurgeResult
Privacy-safe local purge acknowledgement; row ids never cross the bridge.
LocalDataPurgeTarget
One AND-combined application-authorized local purge target. Targets in one input are OR-combined. Selector columns must compile to plaintext strings; values are bounded code-like routing identifiers.
LocalDataRebootstrapInput
Durable application repair id. Reusing the id is an exact no-op.
LocalDataRebootstrapResult
Privacy-safe acknowledgement for a replicated-projection recovery.
PresencePeer
§8.6 a peer’s ephemeral presence document on a scope key.
QuerySnapshot
RejectionDetails
Bounded code-like metadata explicitly declared safe for authorized client recovery UI. Diagnostic prose remains in RejectionRecord.message.
RejectionRecord
ResolveCommitOutcomeInput
RowState
SchemaFloor
SubscriptionStateView
SyncReport
SyncStatusSnapshot
TableChange
WindowBase
§4.8 window base: one table, the scope variable whose values are the window units, any fixed scopes shared by every unit, and host-opaque params carried onto each unit’s subscription.
WindowChange
WindowCoverage
WindowState
§4.8 completeness oracle (I3): the windowed-in units for a base, plus the subset whose bootstrap has not yet completed. Registration alone is not completeness — a pending unit’s local replica may be empty or partial (its subscription still has cursor: -1 or holds a resume token), and MUST NOT be rendered as complete. A unit with zero server rows still completes once its bootstrap round finishes.
WindowUnitRef

Enums§

CommitOperationOutcome
CommitOutcomeResolution
CommitOutcomeStatus
Mutation
One local mutation (§6.1 shapes, schema-agnostic local form per §0).
SyncIntent
SyncOutcome
sync() never panics or errors out-of-band: transport and protocol failures come back as Failed (the driver’s { ok: false }).
TimeBucketUnit

Constants§

CLIENT_DIAGNOSTICS_VERSION
MAX_DIAGNOSTIC_EXPECTED_SUBSCRIPTIONS

Functions§

creation_time_bucket
Derive the immutable UTC scope value stored when a row is created.
last
Return a rolling UTC month window ordered from oldest to newest.

Type Aliases§

QueryRow
One dynamic query result row, keyed by QueryIR runtime projection name.
QueryValue
Stable dynamic value boundary used by generated named queries.