Interface RecordBatch

One page of records returned by a source, plus the cursor to fetch the next page.

interface RecordBatch {
    Exhausted: boolean;
    NextCursor: ProcessCursor;
    Records: RecordRef[];
    TotalRowCount?: number;
}

Index

Properties

Exhausted NextCursor Records TotalRowCount?

Properties

Exhausted

Exhausted: boolean

True when this is the final batch — no further records remain.

NextCursor

NextCursor: ProcessCursor

Cursor to pass to the next NextBatch() call.

Records

Records: RecordRef[]

The records in this batch (empty when the source is exhausted).

`Optional`TotalRowCount

TotalRowCount?: number

Total matching rows in the source, when the source knows it (e.g. from RunView.TotalRowCount).