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:74

closed

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

dictionaries

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

footer

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

numDictionaries

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

numRecordBatches

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

schema

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

Methods

[asyncIterator]

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

[iterator]

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

cancel

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

isAsync

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

isFile

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

isStream

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

isSync

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

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

open

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

pipe

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

pipeThrough

pipeThrough<R>(duplex, options?): ReadableStream<any>
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>
Inherited from ReadableInterop.pipeThrough
- Defined in io/interfaces.ts:79

pipeTo

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

readRecordBatch

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

reset

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

return

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

tee

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

throw

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

toDOMStream

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

toNodeStream

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

`Static` from

from<T>(source): T
Type Parameters
- T extends RecordBatchReader<any, T>
Parameters
- source: T
Returns T

Nocollapse
- Defined in ipc/reader.ts:145
from<T>(source): RecordBatchStreamReader<T>
Type Parameters
- T extends TypeMap = any
Parameters
- source: ArrowJSONLike
Returns RecordBatchStreamReader<T>

Nocollapse
- Defined in ipc/reader.ts:146
from<T>(source): Promise<RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg1
Returns Promise<RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:147
from<T>(source): RecordBatchFileReader<T> | RecordBatchStreamReader<T>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg2
Returns RecordBatchFileReader<T> | RecordBatchStreamReader<T>

Nocollapse
- Defined in ipc/reader.ts:148
from<T>(source): Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg3
Returns Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:149
from<T>(source): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg4
Returns Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:150
from<T>(source): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg5
Returns Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:151

`Static` readAll

readAll<T>(source): T extends RecordBatchReaders<any>
? IterableIterator<T>
: AsyncIterableIterator<T>
Type Parameters
- T extends RecordBatchReader<any, T>
Parameters
- source: T
Returns T extends RecordBatchReaders<any>
? IterableIterator<T>
: AsyncIterableIterator<T>

Nocollapse
- Defined in ipc/reader.ts:168
readAll<T>(source): IterableIterator<RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: ArrowJSONLike
Returns IterableIterator<RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:169
readAll<T>(source): AsyncIterableIterator<RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg1
Returns AsyncIterableIterator<RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:170
readAll<T>(source): IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg2
Returns IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:171
readAll<T>(source): AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg3
Returns AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

Nocollapse
- Defined in ipc/reader.ts:172
readAll<T>(source): AsyncIterableIterator<AsyncRecordBatchReaders<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg4
Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>

Nocollapse
- Defined in ipc/reader.ts:173
readAll<T>(source): AsyncIterableIterator<AsyncRecordBatchReaders<T>>
Type Parameters
- T extends TypeMap = any
Parameters
- source: FromArg5
Returns AsyncIterableIterator<AsyncRecordBatchReaders<T>>

Nocollapse
- Defined in ipc/reader.ts:174

`Static` throughDOM

throughDOM<T>(writableStrategy?, readableStrategy?): {
readable: ReadableStream<RecordBatch<T>>;
writable: WritableStream<Uint8Array>;
}
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
- Defined in ipc/reader.ts:136

`Static` throughNode

throughNode(options?): Duplex
Parameters
- Optional options: DuplexOptions & {
  autoDestroy: boolean;
  }
Returns Duplex

Nocollapse
- Defined in ipc/reader.ts:132

Class RecordBatchReader<T>

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

`Optional` options: OpenOptions

`Optional` options: {
end?: boolean;
}

`Optional` end?: boolean

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

`Optional` options: StreamPipeOptions

`Optional` options: StreamPipeOptions

`Optional` schema: null | Schema<T>

`Optional` value: any

`Optional` value: any

`Static` from

`Static` readAll

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