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::TableReader Class Reference

An interface for reading columns from Feather files. More...

#include <arrow/ipc/feather.h>

Public Member Functions

 TableReader ()
 
 ~TableReader ()
 
std::string GetDescription () const
 Optional table description. More...
 
bool HasDescription () const
 Return true if the table has a description field populated. More...
 
int version () const
 Return the version number of the Feather file. More...
 
int64_t num_rows () const
 Return the number of rows in the file. More...
 
int64_t num_columns () const
 Return the number of columns in the file. More...
 
std::string GetColumnName (int i) const
 
Status GetColumn (int i, std::shared_ptr< Column > *out)
 Read a column from the file as an arrow::Column. More...
 

Static Public Member Functions

static Status Open (const std::shared_ptr< io::RandomAccessFile > &source, std::unique_ptr< TableReader > *out)
 Open a Feather file from a RandomAccessFile interface. More...
 

Detailed Description

An interface for reading columns from Feather files.

Constructor & Destructor Documentation

◆ TableReader()

arrow::ipc::feather::TableReader::TableReader ( )

◆ ~TableReader()

arrow::ipc::feather::TableReader::~TableReader ( )

Member Function Documentation

◆ GetColumn()

Status arrow::ipc::feather::TableReader::GetColumn ( int  i,
std::shared_ptr< Column > *  out 
)

Read a column from the file as an arrow::Column.

Parameters
[in]ithe column index to read
[out]outthe returned column
Returns
Status

This function is zero-copy if the file source supports zero-copy reads

◆ GetColumnName()

std::string arrow::ipc::feather::TableReader::GetColumnName ( int  i) const

◆ GetDescription()

std::string arrow::ipc::feather::TableReader::GetDescription ( ) const

Optional table description.

This does not return a const std::string& because a string has to be copied from the flatbuffer to be able to return a non-flatbuffer type

◆ HasDescription()

bool arrow::ipc::feather::TableReader::HasDescription ( ) const

Return true if the table has a description field populated.

◆ num_columns()

int64_t arrow::ipc::feather::TableReader::num_columns ( ) const

Return the number of columns in the file.

◆ num_rows()

int64_t arrow::ipc::feather::TableReader::num_rows ( ) const

Return the number of rows in the file.

◆ Open()

static Status arrow::ipc::feather::TableReader::Open ( const std::shared_ptr< io::RandomAccessFile > &  source,
std::unique_ptr< TableReader > *  out 
)
static

Open a Feather file from a RandomAccessFile interface.

Parameters
[in]sourcea RandomAccessFile instance
[out]outthe table reader

◆ version()

int arrow::ipc::feather::TableReader::version ( ) const

Return the version number of the Feather file.


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