Type Alias: LoadSubsetOptions

type LoadSubsetOptions = object;

type LoadSubsetOptions = object;

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

Properties

cursor?

optional cursor: CursorExpressions;

optional cursor: CursorExpressions;

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

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;

optional limit: number;

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

The limit of the data to load

offset?

optional offset: number;

optional offset: number;

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

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;

optional orderBy: OrderBy;

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

The order by clause to sort the data

subscription?

optional subscription: Subscription;

optional subscription: Subscription;

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

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>;

optional where: BasicExpression<boolean>;

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

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