DB Docs
API Reference
- Core API Reference
- Collection
- createCollection
- liveQueryCollectionOptions
- createLiveQueryCollection
- createOptimisticAction
- createTransaction
- Electric DB Collection
- electricCollectionOptions
- Query DB Collection
- queryCollectionOptions
- RxDB DB Collection
- rxdbCollectionOptions
- PowerSync Collection
- powerSyncCollectionOptions
- createIndexedDB
- indexedDBCollectionOptions
- React Hooks
- useLiveQuery
AI/LLM: This documentation page is available in plain markdown format at/db/latest/docs/reference/interfaces/CreateLiveQueryObserverOptions.md
CreateLiveQueryObserverOptions
Defined in: packages/db/src/live-query-observer.ts:1170
Properties#
client?#
ts
optional client: DbClient;Defined in: packages/db/src/live-query-observer.ts:1187
DbClient cache that owns SSR snapshots for this query identity.
mode?#
ts
optional mode: "granular" | "wholesale";Defined in: packages/db/src/live-query-observer.ts:1185
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()?#
ts
optional onPreload: () => void;Defined in: packages/db/src/live-query-observer.ts:1191
Resume framework-deferred query sources before a server preload.
Returns#
void
queryHash?#
ts
optional queryHash: string;Defined in: packages/db/src/live-query-observer.ts:1189
Stable live-query identity used for dehydration and hydration.