beneath-react
Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • TRecord = any

Hierarchy

  • Job

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Type parameters

    • TRecord = any

    Parameters

    • connection: Connection
    • jobData: WarehouseJobData

    Returns Job<TRecord>

Properties

Optional bytesScanned

bytesScanned: number

Private checkIsNotDry

checkIsNotDry: any

Private connection

connection: any

Private jobData

jobData: any

Optional jobID

jobID: string

Optional referencedInstanceIDs

referencedInstanceIDs: string[]

Optional replayCursor

replayCursor: string

Optional resultAvroSchema

resultAvroSchema: string

Optional resultSizeBytes

resultSizeBytes: number

Optional resultSizeRecords

resultSizeRecords: number

Private setJobData

setJobData: any

status

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

Methods

getCursor

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

  • Parameters

    • Optional opts: GetCursorOptions

    Returns Promise<{ cursor?: Cursor<TRecord>; error?: Error }>

poll

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

  • Returns Promise<{ error?: Error }>

Legend

  • Property

Generated using TypeDoc