Public Member Functions | Static Public Member Functions | List of all members
cudf::io::orc_writer_options Class Reference

Settings to use for write_orc(). More...

#include <orc.hpp>

Public Member Functions

 orc_writer_options ()=default
 Default constructor. More...
 
sink_info const & get_sink () const
 Returns sink info. More...
 
compression_type get_compression () const
 Returns compression type. More...
 
bool is_enabled_statistics () const
 Whether writing column statistics is enabled/disabled. More...
 
statistics_freq get_statistics_freq () const
 Returns frequency of statistics collection. More...
 
auto get_stripe_size_bytes () const
 Returns maximum stripe size, in bytes. More...
 
auto get_stripe_size_rows () const
 Returns maximum stripe size, in rows. More...
 
auto get_row_index_stride () const
 Returns the row index stride. More...
 
table_view get_table () const
 Returns table to be written to output. More...
 
auto const & get_metadata () const
 Returns associated metadata. More...
 
std::map< std::string, std::string > const & get_key_value_metadata () const
 Returns Key-Value footer metadata information. More...
 
std::shared_ptr< writer_compression_statisticsget_compression_statistics () const
 Returns a shared pointer to the user-provided compression statistics. More...
 
bool get_enable_dictionary_sort () const
 Returns whether string dictionaries should be sorted. More...
 
void set_compression (compression_type comp)
 Sets compression type. More...
 
void enable_statistics (statistics_freq val)
 Choose granularity of statistics collection. More...
 
void set_stripe_size_bytes (size_t size_bytes)
 Sets the maximum stripe size, in bytes. More...
 
void set_stripe_size_rows (size_type size_rows)
 Sets the maximum stripe size, in rows. More...
 
void set_row_index_stride (size_type stride)
 Sets the row index stride. More...
 
void set_table (table_view tbl)
 Sets table to be written to output. More...
 
void set_metadata (table_input_metadata meta)
 Sets associated metadata. More...
 
void set_key_value_metadata (std::map< std::string, std::string > metadata)
 Sets metadata. More...
 
void set_compression_statistics (std::shared_ptr< writer_compression_statistics > comp_stats)
 Sets the pointer to the output compression statistics. More...
 
void set_enable_dictionary_sort (bool val)
 Sets whether string dictionaries should be sorted. More...
 

Static Public Member Functions

static orc_writer_options_builder builder (sink_info const &sink, table_view const &table)
 Create builder to create orc_writer_options. More...
 

Detailed Description

Settings to use for write_orc().

Definition at line 577 of file orc.hpp.

Constructor & Destructor Documentation

◆ orc_writer_options()

cudf::io::orc_writer_options::orc_writer_options ( )
explicitdefault

Default constructor.

This has been added since Cython requires a default constructor to create objects on stack.

Member Function Documentation

◆ builder()

static orc_writer_options_builder cudf::io::orc_writer_options::builder ( sink_info const &  sink,
table_view const &  table 
)
static

Create builder to create orc_writer_options.

Parameters
sinkThe sink used for writer output
tableTable to be written to output
Returns
Builder to build orc_writer_options

◆ enable_statistics()

void cudf::io::orc_writer_options::enable_statistics ( statistics_freq  val)
inline

Choose granularity of statistics collection.

The granularity can be set to:

  • cudf::io::STATISTICS_NONE: No statistics are collected.
  • cudf::io::ORC_STATISTICS_STRIPE: Statistics are collected for each ORC stripe.
  • cudf::io::ORC_STATISTICS_ROWGROUP: Statistics are collected for each ORC row group.
Parameters
valFrequency of statistics collection

Definition at line 748 of file orc.hpp.

◆ get_compression()

compression_type cudf::io::orc_writer_options::get_compression ( ) const
inline

Returns compression type.

Returns
Compression type

Definition at line 644 of file orc.hpp.

◆ get_compression_statistics()

std::shared_ptr<writer_compression_statistics> cudf::io::orc_writer_options::get_compression_statistics ( ) const
inline

Returns a shared pointer to the user-provided compression statistics.

Returns
Compression statistics

Definition at line 717 of file orc.hpp.

◆ get_enable_dictionary_sort()

bool cudf::io::orc_writer_options::get_enable_dictionary_sort ( ) const
inline

Returns whether string dictionaries should be sorted.

Returns
true if string dictionaries should be sorted

Definition at line 727 of file orc.hpp.

◆ get_key_value_metadata()

std::map<std::string, std::string> const& cudf::io::orc_writer_options::get_key_value_metadata ( ) const
inline

Returns Key-Value footer metadata information.

