Class RecordBatchReader<T>

Type Parameters

T extends TypeMap = any

Hierarchy

ReadableInterop<RecordBatch<T>>
- RecordBatchReader

Accessors

autoDestroy

get autoDestroy(): boolean
Returns boolean
- Defined in ipc/reader.ts:76

closed

get closed(): boolean
Returns boolean
- Defined in ipc/reader.ts:74

dictionaries

get dictionaries(): Map<number, Vector>
Returns Map<number, Vector>
- Defined in ipc/reader.ts:77

footer

get footer(): null | Footer_
Returns null | Footer_
- Defined in ipc/reader.ts:80

numDictionaries

get numDictionaries(): number
Returns number
- Defined in ipc/reader.ts:78

numRecordBatches

get numRecordBatches(): number
Returns number
- Defined in ipc/reader.ts:79

schema

get schema(): Schema<T>
Returns Schema<T>
- Defined in ipc/reader.ts:75

Methods

[asyncIterator]

"[asyncIterator]"(): AsyncIterableIterator<RecordBatch<T>>
Returns AsyncIterableIterator<RecordBatch<T>>
- Defined in ipc/reader.ts:115

[iterator]

"[iterator]"(): IterableIterator<RecordBatch<T>>
Returns IterableIterator<RecordBatch<T>>
- Defined in ipc/reader.ts:112

cancel

cancel(): void | Promise<void>
Returns void | Promise<void>
- Defined in ipc/reader.ts:96

isAsync

isAsync(): this is AsyncRecordBatchReaders<T>
Returns this is AsyncRecordBatchReaders<T>
- Defined in ipc/reader.ts:83

isFile

isFile(): this is RecordBatchFileReaders<T>
Returns this is RecordBatchFileReaders<T>
- Defined in ipc/reader.ts:84

isStream

isStream(): this is RecordBatchStreamReaders<T>
Returns this is RecordBatchStreamReaders<T>
- Defined in ipc/reader.ts:85

isSync

isSync(): this is RecordBatchReaders<T>
Returns this is RecordBatchReaders<T>
- Defined in ipc/reader.ts:82

next(): Promise<any> | IteratorResult<RecordBatch<T>, any>
Returns Promise<any> | IteratorResult<RecordBatch<T>, any>
- Defined in ipc/reader.ts:87

open

open(
options?: OpenOptions,
): RecordBatchReader<T> | Promise<RecordBatchReader<T>>
Parameters
- Optionaloptions: OpenOptions
Returns RecordBatchReader<T> | Promise<RecordBatchReader<T>>
- Defined in ipc/reader.ts:105

pipe

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

pipeThrough

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

pipeTo

pipeTo(
writable: WritableStream<RecordBatch<T>>,
options?: StreamPipeOptions,
): Promise<void>
Parameters
- writable: WritableStream<RecordBatch<T>>
- Optionaloptions: StreamPipeOptions
Returns Promise<void>
Inherited from ReadableInterop.pipeTo
- Defined in io/interfaces.ts:79

readRecordBatch

readRecordBatch(
index: number,
): null | RecordBatch<T> | Promise<null | RecordBatch<T>>
Parameters
- index: number
Returns null | RecordBatch<T> | Promise<null | RecordBatch<T>>
- Defined in ipc/reader.ts:109

reset

reset(schema?: null | Schema<T>): this
Parameters
- Optionalschema: null | Schema<T>
Returns this
- Defined in ipc/reader.ts:99

return

return(
value?: any,
): IteratorResult<any, any> | Promise<IteratorResult<any, any>>
Parameters
- Optionalvalue: any
Returns IteratorResult<any, any> | Promise<IteratorResult<any, any>>
- Defined in ipc/reader.ts:93

tee

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

throw

throw(value?: any): IteratorResult<any, any> | Promise<IteratorResult<any, any>>
Parameters
- Optionalvalue: any
Returns IteratorResult<any, any> | Promise<IteratorResult<any, any>>
- Defined in ipc/reader.ts:90

toDOMStream

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

toNodeStream

toNodeStream(): Readable
Returns Readable
Overrides ReadableInterop.toNodeStream
- Defined in ipc/reader.ts:124

`Static`from

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

`Static`readAll

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

`Static`throughDOM

throughDOM<T extends TypeMap>(
    writableStrategy?: ByteLengthQueuingStrategy,
    readableStrategy?: { autoDestroy: boolean },
): {
    readable: ReadableStream<RecordBatch<T>>;
    writable: WritableStream<Uint8Array>;
}
Type Parameters
- T extends TypeMap
Parameters
- OptionalwritableStrategy: ByteLengthQueuingStrategy
- OptionalreadableStrategy: { autoDestroy: boolean }
Returns {
readable: ReadableStream<RecordBatch<T>>;
writable: WritableStream<Uint8Array>;
}
Nocollapse
- Defined in ipc/reader.ts:138

`Static`throughNode

throughNode(options?: DuplexOptions & { autoDestroy: boolean }): Duplex
Parameters
- Optionaloptions: DuplexOptions & { autoDestroy: boolean }
Returns Duplex
Nocollapse
- Defined in ipc/reader.ts:134

Class RecordBatchReader<T>

Type Parameters

Hierarchy

Index

Accessors

Methods

Accessors

autoDestroy

Returns boolean

closed

Returns boolean

dictionaries

Returns Map<number, Vector>

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 Promise<any> | IteratorResult<RecordBatch<T>, any>

open

Parameters

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

pipe

Type Parameters

Parameters

Returns R

pipeThrough

Type Parameters

Parameters

Returns ReadableStream

pipeTo

Parameters

Returns Promise<void>

readRecordBatch

Parameters

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

reset

Parameters

Returns this

return

Parameters

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

tee

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

throw

Parameters

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

toDOMStream

Returns ReadableStream<RecordBatch<T>>

toNodeStream

Returns Readable

Staticfrom

Type Parameters

Parameters

Returns T

Type Parameters

Parameters

Returns RecordBatchStreamReader<T>

Type Parameters

Parameters

Returns Promise<RecordBatchStreamReader<T>>

`Static`from

`Static`readAll

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

`Static`throughDOM

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

`Static`throughNode