CreateLiveQueryObserverOptions

Defined in: packages/db/src/live-query-observer.ts:748

Properties#

client?#

optional client?: DbClient;

Defined in: packages/db/src/live-query-observer.ts:765

DbClient cache that owns SSR snapshots for this query identity.

mode?#

optional mode?: "granular" | "wholesale";

Defined in: packages/db/src/live-query-observer.ts:763

How subscribers consume the observer:

• granular (default): subscribers apply the delivered ChangeMessage[] deltas to their own keyed state (Vue/Svelte/Solid). The observer subscribes with initial state and seeds late subscribers, so every subscriber converges from deltas alone.
• wholesale: subscribers treat notifications as a wake-up and re-read getSnapshot() (React/Angular). The observer subscribes WITHOUT initial state, preserving those adapters' loading policy — no snapshot request, so no unfiltered loadSubset against on-demand collections. Nothing is delivered synchronously during subscribe, which keeps useSyncExternalStore-style consumers safe by construction.

onPreload?#

optional onPreload?: () => void;

Defined in: packages/db/src/live-query-observer.ts:769

Resume framework-deferred query sources before a server preload.

Returns#

void

queryHash?#

optional queryHash?: string;

Defined in: packages/db/src/live-query-observer.ts:767

Stable live-query identity used for dehydration and hydration.

suspendUntilReady?#

optional suspendUntilReady?: boolean;

Defined in: packages/db/src/live-query-observer.ts:771

Read the completed stream rather than an earlier ordinary loading view.