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

Builds settings to use for write_orc_chunked(). More...

#include <orc.hpp>

Public Member Functions

 chunked_orc_writer_options_builder ()=default
 Default constructor. More...
 
 chunked_orc_writer_options_builder (sink_info const &sink)
 Constructor from sink and table. More...
 
chunked_orc_writer_options_buildercompression (compression_type comp)
 Sets compression type. More...
 
chunked_orc_writer_options_builderenable_statistics (statistics_freq val)
 Choose granularity of statistics collection. More...
 
chunked_orc_writer_options_builderstripe_size_bytes (size_t val)
 Sets the maximum stripe size, in bytes. More...
 
chunked_orc_writer_options_builderstripe_size_rows (size_type val)
 Sets the maximum number of rows in output stripes. More...
 
chunked_orc_writer_options_builderrow_index_stride (size_type val)
 Sets the row index stride. More...
 
chunked_orc_writer_options_buildermetadata (table_input_metadata meta)
 Sets associated metadata. More...
 
chunked_orc_writer_options_builderkey_value_metadata (std::map< std::string, std::string > metadata)
 Sets Key-Value footer metadata. More...
 
chunked_orc_writer_options_buildercompression_statistics (std::shared_ptr< writer_compression_statistics > const &comp_stats)
 Sets the pointer to the output compression statistics. More...
 
chunked_orc_writer_options_builderenable_dictionary_sort (bool val)
 Sets whether string dictionaries should be sorted. More...
 
 operator chunked_orc_writer_options && ()
 move chunked_orc_writer_options member once it's built.
 
chunked_orc_writer_options && build ()
 move chunked_orc_writer_options member once it's built. More...
 

Detailed Description

Builds settings to use for write_orc_chunked().

Definition at line 1109 of file orc.hpp.

Constructor & Destructor Documentation

◆ chunked_orc_writer_options_builder() [1/2]

cudf::io::chunked_orc_writer_options_builder::chunked_orc_writer_options_builder ( )
default

Default constructor.

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

◆ chunked_orc_writer_options_builder() [2/2]

cudf::io::chunked_orc_writer_options_builder::chunked_orc_writer_options_builder ( sink_info const &  sink)
inlineexplicit

Constructor from sink and table.

Parameters
sinkThe sink used for writer output

Definition at line 1125 of file orc.hpp.

Member Function Documentation

◆ build()

chunked_orc_writer_options&& cudf::io::chunked_orc_writer_options_builder::build ( )
inline

move chunked_orc_writer_options member once it's built.

This has been added since Cython does not support overloading of conversion operators.

Returns
Built chunked_orc_writer_options object's r-value reference

Definition at line 1254 of file orc.hpp.

◆ compression()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::compression ( compression_type  comp)
inline

Sets compression type.

Parameters
compThe compression type to use
Returns
this for chaining

Definition at line 1133 of file orc.hpp.

◆ compression_statistics()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::compression_statistics ( std::shared_ptr< writer_compression_statistics > const &  comp_stats)
inline

Sets the pointer to the output compression statistics.

Parameters
comp_statsPointer to compression statistics to be filled once writer is done
Returns
this for chaining

Definition at line 1223 of file orc.hpp.

◆ enable_dictionary_sort()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::enable_dictionary_sort ( bool  val)
inline

Sets whether string dictionaries should be sorted.

Parameters
valBoolean value to enable/disable
Returns
this for chaining

Definition at line 1236 of file orc.hpp.

◆ enable_statistics()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::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
Returns
this for chaining

Definition at line 1150 of file orc.hpp.

◆ key_value_metadata()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::key_value_metadata ( std::map< std::string, std::string >  metadata)
inline

Sets Key-Value footer metadata.

Parameters
metadataKey-Value footer metadata
Returns
this for chaining

Definition at line 1210 of file orc.hpp.

◆ metadata()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::metadata ( table_input_metadata  meta)
inline

Sets associated metadata.

Parameters
metaAssociated metadata
Returns
this for chaining

Definition at line 1198 of file orc.hpp.

◆ row_index_stride()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::row_index_stride ( size_type  val)
inline

Sets the row index stride.

Parameters
valnew row index stride
Returns
this for chaining

Definition at line 1186 of file orc.hpp.

◆ stripe_size_bytes()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::stripe_size_bytes ( size_t  val)
inline

Sets the maximum stripe size, in bytes.

Parameters
valmaximum stripe size
Returns
this for chaining

Definition at line 1162 of file orc.hpp.

◆ stripe_size_rows()

chunked_orc_writer_options_builder& cudf::io::chunked_orc_writer_options_builder::stripe_size_rows ( size_type  val)
inline

Sets the maximum number of rows in output stripes.

Parameters
valmaximum number or rows
Returns
this for chaining

Definition at line 1174 of file orc.hpp.


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