Class reader.ArrowTableReader (4.10.0)
Stay organized with collections
Save and categorize content based on your preferences.
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()
| 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>> |
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-09-24 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{"lastModified": "Last updated 2024-09-24 UTC."}
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-24 UTC."]]
