RecordBatchReader | Apache Arrow

Type Parameters

T extends TypeMap = any

Hierarchy

ReadableInterop<RecordBatch<T>>
- RecordBatchReader

Accessors

autoDestroy

get autoDestroy(): boolean

- Defined in ipc/reader.ts:74
Returns boolean

closed

get closed(): boolean

- Defined in ipc/reader.ts:72
Returns boolean

dictionaries

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

- Defined in ipc/reader.ts:75
Returns Map<number, Vector<any>>

footer

get footer(): null | Footer_

- Defined in ipc/reader.ts:78
Returns null | Footer_

numDictionaries

get numDictionaries(): number

- Defined in ipc/reader.ts:76
Returns number

numRecordBatches

get numRecordBatches(): number

- Defined in ipc/reader.ts:77
Returns number

schema

get schema(): Schema<T>

- Defined in ipc/reader.ts:73
Returns Schema<T>

Methods

[asyncIterator]

[asyncIterator](): AsyncIterableIterator<RecordBatch<T>>

- Defined in ipc/reader.ts:113
Returns AsyncIterableIterator<RecordBatch<T>>

[iterator]

[iterator](): IterableIterator<RecordBatch<T>>

- Defined in ipc/reader.ts:110
Returns IterableIterator<RecordBatch<T>>

cancel

cancel(): void | Promise<void>

- Defined in ipc/reader.ts:94
Returns void | Promise<void>

isAsync

isAsync(): this is AsyncRecordBatchReaders<T>

- Defined in ipc/reader.ts:81
Returns this is AsyncRecordBatchReaders<T>

isFile

isFile(): this is RecordBatchFileReaders<T>

- Defined in ipc/reader.ts:82
Returns this is RecordBatchFileReaders<T>

isStream

isStream(): this is RecordBatchStreamReaders<T>

- Defined in ipc/reader.ts:83
Returns this is RecordBatchStreamReaders<T>

isSync

isSync(): this is RecordBatchReaders<T>

- Defined in ipc/reader.ts:80
Returns this is RecordBatchReaders<T>

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

- Defined in ipc/reader.ts:85
Returns IteratorResult<RecordBatch<T>, any> | Promise<IteratorResult<RecordBatch<T>, any>>

open

open(options?: OpenOptions): RecordBatchReader<T> | Promise<RecordBatchReader<T>>

- Defined in ipc/reader.ts:103
Parameters
- Optional options: OpenOptions
Returns RecordBatchReader<T> | Promise<RecordBatchReader<T>>

pipe

pipe<R>(writable: R, options?: { end?: boolean }): R

Inherited from ReadableInterop.pipe
- Defined in io/interfaces.ts:75
Type Parameters
- R extends WritableStream<R>
Parameters
- writable: R
- Optional options: { end?: boolean }
  - Optional end?: boolean
Returns R

pipeThrough

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

Inherited from ReadableInterop.pipeThrough
- Defined in io/interfaces.ts:79
Type Parameters
- R extends ReadableStream<any, R>
Parameters
- duplex: { readable: R; writable: WritableStream<RecordBatch<T>> }
  - readable: R
  - writable: WritableStream<RecordBatch<T>>
- Optional options: StreamPipeOptions
Returns ReadableStream<any>

pipeTo

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

Inherited from ReadableInterop.pipeTo
- Defined in io/interfaces.ts:78
Parameters
- writable: WritableStream<RecordBatch<T>>
- Optional options: StreamPipeOptions
Returns Promise<void>

readRecordBatch

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

- Defined in ipc/reader.ts:107
Parameters
- index: number
Returns null | RecordBatch<T> | Promise<null | RecordBatch<T>>

reset

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

- Defined in ipc/reader.ts:97
Parameters
- Optional schema: null | Schema<T>
Returns RecordBatchReader<T>

return

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

- Defined in ipc/reader.ts:91
Parameters
- Optional value: any
Returns IteratorResult<any, any> | Promise<IteratorResult<any, any>>

tee

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

Inherited from ReadableInterop.tee
- Defined in io/interfaces.ts:72
Returns [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]

throw

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

