Class KeysetSource

A source backed by an entity + ad-hoc filter, paginated strictly via keyset.

Implements

IRecordSetSource

Index

Constructors

Methods

Describe NextBatch

Constructors

constructor

new KeysetSource(entityName: string, filter?: string): KeysetSource
Parameters
- entityName: string
  The target entity name (must have a single orderable PK).
- Optionalfilter: string
  Optional WHERE clause (no leading WHERE).
Returns KeysetSource
- Defined in RecordSetProcessor/base/src/sources/keysetSource.ts:21

Methods

Describe

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

Returns SourceDescriptor
Implementation of IRecordSetSource.Describe
- Defined in RecordSetProcessor/base/src/sources/keysetSource.ts:23

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.
Implementation of IRecordSetSource.NextBatch
- Defined in RecordSetProcessor/base/src/sources/keysetSource.ts:43