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

Abstract interface for writing a stream of record batches. More...

#include <arrow/ipc/writer.h>

Inheritance diagram for arrow::ipc::RecordBatchWriter:
arrow::ipc::RecordBatchStreamWriter arrow::ipc::RecordBatchFileWriter

Public Member Functions

virtual ~RecordBatchWriter ()
 
virtual Status WriteRecordBatch (const RecordBatch &batch, bool allow_64bit=false)=0
 Write a record batch to the stream. More...
 
Status WriteTable (const Table &table)
 Write possibly-chunked table by creating sequence of record batches. More...
 
virtual Status Close ()=0
 Perform any logic necessary to finish the stream. More...
 
virtual void set_memory_pool (MemoryPool *pool)=0
 In some cases, writing may require memory allocation. More...
 

Detailed Description

Abstract interface for writing a stream of record batches.

Constructor & Destructor Documentation

◆ ~RecordBatchWriter()

virtual arrow::ipc::RecordBatchWriter::~RecordBatchWriter ( )
virtual

Member Function Documentation

◆ Close()

virtual Status arrow::ipc::RecordBatchWriter::Close ( )
pure virtual

Perform any logic necessary to finish the stream.

Returns
Status

Implemented in arrow::ipc::RecordBatchFileWriter, and arrow::ipc::RecordBatchStreamWriter.

◆ set_memory_pool()

virtual void arrow::ipc::RecordBatchWriter::set_memory_pool ( MemoryPool pool)
pure virtual

In some cases, writing may require memory allocation.

We use the default memory pool, but provide the option to override

Parameters
poolthe memory pool to use for required allocations

Implemented in arrow::ipc::RecordBatchStreamWriter.

◆ WriteRecordBatch()

virtual Status arrow::ipc::RecordBatchWriter::WriteRecordBatch ( const RecordBatch batch,
bool  allow_64bit = false 
)
pure virtual

Write a record batch to the stream.

Parameters
allow_64bitboolean permitting field lengths exceeding INT32_MAX
Returns
Status

Implemented in arrow::ipc::RecordBatchFileWriter, and arrow::ipc::RecordBatchStreamWriter.

◆ WriteTable()

Status arrow::ipc::RecordBatchWriter::WriteTable ( const Table table)

Write possibly-chunked table by creating sequence of record batches.

Parameters
[in]tabletable to write
Returns
Status

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