類別 RecordBatchReader<T>

類型參數

  • T extends TypeMap = any

階層架構

  • ReadableInterop<RecordBatch<T>>
    • RecordBatchReader

存取器

autoDestroy closed dictionaries footer numDictionaries numRecordBatches schema

方法

[asyncIterator] [iterator] cancel isAsync isFile isStream isSync next open pipe pipeThrough pipeTo readRecordBatch reset return tee throw toDOMStream toNodeStream from readAll throughDOM throughNode

存取器

autoDestroy

  • get autoDestroy(): boolean

  • 回傳 boolean

closed

  • get closed(): boolean

  • 回傳 boolean

dictionaries

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

  • 回傳 Map<number, Vector>

footer

  • 回傳 null | Footer_

numDictionaries

  • get numDictionaries(): number

  • 回傳 number

numRecordBatches

  • get numRecordBatches(): number

  • 回傳 number

schema

  • get schema(): Schema<T>

  • 回傳 Schema<T>

方法

[asyncIterator]

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

  • 回傳 AsyncIterableIterator<RecordBatch<T>>

[iterator]

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

  • 回傳 IterableIterator<RecordBatch<T>>

cancel

  • cancel(): void | Promise<void>

  • 回傳 void | Promise<void>

isAsync

  • isAsync(): this is AsyncRecordBatchReaders<T>

  • 回傳 this is AsyncRecordBatchReaders<T>

isFile

  • isFile(): this is RecordBatchFileReaders<T>

  • 回傳 this is RecordBatchFileReaders<T>

isStream

  • isStream(): this is RecordBatchStreamReaders<T>

  • 回傳 this is RecordBatchStreamReaders<T>

isSync

  • isSync(): this is RecordBatchReaders<T>

  • 回傳 this is RecordBatchReaders<T>

next

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

  • 回傳 Promise<any> | IteratorResult<RecordBatch<T>, any>

open

pipe

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

  • 類型參數

    • R extends WritableStream

    參數

    • writable: R
    • Optionaloptions: { end?: boolean }

    回傳 R

pipeThrough

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

  • 類型參數

    • R extends ReadableStream

    參數

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

    回傳 ReadableStream

pipeTo

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

  • 參數

    • writable: WritableStream<RecordBatch<T>>
    • Optionaloptions: StreamPipeOptions

    回傳 Promise<void>

readRecordBatch

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

  • 參數

    • index: number

    回傳 null | RecordBatch<T> | Promise<null | RecordBatch<T>>

reset

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

  • 參數

    • Optionalschema: null | Schema<T>

    回傳 this

return

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

  • 參數

    • Optionalvalue: any

    回傳 IteratorResult<any, any> | Promise<IteratorResult<any, any>>

tee

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

  • 回傳 [ReadableStream<RecordBatch<T>>, ReadableStream<RecordBatch<T>>]

throw

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

  • 參數

    • Optionalvalue: any

    回傳 IteratorResult<any, any> | Promise<IteratorResult<any, any>>

toDOMStream

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

  • 回傳 ReadableStream<RecordBatch<T>>

toNodeStream

  • toNodeStream(): Readable

  • 回傳 Readable

Staticfrom

  • from<T extends RecordBatchReader>(source: T): T

  • 類型參數

    參數

    • source: T

    回傳 T

  • from<T extends TypeMap = any>(source: ArrowJSONLike): RecordBatchStreamReader<T>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: ArrowJSONLike

    返回 RecordBatchStreamReader<T>

  • from<T extends TypeMap = any>(
        source: FromArg1,
    ): Promise<RecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg1

    返回 Promise<RecordBatchStreamReader<T>>

  • from<T extends TypeMap = any>(
        source: FromArg2,
    ): RecordBatchFileReader<T> | RecordBatchStreamReader<T>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg2

    返回 RecordBatchFileReader<T> | RecordBatchStreamReader<T>

  • from<T extends TypeMap = any>(
        source: FromArg3,
    ): Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg3

    返回 Promise<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • from<T extends TypeMap = any>(
        source: FromArg4,
    ): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg4

    返回 Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

  • from<T extends TypeMap = any>(
        source: FromArg5,
    ): Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg5

    返回 Promise<AsyncRecordBatchFileReader<T> | AsyncRecordBatchStreamReader<T>>

StaticreadAll

  • readAll<T extends RecordBatchReader>(
        source: T,
    ): T extends RecordBatchReaders<any>
        ? IterableIterator<T<T>>
        : AsyncIterableIterator<T>

  • 類型參數

    參數

    • source: T

    返回 T extends RecordBatchReaders<any>
        ? IterableIterator<T<T>>
        : AsyncIterableIterator<T>

  • readAll<T extends TypeMap = any>(
        source: ArrowJSONLike,
    ): IterableIterator<RecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: ArrowJSONLike

    返回 IterableIterator<RecordBatchStreamReader<T>>

  • readAll<T extends TypeMap = any>(
        source: FromArg1,
    ): AsyncIterableIterator<RecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg1

    返回 AsyncIterableIterator<RecordBatchStreamReader<T>>

  • readAll<T extends TypeMap = any>(
        source: FromArg2,
    ): IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg2

    返回 IterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • readAll<T extends TypeMap = any>(
        source: FromArg3,
    ): AsyncIterableIterator<
        RecordBatchFileReader<T>
        | RecordBatchStreamReader<T>,
    >

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg3

    返回 AsyncIterableIterator<RecordBatchFileReader<T> | RecordBatchStreamReader<T>>

  • readAll<T extends TypeMap = any>(
        source: FromArg4,
    ): AsyncIterableIterator<AsyncRecordBatchReaders<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg4

    返回 AsyncIterableIterator<AsyncRecordBatchReaders<T>>

  • readAll<T extends TypeMap = any>(
        source: FromArg5,
    ): AsyncIterableIterator<AsyncRecordBatchReaders<T>>

  • 類型參數

    • 類型參數 T extends TypeMap = any

    參數

    • source: FromArg5

    返回 AsyncIterableIterator<AsyncRecordBatchReaders<T>>

StaticthroughDOM

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

  • 類型參數

    • 類型參數 T extends TypeMap

    參數

    • OptionalwritableStrategy: ByteLengthQueuingStrategy
    • OptionalreadableStrategy: { autoDestroy: boolean }

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

    Nocollapse

StaticthroughNode

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

  • 參數

    • Optionaloptions: DuplexOptions & { autoDestroy: boolean }

    返回 Duplex

    Nocollapse

設定

成員可見性

本頁面

存取器
方法