Class PaginationHandler

PaginationHandler manages the pagination of large query results

Index

Constructors

Properties

Methods

executeCurrentPage exit getCurrentPageDisplay getState getTotalPages handleInput isActive showNavigationHint start prepareQuery shouldPaginate

Constructors

constructor

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

Properties

`Private`ctx

ctx: PaginationContext

`Private`state

state: PaginationState = ...

Methods

executeCurrentPage

executeCurrentPage(): Promise<void>
Execute the paginated query for the current page

Returns Promise<void>
- Defined in packages/duckdb-terminal/src/pagination.ts:128

exit

exit(): void
Exit pagination mode

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

getCurrentPageDisplay

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

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

getState

getState(): Readonly<PaginationState>
Get current state

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

getTotalPages

getTotalPages(): number
Get the total number of pages

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

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:163

isActive

isActive(): boolean
Check if pagination is currently active

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

showNavigationHint

showNavigationHint(): void
Show navigation hint

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

start

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

`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:254

`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 (0 = disabled)
Returns boolean
Whether pagination should be enabled
- Defined in packages/duckdb-terminal/src/pagination.ts:237