Apache Arrow (C++)
A columnar in-memory analytics layer designed to accelerate big data.
Public Member Functions | List of all members
arrow::TableBatchReader Class Reference

Compute a sequence of record batches from a (possibly chunked) Table. More...

#include <arrow/table.h>

Inheritance diagram for arrow::TableBatchReader:
arrow::RecordBatchReader

Public Member Functions

 ~TableBatchReader ()
 
 TableBatchReader (const Table &table)
 Read batches with the maximum possible size. More...
 
std::shared_ptr< Schemaschema () const override
 
Status ReadNext (std::shared_ptr< RecordBatch > *out) override
 Read the next record batch in the stream. More...
 
- Public Member Functions inherited from arrow::RecordBatchReader
virtual ~RecordBatchReader ()
 

Detailed Description

Compute a sequence of record batches from a (possibly chunked) Table.

Constructor & Destructor Documentation

◆ ~TableBatchReader()

arrow::TableBatchReader::~TableBatchReader ( )

◆ TableBatchReader()

arrow::TableBatchReader::TableBatchReader ( const Table table)
explicit

Read batches with the maximum possible size.

Member Function Documentation

◆ ReadNext()

Status arrow::TableBatchReader::ReadNext ( std::shared_ptr< RecordBatch > *  batch)
overridevirtual

Read the next record batch in the stream.

Return null for batch when reaching end of stream

Parameters
[out]batchthe next loaded batch, null at end of stream
Returns
Status

Implements arrow::RecordBatchReader.

◆ schema()

std::shared_ptr<Schema> arrow::TableBatchReader::schema ( ) const
overridevirtual
Returns
the shared schema of the record batches in the stream

Implements arrow::RecordBatchReader.


The documentation for this class was generated from the following file: