Class RecordBatchReader<T>

Type Parameters

  • T extends TypeMap = any

Hierarchy

  • ReadableInterop<RecordBatch<T>>
    • RecordBatchReader

Accessors

  • get footer(): null | Footer_
  • Returns null | Footer_

Methods

  • Returns AsyncIterableIterator<RecordBatch<T>>

  • Returns IterableIterator<RecordBatch<T>>

  • Returns void | Promise<void>

  • Returns this is AsyncRecordBatchReaders<T>

  • Returns this is RecordBatchFileReaders<T>

  • Returns this is RecordBatchStreamReaders<T>

  • Returns this is RecordBatchReaders<T>

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

  • Type Parameters

    • R extends WritableStream

    Parameters

    • writable: R
    • Optional options: {
          end?: boolean;
      }
      • Optional end?: boolean

    Returns R

  • Type Parameters

    • R extends ReadableStream<any>

    Parameters

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

    Returns ReadableStream<any>

  • Parameters

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

    Returns Promise<void>

  • Parameters

    • index: number

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

  • Parameters

    • Optional value: any

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

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

  • Parameters

    • Optional value: any

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

  • Returns ReadableStream<RecordBatch<T>>

  • Returns Readable

  • Type Parameters

    Parameters

    • source: T

    Returns T

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: ArrowJSONLike

    Returns RecordBatchStreamReader<T>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg1

    Returns Promise<RecordBatchStreamReader<T>>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg2

    Returns RecordBatchFileReader<T> | RecordBatchStreamReader<T>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg3

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

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg4

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

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg5

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

    Nocollapse

  • Type Parameters

    Parameters

    • source: T

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

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: ArrowJSONLike

    Returns IterableIterator<RecordBatchStreamReader<T>>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg1

    Returns AsyncIterableIterator<RecordBatchStreamReader<T>>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg2

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

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg3

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

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg4

    Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>

    Nocollapse

  • Type Parameters

    • T extends TypeMap = any

    Parameters

    • source: FromArg5

    Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>

    Nocollapse

  • Type Parameters

    • T extends TypeMap

    Parameters

    • Optional writableStrategy: ByteLengthQueuingStrategy
    • Optional readableStrategy: {
          autoDestroy: boolean;
      }
      • autoDestroy: boolean

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

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

    Nocollapse

  • Parameters

    • Optional options: DuplexOptions & {
          autoDestroy: boolean;
      }

    Returns Duplex

    Nocollapse

Generated using TypeDoc