QueryCollectionUtils

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

Utility methods available on Query Collections for direct writes and manual operations. Direct writes bypass optimistic mutations and write to the synced data store. Direct writes do not trigger a Query refetch. On-demand cache edits are best-effort and do not establish scoped result authority.

Template#

The type of errors that can occur during queries

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

Properties#

dataUpdatedAt#

dataUpdatedAt: number;

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

Get timestamp of last successful data update (in milliseconds)

fetchStatus#

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

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

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.

isFetching#

isFetching: boolean;

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

Check if query is currently fetching (initial or background)

isLoading#

isLoading: boolean;

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

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

isRefetching#

isRefetching: boolean;

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

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

refetch#

refetch: RefetchFn;

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

Manually refetch and await the applicable fetch or application boundary.

writeBatch()#

writeBatch: (callback) => Promise<void>;

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

Execute direct writes as one atomic batch. Resolves when the sync commit applies.

Parameters#

callback#

() => void

Returns#

Promise<void>

writeDelete()#

writeDelete: (keys) => Promise<void>;

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

Delete items without an optimistic update. Resolves when the sync commit applies.

Parameters#

keys#

TKey | TKey[]

Returns#

Promise<void>

writeInsert()#

writeInsert: (data) => Promise<void>;

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

Insert items without an optimistic update. Resolves when the sync commit applies.

Parameters#

data#

TInsertInput | TInsertInput[]

Returns#

Promise<void>

writeUpdate()#

writeUpdate: (updates) => Promise<void>;

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

Update items without an optimistic update. Resolves when the sync commit applies.

Parameters#

updates#

Partial<TItem> | Partial<TItem>[]

Returns#

Promise<void>

writeUpsert()#

writeUpsert: (data) => Promise<void>;

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

Insert or update items without an optimistic update. Resolves when the sync commit applies.

Parameters#

data#

Partial<TItem> | Partial<TItem>[]

Returns#

Promise<void>