Interface ColumnarBatchToResultPagesOptionsExperimental

Explicit page shape for columnarBatchToResultPages.

The ceiling bounds each page rather than the traversal: a caller streaming a million-row batch holds one page at a time, so the retained cost is the page, not the batch. limit bounds how much of the batch is walked at all.

interface ColumnarBatchToResultPagesOptions {
    limit?: number;
    limits?: GeoArrowConversionLimits;
    maxFeatures: number;
    offset?: number;
    pageSize?: number;
    signal?: AbortSignal;
    telemetry?: ColumnarTelemetry;
}

Hierarchy (view full)

Properties

limit?: number

Rows to walk from offset. Defaults to the rest of the batch.

Structural limits forwarded to batch inspection, performed once.

maxFeatures: number

Hard ceiling on the features one page may carry. Required, and pageSize may not exceed it.

offset?: number

Zero-based first row of the traversal. Defaults to the start of the batch.

pageSize?: number

Rows per page. Defaults to maxFeatures. The final page may be shorter.

signal?: AbortSignal

Cooperative cancellation. Checked before each page and every 1,024 rows within a page; the traversal yields to the host task queue between pages so an abort raised by a task — a worker message, a timer, a user gesture — is actually delivered rather than starved by an uninterrupted loop.

telemetry?: ColumnarTelemetry

Optional observer. Off by default: no surface constructs one, and with no sink the observed path costs exactly what it costs without this module.