Class reader.ArrowTableReader (5.1.1)

A BigQuery Storage API Reader that can be used to read data from BigQuery Tables using the Storage API in Arrow format.

reader

Package

@google-cloud/bigquery-storage

Constructors

(constructor)(readClient, tableRef)

constructor(readClient: ReadClient, tableRef: TableReference);

Creates a new ArrowTableReader instance. Usually created via ReadClient.createArrowTableReader().

Parameters
Name Description
readClient ReadClient

Storage Read Client.
tableRef TableReference

Methods

close()

close(): void;
Returns
Type Description
void

getRecordBatchStream(options)

getRecordBatchStream(options?: GetStreamOptions): Promise<ResourceStream<RecordBatch>>;

Get a stream of Arrow RecordBatch objects.

Parameter
Name Description
options GetStreamOptions
Returns
Type Description
Promise<ResourceStream<RecordBatch>>

getSessionInfo()

getSessionInfo(): ReadSessionInfo | undefined | null;
Returns
Type Description
ReadSessionInfo_2 | undefined | null

getStream(options)

getStream(options?: GetStreamOptions): Promise<ResourceStream<Uint8Array>>;

Get a byte stream of Arrow Record Batch.

Parameter
Name Description
options GetStreamOptions
Returns
Type Description
Promise<ResourceStream<Uint8Array>>