Interface IRecordSetSource

SOURCE seam — yields the record set in cursor-paginated batches. Implementations decide their own pagination strategy (offset vs. keyset); the cursor is opaque to the engine and round-tripped through the tracker for resume.

interface IRecordSetSource {
    Describe(): SourceDescriptor;
    NextBatch(
        cursor: ProcessCursor,
        batchSize: number,
        contextUser: UserInfo,
        provider?: IMetadataProvider,
    ): Promise<RecordBatch>;
}

Implemented by

Index

Methods

Describe NextBatch

Methods

Describe

Describe(): SourceDescriptor
Returns a persistable description of this source for the run header.

Returns SourceDescriptor
- Defined in RecordSetProcessor/base/src/interfaces.ts:50

NextBatch

NextBatch(
    cursor: ProcessCursor,
    batchSize: number,
    contextUser: UserInfo,
    provider?: IMetadataProvider,
): Promise<RecordBatch>
Returns the next batch of records after the given cursor.
Parameters
- cursor: ProcessCursor
  The cursor returned by the previous batch, or undefined to start from the beginning.
- batchSize: number
  Maximum number of records to return.
- contextUser: UserInfo
  The acting user (required server-side for permissions).
- Optionalprovider: IMetadataProvider
  Optional metadata provider for entity resolution.
Returns Promise<RecordBatch>
A batch with the records, the next cursor, and an exhausted flag.
- Defined in RecordSetProcessor/base/src/interfaces.ts:47

Interface IRecordSetSource

Implemented by

Index

Methods

Methods

Describe

Returns SourceDescriptor

NextBatch

Parameters

Returns Promise<RecordBatch>

Settings

On This Page