QueryCollectionUtils

Defined in: packages/query-db-collection/src/query.ts:290

Utility methods available on Query Collections for direct writes and manual operations. Direct writes bypass optimistic mutations and write to the synced data store. Eager collections patch Query cache; on-demand collections revalidate scoped entries.

Type Parameters

TItem

TItem extends object = Record<string, unknown>

The type of items stored in the collection

TKey

TKey extends string | number = string | number

The type of the item keys

TInsertInput

TInsertInput extends object = TItem

The type accepted for insert operations

TError

TError = unknown

The type of errors that can occur during queries

Properties

clearError()

clearError: () => Promise<void>;

Defined in: packages/query-db-collection/src/query.ts:344

Refetch, retaining errors until a successful result applies. While a user mutation is persisting or its handler is active, this retains the Query fetch boundary so it cannot wait on publication blocked by that transaction.

Returns

Promise<void>

Promise that resolves when the applicable refetch boundary completes

Throws

Error if the refetch fails

dataUpdatedAt

dataUpdatedAt: number;

Defined in: packages/query-db-collection/src/query.ts:328

Get timestamp of last successful data update (in milliseconds)

errorCount

errorCount: number;

Defined in: packages/query-db-collection/src/query.ts:320

Get the number of consecutive sync failures. Incremented only when query fails completely (not per retry attempt); reset after a successful result applies.

fetchStatus

fetchStatus: "idle" | "fetching" | "paused";

Defined in: packages/query-db-collection/src/query.ts:334

Get the aggregate observer fetch status. Returns fetching if any observer is fetching, otherwise paused if any observer is paused, and idle when every observer is idle or no observers exist.