Function paginate

paginate<T = Record<string, unknown>>(
    sql: string,
    bindings?: any[],
    options?: PaginateOptions<T>,
): Promise<PaginatedResult<T>>
Runs a query across all shards and returns a single page plus the total match count.

allAllShardsGlobal already merges, filters, sorts, and slices across shards but discards the pre-slice count. paginate keeps that count so list endpoints can return { results, total, page, limit, pages } for a UI in one call instead of issuing a second COUNT query.

With consistency set, each shard runs its query in one session. The sessions are separate: the page is not a snapshot across shards, and two calls for two pages are not one snapshot either.
Type Parameters
- T = Record<string, unknown>
  Type of the result records
Parameters
- sql: string
  SQL statement to execute on each shard
- bindings: any[] = []
  Parameter values to bind to the SQL statement
- options: PaginateOptions<T> = {}
  Sort/filter options plus page and limit
Returns Promise<PaginatedResult<T>>
The requested page and pagination metadata
Since
1.2.4
Example
```
const { results, total, pages } = await paginate<User>(
  'SELECT * FROM users WHERE username LIKE ?',
  ['%ada%'],
  { page: 2, limit: 25, sortBy: 'created_at', sortDirection: 'desc' }
);
```
- Defined in src/router.ts:5522