Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RecordBatchReader<T>

Type parameters

  • T: {} = any

Hierarchy

  • ReadableInterop<RecordBatch<T>>
    • RecordBatchReader

Index

Accessors

Methods

Accessors

autoDestroy

  • get autoDestroy(): boolean

closed

  • get closed(): boolean

dictionaries

  • get dictionaries(): Map<number, Vector<any>>

footer

  • get footer(): Footer | null

numDictionaries

  • get numDictionaries(): number

numRecordBatches

  • get numRecordBatches(): number

schema

Methods

[Symbol.asyncIterator]

  • [Symbol.asyncIterator](): AsyncIterableIterator<RecordBatch<T>>

[Symbol.iterator]

  • [Symbol.iterator](): IterableIterator<RecordBatch<T>>

cancel

  • cancel(): void | Promise<void>

isAsync

  • isAsync(): this is AsyncRecordBatchReaders<T>

isFile

  • isFile(): this is RecordBatchFileReaders<T>

isStream

  • isStream(): this is RecordBatchStreamReaders<T>

isSync

  • isSync(): this is RecordBatchReaders<T>

next

  • next(): IteratorReturnResult<any> | IteratorYieldResult<RecordBatch<T>> | Promise<IteratorResult<RecordBatch<T>, any>>

  • Returns IteratorReturnResult<any> | IteratorYieldResult<RecordBatch<T>> | Promise<IteratorResult<RecordBatch<T>, any>>

open

  • open(options?: OpenOptions): this | Promise<this>

pipe

  • pipe<R>(writable: R, options?: undefined | { end?: undefined | false | true }): R

  • Type parameters

    • R: WritableStream

    Parameters

    • writable: R
    • Optional options: undefined | { end?: undefined | false | true }

    Returns R

pipeThrough

  • pipeThrough<R>(duplex: { readable: R; writable: WritableStream<RecordBatch<T>> }, options?: PipeOptions): ReadableStream<any>

  • Type parameters

    • R: ReadableStream<any>

    Parameters

    • duplex: { readable: R; writable: WritableStream<RecordBatch<T>> }
      • readable: R
      • writable: WritableStream<RecordBatch<T>>
    • Optional options: PipeOptions

    Returns ReadableStream<any>

pipeTo

  • pipeTo(writable: WritableStream<RecordBatch<T>>, options?: PipeOptions): Promise<void>

  • Parameters

    • writable: WritableStream<RecordBatch<T>>
    • Optional options: PipeOptions

    Returns Promise<void>

readRecordBatch

  • readRecordBatch(index: number): RecordBatch<T> | null | Promise<RecordBatch<T> | null>

  • Parameters

    • index: number

    Returns RecordBatch<T> | null | Promise<RecordBatch<T> | null>

reset

  • reset(schema?: Schema<T> | null): this

return

  • return(value?: any): IteratorReturnResult<any> | IteratorYieldResult<any> | Promise<IteratorResult<any, any>>

  • Parameters

    • Optional value: any

    Returns IteratorReturnResult<any> | IteratorYieldResult<any> | Promise<IteratorResult<any, any>>

tee

  • tee(): [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]

  • Returns [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]

throw

  • throw(value?: any): IteratorReturnResult<any> | IteratorYieldResult<any> | Promise<IteratorResult<any, any>>

  • Parameters

    • Optional value: any

    Returns IteratorReturnResult<any> | IteratorYieldResult<any> | Promise<IteratorResult<any, any>>

toDOMStream

  • toDOMStream(): ReadableStream<RecordBatch<T>>

  • Returns ReadableStream<RecordBatch<T>>

toNodeStream

  • toNodeStream(): Readable

Static from

  • from<T>(source: T): T
  • from<T>(source: FromArg0): RecordBatchStreamReader<T>
  • from<T>(source: FromArg1): Promise<RecordBatchStreamReader<T>>
  • from<T>(source: FromArg2): RecordBatchFileReader<T> | RecordBatchStreamReader<T>
  • from<T>(source: FromArg3): Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
  • from<T>(source: FromArg4): Promise<RecordBatchFileReader<T> | AsyncRecordBatchReaders<T>>
  • from<T>(source: FromArg5): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
  • nocollapse

    Type parameters

    Parameters

    • source: T

    Returns T

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg0

    Returns RecordBatchStreamReader<T>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg1

    Returns Promise<RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg2

    Returns RecordBatchFileReader<T> | RecordBatchStreamReader<T>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg3

    Returns Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg4

    Returns Promise<RecordBatchFileReader<T> | AsyncRecordBatchReaders<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg5

    Returns Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

Static readAll

  • readAll<T>(source: T): T extends RecordBatchReaders ? IterableIterator<T> : AsyncIterableIterator<T>
  • readAll<T>(source: FromArg0): IterableIterator<RecordBatchStreamReader<T>>
  • readAll<T>(source: FromArg1): AsyncIterableIterator<RecordBatchStreamReader<T>>
  • readAll<T>(source: FromArg2): IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
  • readAll<T>(source: FromArg3): AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
  • readAll<T>(source: FromArg4): AsyncIterableIterator<RecordBatchFileReader<T> | AsyncRecordBatchReaders<T>>
  • readAll<T>(source: FromArg5): AsyncIterableIterator<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
  • nocollapse

    Type parameters

    Parameters

    • source: T

    Returns T extends RecordBatchReaders ? IterableIterator<T> : AsyncIterableIterator<T>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg0

    Returns IterableIterator<RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg1

    Returns AsyncIterableIterator<RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg2

    Returns IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg3

    Returns AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg4

    Returns AsyncIterableIterator<RecordBatchFileReader<T> | AsyncRecordBatchReaders<T>>

  • nocollapse

    Type parameters

    • T: {} = any

    Parameters

    • source: FromArg5

    Returns AsyncIterableIterator<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

Static throughDOM

  • throughDOM<T>(writableStrategy?: ByteLengthQueuingStrategy, readableStrategy?: undefined | { autoDestroy: boolean }): { readable: ReadableStream<RecordBatch<T>>; writable: WritableStream<Uint8Array> }
  • nocollapse

    Type parameters

    • T: {}

    Parameters

    • Optional writableStrategy: ByteLengthQueuingStrategy
    • Optional readableStrategy: undefined | { autoDestroy: boolean }

    Returns { readable: ReadableStream<RecordBatch<T>>; writable: WritableStream<Uint8Array> }

    • readable: ReadableStream<RecordBatch<T>>
    • writable: WritableStream<Uint8Array>

Static throughNode

  • throughNode(options?: DuplexOptions & { autoDestroy: boolean }): Duplex
  • nocollapse

    Parameters

    • Optional options: DuplexOptions & { autoDestroy: boolean }

    Returns Duplex

Generated using TypeDoc