Job | beneath

Type parameters

TRecord = any

Hierarchy

Job

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Job<TRecord>(connection: Connection, jobData: WarehouseJobData): Job<TRecord>

- Defined in Job.ts:19
Type parameters
- TRecord = any
Parameters
- connection: Connection
- jobData: WarehouseJobData
Returns Job<TRecord>

Properties

Optional bytesScanned

bytesScanned: number

Private connection

connection: Connection

Private jobData

jobData: WarehouseJobData

Optional jobID

jobID: string

Optional referencedInstanceIDs

referencedInstanceIDs: string[]

Optional replayCursor

replayCursor: string

Optional resultAvroSchema

resultAvroSchema: string

Optional resultSizeBytes

resultSizeBytes: number

Optional resultSizeRecords

resultSizeRecords: number

status

status: "pending" | "running" | "done"

Methods

Private checkIsNotDry

checkIsNotDry(): void

- Defined in Job.ts:73
Returns void

getCursor

getCursor(opts?: GetCursorOptions): Promise<{ cursor?: Cursor<TRecord>; error?: Error }>

- Defined in Job.ts:41
Parameters
- Optional opts: GetCursorOptions
Returns Promise<{ cursor?: Cursor<TRecord>; error?: Error }>

poll

poll(): Promise<{ error?: Error }>

- Defined in Job.ts:28
Returns Promise<{ error?: Error }>

Private setJobData

setJobData(jobData: WarehouseJobData): void

- Defined in Job.ts:61
Parameters
- jobData: WarehouseJobData
Returns void

Generated using TypeDoc