Returns
Key-Value footer metadata information

Definition at line 707 of file orc.hpp.

◆ get_metadata()

auto const& cudf::io::orc_writer_options::get_metadata ( ) const
inline

Returns associated metadata.

Returns
Associated metadata

Definition at line 700 of file orc.hpp.

◆ get_row_index_stride()

auto cudf::io::orc_writer_options::get_row_index_stride ( ) const
inline

Returns the row index stride.

Returns
Row index stride

Definition at line 682 of file orc.hpp.

◆ get_sink()

sink_info const& cudf::io::orc_writer_options::get_sink ( ) const
inline

Returns sink info.

Returns
Sink info

Definition at line 637 of file orc.hpp.

◆ get_statistics_freq()

statistics_freq cudf::io::orc_writer_options::get_statistics_freq ( ) const
inline

Returns frequency of statistics collection.

Returns
Frequency of statistics collection

Definition at line 661 of file orc.hpp.

◆ get_stripe_size_bytes()

auto cudf::io::orc_writer_options::get_stripe_size_bytes ( ) const
inline

Returns maximum stripe size, in bytes.

Returns
Maximum stripe size, in bytes

Definition at line 668 of file orc.hpp.

◆ get_stripe_size_rows()

auto cudf::io::orc_writer_options::get_stripe_size_rows ( ) const
inline

Returns maximum stripe size, in rows.

Returns
Maximum stripe size, in rows

Definition at line 675 of file orc.hpp.

◆ get_table()

table_view cudf::io::orc_writer_options::get_table ( ) const
inline

Returns table to be written to output.

Returns
Table to be written to output

Definition at line 693 of file orc.hpp.

◆ is_enabled_statistics()

bool cudf::io::orc_writer_options::is_enabled_statistics ( ) const
inline

Whether writing column statistics is enabled/disabled.

Returns
true if writing column statistics is enabled

Definition at line 651 of file orc.hpp.

◆ set_compression()

void cudf::io::orc_writer_options::set_compression ( compression_type  comp)
inline

Sets compression type.

Parameters
compCompression type

Definition at line 736 of file orc.hpp.

◆ set_compression_statistics()

void cudf::io::orc_writer_options::set_compression_statistics ( std::shared_ptr< writer_compression_statistics comp_stats)
inline

Sets the pointer to the output compression statistics.

Parameters
comp_statsPointer to compression statistics to be updated after writing

Definition at line 823 of file orc.hpp.

◆ set_enable_dictionary_sort()

void cudf::io::orc_writer_options::set_enable_dictionary_sort ( bool  val)
inline

Sets whether string dictionaries should be sorted.

Parameters
valBoolean value to enable/disable

Definition at line 833 of file orc.hpp.

◆ set_key_value_metadata()

void cudf::io::orc_writer_options::set_key_value_metadata ( std::map< std::string, std::string >  metadata)
inline

Sets metadata.

Parameters
metadataKey-Value footer metadata

Definition at line 813 of file orc.hpp.

◆ set_metadata()

void cudf::io::orc_writer_options::set_metadata ( table_input_metadata  meta)
inline

Sets associated metadata.

Parameters
metaAssociated metadata

Definition at line 806 of file orc.hpp.

◆ set_row_index_stride()

void cudf::io::orc_writer_options::set_row_index_stride ( size_type  stride)
inline

Sets the row index stride.

Rounded down to a multiple of 8.

Parameters
strideRow index stride to be set
Exceptions
cudf::logic_errorif a value below the minimal row index stride is passed

Definition at line 788 of file orc.hpp.

◆ set_stripe_size_bytes()

void cudf::io::orc_writer_options::set_stripe_size_bytes ( size_t  size_bytes)
inline

Sets the maximum stripe size, in bytes.

Parameters
size_bytesMaximum stripe size, in bytes to be set
Exceptions
cudf::logic_errorif a value below the minimal size is passed

Definition at line 757 of file orc.hpp.

◆ set_stripe_size_rows()

void cudf::io::orc_writer_options::set_stripe_size_rows ( size_type  size_rows)
inline

Sets the maximum stripe size, in rows.

If the stripe size is smaller that the row group size, row group size will be reduced to math the stripe size.

Parameters
size_rowsMaximum stripe size, in rows to be set
Exceptions
cudf::logic_errorif a value below the minimal number of rows is passed

Definition at line 773 of file orc.hpp.

◆ set_table()

void cudf::io::orc_writer_options::set_table ( table_view  tbl)
inline

Sets table to be written to output.

Parameters
tblTable for the output

Definition at line 799 of file orc.hpp.


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