类 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<any>>

    返回 Map<number, Vector<any>>

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
    • 可选options: { end?: boolean }

    返回 R

pipeThrough

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

    类型参数

    • R extends ReadableStream<any>

    参数

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

    返回 ReadableStream<any>

pipeTo

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

    参数

    • writable: WritableStream<RecordBatch<T>>
    • 可选options: 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

    参数

    • 可选schema：null | Schema<T>

    返回 this

return

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

    参数

    • 可选value：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>>

    参数

    • 可选value：any

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

toDOMStream

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

    返回 ReadableStream<RecordBatch<T>>

toNodeStream

  • toNodeStream(): Readable

    返回 Readable

静态from

  • from<T extends RecordBatchReader<any>>(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

    Returns (返回) Promise (承诺)<RecordBatchStreamReader (记录批流读取器)<T>>

  • from (从)<T extends TypeMap (类型映射) = any (任何)>(
        source (来源): FromArg2,
    ): RecordBatchFileReader (记录批文件读取器)<T> | RecordBatchStreamReader (记录批流读取器)<T>

    类型参数

    • T extends TypeMap (类型映射) = any (任何)

    参数

    • source (来源): FromArg2

    Returns (返回) RecordBatchFileReader (记录批文件读取器)<T> | RecordBatchStreamReader (记录批流读取器)<T>

  • from (从)<T extends TypeMap (类型映射) = any (任何)>(
        source (来源): FromArg3,
    ): Promise (承诺)<RecordBatchFileReader (记录批文件读取器)<T> | RecordBatchStreamReader (记录批流读取器)<T>>

    类型参数

    • T extends TypeMap (类型映射) = any (任何)

    参数

    • source (来源): FromArg3

    Returns (返回) Promise (承诺)<RecordBatchFileReader (记录批文件读取器)<T> | RecordBatchStreamReader (记录批流读取器)<T>>

  • from (从)<T extends TypeMap (类型映射) = any (任何)>(
        source (来源): FromArg4,
    ): Promise (承诺)<AsyncRecordBatchFileReader (异步记录批文件读取器)<T> | AsyncRecordBatchStreamReader (异步记录批流读取器)<T>>

    类型参数

    • T extends TypeMap (类型映射) = any (任何)

    参数

    • source (来源): FromArg4

    Returns (返回) Promise (承诺)<AsyncRecordBatchFileReader (异步记录批文件读取器)<T> | AsyncRecordBatchStreamReader (异步记录批流读取器)<T>>

  • from (从)<T extends TypeMap (类型映射) = any (任何)>(
        source (来源): FromArg5,
    ): Promise (承诺)<AsyncRecordBatchFileReader (异步记录批文件读取器)<T> | AsyncRecordBatchStreamReader (异步记录批流读取器)<T>>

    类型参数

    • T extends TypeMap (类型映射) = any (任何)

    参数

    • source (来源): FromArg5

    Returns (返回) Promise (承诺)<AsyncRecordBatchFileReader (异步记录批文件读取器)<T> | AsyncRecordBatchStreamReader (异步记录批流读取器)<T>>

Static (静态)readAll (全部读取)

  • readAll (全部读取)<T extends RecordBatchReader (记录批读取器)<any (任何)>>(
        source (来源): T,
    ): T extends RecordBatchReaders (记录批读取器集合)<any (任何)>
        ? IterableIterator (可迭代的迭代器)<T<T>>
        : AsyncIterableIterator (异步可迭代的迭代器)<T>

    类型参数

    参数

    • source (来源): T

    Returns (返回) 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

设置

成员可见性

本页内容

访问器
方法