Class PaginationHandler

PaginationHandler manages the pagination of large query results

Index

Constructors

Properties

Methods

executeCurrentPage exit getCurrentPageDisplay getState getTotalPages handleInput isActive navigateToPage showNavigationHint start createPageQuery prepareQuery shouldPaginate

Constructors

constructor

new PaginationHandler(ctx: PaginationContext): PaginationHandler
Parameters
- ctx: PaginationContext
Returns PaginationHandler
- Defined in packages/duckdb-terminal/src/pagination.ts:99

Properties

`Private`ctx

ctx: PaginationContext

`Private`state

state: PaginationState = ...

Methods

executeCurrentPage

executeCurrentPage(): Promise<QueryResult | null>
Execute the paginated query for the current page

Returns Promise<QueryResult | null>
- Defined in packages/duckdb-terminal/src/pagination.ts:174

exit

exit(): void
Exit pagination mode

Returns void
- Defined in packages/duckdb-terminal/src/pagination.ts:130

getCurrentPageDisplay

getCurrentPageDisplay(): number
Get current page (1-indexed for display)

Returns number
- Defined in packages/duckdb-terminal/src/pagination.ts:167

getState

getState(): Readonly<PaginationState>
Get current state

Returns Readonly<PaginationState>
- Defined in packages/duckdb-terminal/src/pagination.ts:151

getTotalPages

getTotalPages(): number | null
Get the total number of pages

Returns number | null
- Defined in packages/duckdb-terminal/src/pagination.ts:158

handleInput

handleInput(data: string): Promise<boolean>
Handle user input during pagination
Parameters
- data: string
Returns Promise<boolean>
true if the input was handled, false otherwise
- Defined in packages/duckdb-terminal/src/pagination.ts:247

isActive

isActive(): boolean
Check if pagination is currently active

Returns boolean
- Defined in packages/duckdb-terminal/src/pagination.ts:144

`Private`navigateToPage

navigateToPage(page: number): Promise<void>
Parameters
- page: number
Returns Promise<void>
- Defined in packages/duckdb-terminal/src/pagination.ts:321

showNavigationHint

showNavigationHint(): void
Show navigation hint

Returns void
- Defined in packages/duckdb-terminal/src/pagination.ts:228

start

start(query: string, totalRows: number | null, pageSize: number): void
Initialize pagination for a query
Parameters
- query: string
- totalRows: number | null
- pageSize: number
Returns void
- Defined in packages/duckdb-terminal/src/pagination.ts:106

`Static`createPageQuery

createPageQuery(sql: string, pageSize: number, offset: number): string
Build a bounded page query without modifying the original statement.
Parameters
- sql: string
- pageSize: number
- offset: number
Returns string
- Defined in packages/duckdb-terminal/src/pagination.ts:354

`Static`prepareQuery

prepareQuery(sql: string): string
Strip trailing semicolon from SQL for pagination
Parameters
- sql: string
Returns string
- Defined in packages/duckdb-terminal/src/pagination.ts:362

`Static`shouldPaginate

shouldPaginate(sql: string, rowCount: number, pageSize: number): boolean
Check if a query should use pagination
Parameters
- sql: string
  The SQL query
- rowCount: number
  The total row count
- pageSize: number
  The configured page size
Returns boolean
Whether pagination should be enabled
- Defined in packages/duckdb-terminal/src/pagination.ts:346