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

Abstract interface for reading stream of record batches. More...

#include <arrow/table.h>

Inheritance diagram for arrow::RecordBatchReader:
arrow::ipc::RecordBatchStreamReader arrow::TableBatchReader

Public Member Functions

virtual ~RecordBatchReader ()
 
virtual std::shared_ptr< Schemaschema () const =0
 
virtual Status ReadNext (std::shared_ptr< RecordBatch > *batch)=0
 Read the next record batch in the stream. More...
 

Detailed Description

Abstract interface for reading stream of record batches.

Constructor & Destructor Documentation

◆ ~RecordBatchReader()

virtual arrow::RecordBatchReader::~RecordBatchReader ( )
virtual

Member Function Documentation

◆ ReadNext()

virtual Status arrow::RecordBatchReader::ReadNext ( std::shared_ptr< RecordBatch > *  batch)
pure virtual

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

Implemented in arrow::TableBatchReader, and arrow::ipc::RecordBatchStreamReader.

◆ schema()

virtual std::shared_ptr<Schema> arrow::RecordBatchReader::schema ( ) const
pure virtual
Returns
the shared schema of the record batches in the stream

Implemented in arrow::TableBatchReader, and arrow::ipc::RecordBatchStreamReader.


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