SyncPersistenceCapabilityV1

type SyncPersistenceCapabilityV1<TKey> = object;

Defined in: packages/db/src/types.ts:570

Internal

Unstable cross-package protocol for persistence-aware adapters.

Type Parameters#

TKey#

TKey extends string | number = string | number

Properties#

hydrateBaseline()#

readonly hydrateBaseline: () => Promise<void>;

Defined in: packages/db/src/types.ts:579

Returns#

Promise<void>

managedCacheGeneration?#

readonly optional managedCacheGeneration: boolean;

Defined in: packages/db/src/types.ts:576

This run owns a claimed on-demand cache generation.

protocol#

readonly protocol: "@tanstack/db/sync-persistence";

Defined in: packages/db/src/types.ts:573

reserveCommitTurn()#

readonly reserveCommitTurn: () => void;

Defined in: packages/db/src/types.ts:589

Reserve the open sync transaction's FIFO turn, so a subset hydration that starts before it commits waits for that commit.

Returns#

void

resumeSnapshot#

readonly resumeSnapshot: object;

Defined in: packages/db/src/types.ts:593

certify()#

readonly certify: () => Promise<void>;

Returns#

Promise<void>

expectCurrentCommit()#

readonly expectCurrentCommit: () => void;

Returns#

void

getKeySetEvidence()#

readonly getKeySetEvidence: () => 
  | SyncPersistenceKeySetEvidence
  | undefined;

Returns#

| SyncPersistenceKeySetEvidence | undefined

scanPersistedRows()#

readonly scanPersistedRows: (options?) => Promise<SyncPersistenceScannedRow<TKey>[]>;

Defined in: packages/db/src/types.ts:590

Parameters#

options?#

SyncPersistenceScanOptions

Returns#

Promise<SyncPersistenceScannedRow<TKey>[]>

startScopedRecovery()?#

readonly optional startScopedRecovery: (resetMetadata?) => Promise<void>;

Defined in: packages/db/src/types.ts:581

Retire untrusted on-demand rows and retain the provider's reset metadata.

Parameters#

resetMetadata?#

key#

string

value#

unknown

Returns#

Promise<void>

startupCacheGenerationRotated?#

readonly optional startupCacheGenerationRotated: boolean;

Defined in: packages/db/src/types.ts:578

The on-demand cache generation rotated before the source sync run entered.

version#

readonly version: 1;

Defined in: packages/db/src/types.ts:574