Interface: QueryCollectionUtils<TItem, TKey, TInsertInput, TError>

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

Utility methods available on Query Collections for direct writes and manual operations. Direct writes bypass the normal query/mutation flow and write directly to the synced data store.

Extends

UtilsRecord

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

Indexable

[key: string]: any

[key: string]: any

Properties

clearError()

clearError: () => Promise<void>;

clearError: () => Promise<void>;

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

Clear the error state and trigger a refetch of the query

Returns

Promise<void>

Promise that resolves when the refetch completes successfully

Throws

Error if the refetch fails

dataUpdatedAt

dataUpdatedAt: number;

dataUpdatedAt: number;

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

Get timestamp of last successful data update (in milliseconds)

errorCount

errorCount: number;

errorCount: number;

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

Get the number of consecutive sync failures. Incremented only when query fails completely (not per retry attempt); reset on success.

fetchStatus

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

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

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

Get current fetch status

isError

isError: boolean;

isError: boolean;

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

Check if the collection is in an error state

isFetching

isFetching: boolean;

isFetching: boolean;

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

Check if query is currently fetching (initial or background)

isLoading

isLoading: boolean;

isLoading: boolean;

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

Check if query is loading for the first time (no data yet)

isRefetching

isRefetching: boolean;

isRefetching: boolean;

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

Check if query is refetching in background (not initial fetch)

lastError

lastError: TError | undefined;

lastError: TError | undefined;

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

Get the last error encountered by the query (if any); reset on success

refetch

refetch: RefetchFn;

refetch: RefetchFn;

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

Manually trigger a refetch of the query

writeBatch()

writeBatch: (callback) => void;

writeBatch: (callback) => void;

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

Execute multiple write operations as a single atomic batch to the synced data store

Parameters

callback

() => void

Returns

void

writeDelete()

writeDelete: (keys) => void;

writeDelete: (keys) => void;

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

Delete one or more items directly from the synced data store without triggering a query refetch or optimistic update

Parameters

keys

TKey | TKey[]

Returns

void

writeInsert()

writeInsert: (data) => void;

writeInsert: (data) => void;

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

Insert one or more items directly into the synced data store without triggering a query refetch or optimistic update

Parameters

data

TInsertInput | TInsertInput[]

Returns

void

writeUpdate()

writeUpdate: (updates) => void;

writeUpdate: (updates) => void;

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

Update one or more items directly in the synced data store without triggering a query refetch or optimistic update

writeUpsert: (data) => void;

writeUpsert: (data) => void;

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

Insert or update one or more items directly in the synced data store without triggering a query refetch or optimistic update