Type Alias: LoadSubsetOptions#
type LoadSubsetOptions = object;
Defined in: packages/db/src/types.ts:287
Properties#
cursor?#
optional cursor: CursorExpressions;
Defined in: packages/db/src/types.ts:299
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:293
The limit of the data to load
offset?#
optional offset: number;
Defined in: packages/db/src/types.ts:304
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:291
The order by clause to sort the data
subscription?#
optional subscription: Subscription;
Defined in: packages/db/src/types.ts:313
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:289
The where expression to filter the data (does NOT include cursor expressions)