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

The combination of a field name and data type, with optional metadata. More...

#include <arrow/type.h>

Public Member Functions

 Field (const std::string &name, const std::shared_ptr< DataType > &type, bool nullable=true, const std::shared_ptr< const KeyValueMetadata > &metadata=NULLPTR)
 
std::shared_ptr< const KeyValueMetadatametadata () const
 
bool HasMetadata () const
 
std::shared_ptr< FieldAddMetadata (const std::shared_ptr< const KeyValueMetadata > &metadata) const
 
std::shared_ptr< FieldRemoveMetadata () const
 
std::vector< std::shared_ptr< Field > > Flatten () const
 
bool Equals (const Field &other) const
 
bool Equals (const std::shared_ptr< Field > &other) const
 
std::string ToString () const
 
const std::string & name () const
 
std::shared_ptr< DataTypetype () const
 
bool nullable () const
 

Detailed Description

The combination of a field name and data type, with optional metadata.

Fields are used to describe the individual constituents of a nested DataType or a Schema.

A field's metadata is represented by a KeyValueMetadata instance, which holds arbitrary key-value pairs.

Constructor & Destructor Documentation

◆ Field()

arrow::Field::Field ( const std::string &  name,
const std::shared_ptr< DataType > &  type,
bool  nullable = true,
const std::shared_ptr< const KeyValueMetadata > &  metadata = NULLPTR 
)
inline

Member Function Documentation

◆ AddMetadata()

std::shared_ptr<Field> arrow::Field::AddMetadata ( const std::shared_ptr< const KeyValueMetadata > &  metadata) const

◆ Equals() [1/2]

bool arrow::Field::Equals ( const Field other) const

◆ Equals() [2/2]

bool arrow::Field::Equals ( const std::shared_ptr< Field > &  other) const

◆ Flatten()

std::vector<std::shared_ptr<Field> > arrow::Field::Flatten ( ) const

◆ HasMetadata()

bool arrow::Field::HasMetadata ( ) const

◆ metadata()

std::shared_ptr<const KeyValueMetadata> arrow::Field::metadata ( ) const
inline

◆ name()

const std::string& arrow::Field::name ( ) const
inline

◆ nullable()

bool arrow::Field::nullable ( ) const
inline

◆ RemoveMetadata()

std::shared_ptr<Field> arrow::Field::RemoveMetadata ( ) const

◆ ToString()

std::string arrow::Field::ToString ( ) const

◆ type()

std::shared_ptr<DataType> arrow::Field::type ( ) const
inline

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