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

Creates the Arrow record batch file format. More...

#include <arrow/ipc/writer.h>

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

Public Member Functions

virtual ~RecordBatchFileWriter ()
 
Status WriteRecordBatch (const RecordBatch &batch, bool allow_64bit=false) override
 Write a record batch to the file. More...
 
Status Close () override
 Close the file stream by writing the file footer and magic number. More...
 
- Public Member Functions inherited from arrow::ipc::RecordBatchStreamWriter
virtual ~RecordBatchStreamWriter ()
 
void set_memory_pool (MemoryPool *pool) override
 In some cases, writing may require memory allocation. More...
 
- Public Member Functions inherited from arrow::ipc::RecordBatchWriter
virtual ~RecordBatchWriter ()
 
Status WriteTable (const Table &table)
 Write possibly-chunked table by creating sequence of record batches. More...
 

Static Public Member Functions

static Status Open (io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchWriter > *out)
 Create a new writer from stream sink and schema. More...
 
- Static Public Member Functions inherited from arrow::ipc::RecordBatchStreamWriter
static Status Open (io::OutputStream *sink, const std::shared_ptr< Schema > &schema, std::shared_ptr< RecordBatchWriter > *out)
 Create a new writer from stream sink and schema. More...
 

Additional Inherited Members

- Protected Member Functions inherited from arrow::ipc::RecordBatchStreamWriter
 RecordBatchStreamWriter ()
 
- Protected Attributes inherited from arrow::ipc::RecordBatchStreamWriter
class ARROW_NO_EXPORT RecordBatchStreamWriterImpl
 
std::unique_ptr< RecordBatchStreamWriterImplimpl_
 

Detailed Description

Creates the Arrow record batch file format.

Implements the random access file format, which structurally is a record batch stream followed by a metadata footer at the end of the file. Magic numbers are written at the start and end of the file

Constructor & Destructor Documentation

◆ ~RecordBatchFileWriter()

virtual arrow::ipc::RecordBatchFileWriter::~RecordBatchFileWriter ( )
virtual

Member Function Documentation

◆ Close()

Status arrow::ipc::RecordBatchFileWriter::Close ( )
overridevirtual

Close the file stream by writing the file footer and magic number.

Returns
Status

Reimplemented from arrow::ipc::RecordBatchStreamWriter.

◆ Open()

static Status arrow::ipc::RecordBatchFileWriter::Open ( io::OutputStream sink,
const std::shared_ptr< Schema > &  schema,
std::shared_ptr< RecordBatchWriter > *  out 
)
static

Create a new writer from stream sink and schema.

Parameters
[in]sinkoutput stream to write to
[in]schemathe schema of the record batches to be written
[out]outthe created stream writer
Returns
Status

◆ WriteRecordBatch()

Status arrow::ipc::RecordBatchFileWriter::WriteRecordBatch ( const RecordBatch batch,
bool  allow_64bit = false 
)
overridevirtual

Write a record batch to the file.

Parameters
[in]batchthe record batch to write
[in]allow_64bitallow array lengths over INT32_MAX - 1
Returns
Status

Reimplemented from arrow::ipc::RecordBatchStreamWriter.


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