Type Alias: LoadSubsetOptions#

type LoadSubsetOptions = object;

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

Request data is immutable from submission onward. Callers and adapters must not mutate options, expression trees, comparison options, or constant payloads such as 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. Signal and subscription references stay fixed, but aborting the signal or releasing the subscription remains supported.

Properties#

cursor?#

optional cursor: CursorExpressions;

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

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:310

The limit of the data to load

offset?#

optional offset: number;

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

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:308

The order by clause to sort the data

signal?#

optional signal: AbortSignal;

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

Aborted when this exact subset request is no longer current. Cancellation is cooperative: async sync adapters must check the signal immediately before installing a baseline or later request-scoped rows.

subscription?#

optional subscription: Subscription;

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

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:306

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