cudf::io::chunked_orc_writer_options Class Reference

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

#include <orc.hpp>

Public Member Functions
	chunked_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...
statistics_freq	get_statistics_freq () const
	Returns granularity 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...
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_statistics >	get_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	metadata (table_input_metadata meta)
	Sets associated metadata. More...
void	set_key_value_metadata (std::map< std::string, std::string > metadata)
	Sets Key-Value footer 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 chunked_orc_writer_options_builder	builder (sink_info const &sink)
	Create builder to create chunked_orc_writer_options. More...

Detailed Description

Settings to use for write_orc_chunked().

Definition at line 1025 of file orc.hpp.

Constructor & Destructor Documentation

chunked_orc_writer_options()

cudf::io::chunked_orc_writer_options::chunked_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 chunked_orc_writer_options_builder cudf::io::chunked_orc_writer_options::builder ( sink_info const &  sink )

static

Create builder to create chunked_orc_writer_options.

Parameters

sink	The sink used for writer output

Returns

Builder to build chunked_orc_writer_options

enable_statistics()

void cudf::io::chunked_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

val	Frequency of statistics collection

Definition at line 1172 of file orc.hpp.

get_compression()

compression_type cudf::io::chunked_orc_writer_options::get_compression ( ) const

inline

Returns compression type.

Returns

Compression type

Definition at line 1085 of file orc.hpp.

get_compression_statistics()

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

inline

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

Returns

Compression statistics

Definition at line 1141 of file orc.hpp.

get_enable_dictionary_sort()

bool cudf::io::chunked_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 1151 of file orc.hpp.

get_key_value_metadata()

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

inline

Returns Key-Value footer metadata information.

Returns

Key-Value footer metadata information

Definition at line 1131 of file orc.hpp.

get_metadata()

auto const& cudf::io::chunked_orc_writer_options::get_metadata ( ) const

inline

Returns associated metadata.

Returns

Associated metadata

Definition at line 1124 of file orc.hpp.

get_row_index_stride()

auto cudf::io::chunked_orc_writer_options::get_row_index_stride ( ) const

inline

Returns the row index stride.

Returns

Row index stride

Definition at line 1113 of file orc.hpp.

get_sink()

sink_info const& cudf::io::chunked_orc_writer_options::get_sink ( ) const

inline

Returns sink info.

Returns

Sink info

Definition at line 1078 of file orc.hpp.

get_statistics_freq()

statistics_freq cudf::io::chunked_orc_writer_options::get_statistics_freq ( ) const

inline

Returns granularity of statistics collection.

Returns

Granularity of statistics collection

Definition at line 1092 of file orc.hpp.

get_stripe_size_bytes()

auto cudf::io::chunked_orc_writer_options::get_stripe_size_bytes ( ) const

inline

Returns maximum stripe size, in bytes.

Returns

Maximum stripe size, in bytes

Definition at line 1099 of file orc.hpp.

get_stripe_size_rows()

auto cudf::io::chunked_orc_writer_options::get_stripe_size_rows ( ) const

inline

Returns maximum stripe size, in rows.

Returns

Maximum stripe size, in rows

Definition at line 1106 of file orc.hpp.

metadata()

void cudf::io::chunked_orc_writer_options::metadata ( table_input_metadata  meta )

inline

Sets associated metadata.

Parameters

meta	Associated metadata

Definition at line 1223 of file orc.hpp.

set_compression()

void cudf::io::chunked_orc_writer_options::set_compression ( compression_type  comp )

inline

Sets compression type.

Parameters

comp	The compression type to use

Definition at line 1160 of file orc.hpp.

set_compression_statistics()

void cudf::io::chunked_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_stats

Pointer to compression statistics to be updated after writing

Definition at line 1240 of file orc.hpp.

set_enable_dictionary_sort()

void cudf::io::chunked_orc_writer_options::set_enable_dictionary_sort ( bool  val )

inline

Sets whether string dictionaries should be sorted.

Parameters

val	Boolean value to enable/disable

Definition at line 1250 of file orc.hpp.

set_key_value_metadata()

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

inline

Sets Key-Value footer metadata.

Parameters

metadata

Key-Value footer metadata

Definition at line 1230 of file orc.hpp.

set_row_index_stride()

void cudf::io::chunked_orc_writer_options::set_row_index_stride ( size_type  stride )

inline

Sets the row index stride.

Rounded down to a multiple of 8.

Parameters

stride

Row index stride to be set

Exceptions

cudf::logic_error

if a value below the minimal number of rows in a row group is passed

Definition at line 1212 of file orc.hpp.

set_stripe_size_bytes()

void cudf::io::chunked_orc_writer_options::set_stripe_size_bytes ( size_t  size_bytes )

inline

Sets the maximum stripe size, in bytes.

Parameters

size_bytes

Maximum stripe size, in bytes to be set

Exceptions

cudf::logic_error

if a value below the minimal stripe size is passed

Definition at line 1181 of file orc.hpp.

set_stripe_size_rows()

void cudf::io::chunked_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_rows

Maximum stripe size, in rows to be set

Exceptions

cudf::logic_error

if a value below the minimal number of rows in a stripe is passed

Definition at line 1197 of file orc.hpp.

---

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

• orc.hpp