Manual Pagination
paginateRecords(entityKey, options?) — Async Generator
The SDK provides an async generator that handles cursor passing automatically:Options
| Option | Type | Description |
|---|---|---|
filter | Filter object | See Filtering |
sort | string | "fieldKey:asc" or "fieldKey:desc" |
pageSize | number | Records per page (max 100, default 25) |
maxPages | number | Stop after N pages |
maxRecords | number | Stop after N records total |
signal | AbortSignal | Cancel iteration on navigation/unmount |
Safety Limits
To prevent unbounded iteration on large entities, usemaxPages and/or maxRecords:
Error Handling During Pagination
paginateRecords and all read methods are allowed during maintenance mode.
Page Size Limits
| Default page size | Max page size |
|---|---|
| 25 | 100 |