- Defined in ipc/reader.ts:88
Parameters
- Optional value: any
Returns IteratorResult<any, any> | Promise<IteratorResult<any, any>>

toDOMStream

toDOMStream(): ReadableStream<RecordBatch<T>>

Overrides ReadableInterop.toDOMStream
- Defined in ipc/reader.ts:116
Returns ReadableStream<RecordBatch<T>>

toNodeStream

toNodeStream(): Readable

Overrides ReadableInterop.toNodeStream
- Defined in ipc/reader.ts:122
Returns Readable

Static from

from<T>(source: T): T
from<T>(source: ArrowJSONLike): 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<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
from<T>(source: FromArg5): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

- Defined in ipc/reader.ts:145
nocollapse
Type Parameters
- T extends RecordBatchReader<any, T>
Parameters
- source: T
Returns T
- Defined in ipc/reader.ts:146
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: ArrowJSONLike
Returns RecordBatchStreamReader<T>
- Defined in ipc/reader.ts:147
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg1
Returns Promise<RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:148
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg2
Returns RecordBatchFileReader<T> | RecordBatchStreamReader<T>
- Defined in ipc/reader.ts:149
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg3
Returns Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:150
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg4
Returns Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:151
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg5
Returns Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

Static readAll

readAll<T>(source: T): T extends RecordBatchReaders<any> ? IterableIterator<T> : AsyncIterableIterator<T>
readAll<T>(source: ArrowJSONLike): 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<AsyncRecordBatchReaders<T>>
readAll<T>(source: FromArg5): AsyncIterableIterator<AsyncRecordBatchReaders<T>>

- Defined in ipc/reader.ts:168
nocollapse
Type Parameters
- T extends RecordBatchReader<any, T>
Parameters
- source: T
Returns T extends RecordBatchReaders<any> ? IterableIterator<T> : AsyncIterableIterator<T>
- Defined in ipc/reader.ts:169
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: ArrowJSONLike
Returns IterableIterator<RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:170
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg1
Returns AsyncIterableIterator<RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:171
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg2
Returns IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:172
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg3
Returns AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
- Defined in ipc/reader.ts:173
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg4
Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>
- Defined in ipc/reader.ts:174
nocollapse
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg5
Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>

Static throughDOM

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

- Defined in ipc/reader.ts:136
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>

Static throughNode

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

- Defined in ipc/reader.ts:132
nocollapse
Parameters
- Optional options: DuplexOptions & { autoDestroy: boolean }
Returns Duplex

Type Parameters

T extends TypeMap = any

Hierarchy

Index

Accessors

Methods

Accessors

autoDestroy

Returns boolean

closed

Returns boolean

dictionaries

Returns Map<number, Vector<any>>

footer

Returns null | Footer_

numDictionaries

Returns number

numRecordBatches

Returns number

schema

Returns Schema<T>

Methods

[asyncIterator]

Returns AsyncIterableIterator<RecordBatch<T>>

[iterator]

Returns IterableIterator<RecordBatch<T>>

cancel

Returns void | Promise<void>

isAsync

Returns this is AsyncRecordBatchReaders<T>

isFile

Returns this is RecordBatchFileReaders<T>

isStream

Returns this is RecordBatchStreamReaders<T>

isSync

Returns this is RecordBatchReaders<T>

next

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

open

Parameters

Optional options: OpenOptions

Returns RecordBatchReader<T> | Promise<RecordBatchReader<T>>

pipe

Type Parameters

R extends WritableStream<R>

Parameters

writable: R

Optional options: { end?: boolean }

Optional end?: boolean

Returns R

pipeThrough

Type Parameters

R extends ReadableStream<any, R>

Parameters

duplex: { readable: R; writable: WritableStream<RecordBatch<T>> }

readable: R

writable: WritableStream<RecordBatch<T>>

Optional options: StreamPipeOptions

Returns ReadableStream<any>

pipeTo

Parameters

writable: WritableStream<RecordBatch<T>>

Optional options: StreamPipeOptions

Returns Promise<void>

readRecordBatch

Parameters

index: number

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

reset

Parameters

Optional schema: null | Schema<T>

Returns RecordBatchReader<T>

return

Parameters

Optional value: any

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

tee

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

throw

Parameters