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::feather::TableWriter Class Reference

Interface for writing Feather files. More...

#include <arrow/ipc/feather.h>

Public Member Functions

 ~TableWriter ()
 
void SetDescription (const std::string &desc)
 Set the description field in the file metadata. More...
 
void SetNumRows (int64_t num_rows)
 Set the number of rows in the file. More...
 
Status Append (const std::string &name, const Array &values)
 Append a column to the file. More...
 
Status Finalize ()
 Finalize the file by writing the file metadata and footer. More...
 

Static Public Member Functions

static Status Open (const std::shared_ptr< io::OutputStream > &stream, std::unique_ptr< TableWriter > *out)
 Create a new TableWriter that writes to an OutputStream. More...
 

Detailed Description

Interface for writing Feather files.

Constructor & Destructor Documentation

◆ ~TableWriter()

arrow::ipc::feather::TableWriter::~TableWriter ( )

Member Function Documentation

◆ Append()

Status arrow::ipc::feather::TableWriter::Append ( const std::string &  name,
const Array values 
)

Append a column to the file.

Parameters
[in]namethe column name
[in]valuesthe column values as a contiguous arrow::Array
Returns
Status

◆ Finalize()

Status arrow::ipc::feather::TableWriter::Finalize ( )

Finalize the file by writing the file metadata and footer.

Returns
Status

◆ Open()

static Status arrow::ipc::feather::TableWriter::Open ( const std::shared_ptr< io::OutputStream > &  stream,
std::unique_ptr< TableWriter > *  out 
)
static

Create a new TableWriter that writes to an OutputStream.

Parameters
[in]streaman output stream
[out]outthe returned table writer
Returns
Status

◆ SetDescription()

void arrow::ipc::feather::TableWriter::SetDescription ( const std::string &  desc)

Set the description field in the file metadata.

◆ SetNumRows()

void arrow::ipc::feather::TableWriter::SetNumRows ( int64_t  num_rows)

Set the number of rows in the file.


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