LoadSubsetOptions

type LoadSubsetOptions = object;

Defined in: packages/db/src/types.ts:338

Immutable request data. From submission onward, callers and adapters must not mutate these options, their expression trees, comparison options, or constant payloads (including Dates, byte arrays, and membership arrays). Create new request data to change a demand; core does not clone or freeze it. Use stable data properties, not stateful getters, for request data. Signal and subscription references stay fixed, but their lifecycle remains live: aborting the signal or releasing the subscription is supported.

An ordered request with orderBy serves a prefix: every matching row from the start of the order through its boundary, the leading order value of the last row the request returned, ties included. A request that returned no rows served no prefix. The ordered loader treats every row in a served prefix as loaded. See LoadSubsetFn for what a sync adapter owes after it refetches.

Properties#

cursor?#

optional cursor: CursorExpressions;

Defined in: packages/db/src/types.ts:356

Cursor expressions for cursor-based pagination. These are separate from where - the sync layer should combine them if using cursor-based pagination. Neither expression includes the main where clause.

limit?#

optional limit: number;

Defined in: packages/db/src/types.ts:350

The limit of the data to load

offset?#

optional offset: number;

Defined in: packages/db/src/types.ts:361

Row offset for offset-based pagination. The sync layer can use this instead of cursor if it prefers offset-based pagination.

orderBy?#

optional orderBy: OrderBy;

Defined in: packages/db/src/types.ts:348

The order by clause to sort the data

refetch?#

optional refetch: boolean;

Defined in: packages/db/src/types.ts:344

Revalidate this exact semantic demand even when an adapter has already completed or cached it. This controls the acquisition attempt; it does not change demand identity or the matching unload operation.

signal?#

optional signal: AbortSignal;

Defined in: packages/db/src/types.ts:369

Aborted when this exact subset request is no longer current. Cancellation is cooperative: async adapters should stop before installing more request-scoped rows. If an in-flight baseline cannot be canceled, the returned load promise must settle after those writes become visible so core can keep overlapping replay private until then.

subscription?#

optional subscription: Subscription;

Defined in: packages/db/src/types.ts:378

The subscription that triggered the load. Advanced sync implementations can use this for:

• LRU caching keyed by subscription
• Reference counting to track active subscriptions
• Subscribing to subscription events (e.g., finalization/unsubscribe)

Optional#

Available when called from CollectionSubscription, may be undefined for direct calls

where?#

optional where: BasicExpression<boolean>;

Defined in: packages/db/src/types.ts:346

The where expression to filter the data (does NOT include cursor expressions)