Apache GraphAr C++ Library
The C++ Library for Apache GraphAr
Classes | Public Member Functions | Static Public Member Functions | List of all members
graphar::WriterOptions Class Reference

Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr. A WriterOptions instance can simultaneously contain options for all three formats (CSV, Parquet, ORC). The actual file format used for writing is determined by the FileType specified in the graph_Info. More...

#include <writer_util.h>

Classes

class  CSVOptionBuilder
 
class  ORCOptionBuilder
 
class  ParquetOptionBuilder
 

Public Member Functions

 WriterOptions (std::shared_ptr< CSVOption > csv, std::shared_ptr< ParquetOption > parquet, std::shared_ptr< ORCOption > orc)
 
void setCsvOption (std::shared_ptr< CSVOption > csv_option)
 
void setParquetOption (std::shared_ptr< ParquetOption > parquet_option)
 
void setOrcOption (std::shared_ptr< ORCOption > orc_option)
 
arrow::csv::WriteOptions getCsvOption () const
 
std::shared_ptr< parquet::WriterProperties > getParquetWriterProperties () const
 
std::shared_ptr< parquet::ArrowWriterProperties > getArrowWriterProperties () const
 

Static Public Member Functions

static std::shared_ptr< WriterOptions > DefaultWriterOption ()
 

Detailed Description

Provides configuration options for different file format writers (CSV, Parquet, ORC) in GraphAr. A WriterOptions instance can simultaneously contain options for all three formats (CSV, Parquet, ORC). The actual file format used for writing is determined by the FileType specified in the graph_Info.

The configuration parameters and their default values are aligned with those in Arrow.

CSVOptionBuilder, ParquetOptionBuilder, and ORCOptionBuilder are used to construct format-specific options for CSV, Parquet, and ORC, respectively. An existing WriterOptions instance can be passed to a builder’s constructor to incrementally add or combine options across different formats. Example: CSVOptionBuilder csvBuilder; auto wopt = csvBuilder.build(); ParquetOptionBuilder parquetBuilder(wopt); wopt = parquetBuilder.build();

Definition at line 59 of file writer_util.h.

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