cudf::io::orc_writer_options_builder Class Reference

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

#include <orc.hpp>

Public Member Functions
	orc_writer_options_builder ()=default
	Default constructor. More...
	orc_writer_options_builder (sink_info const &sink, table_view const &table)
	Constructor from sink and table. More...
orc_writer_options_builder &	compression (compression_type comp)
	Sets compression type. More...
orc_writer_options_builder &	enable_statistics (statistics_freq val)
	Choose granularity of column statistics to be written. More...
orc_writer_options_builder &	stripe_size_bytes (size_t val)
	Sets the maximum stripe size, in bytes. More...
orc_writer_options_builder &	stripe_size_rows (size_type val)
	Sets the maximum number of rows in output stripes. More...
orc_writer_options_builder &	row_index_stride (size_type val)
	Sets the row index stride. More...
orc_writer_options_builder &	table (table_view tbl)
	Sets table to be written to output. More...
orc_writer_options_builder &	metadata (table_input_metadata meta)
	Sets associated metadata. More...
orc_writer_options_builder &	key_value_metadata (std::map< std::string, std::string > metadata)
	Sets Key-Value footer metadata. More...
orc_writer_options_builder &	compression_statistics (std::shared_ptr< writer_compression_statistics > const &comp_stats)
	Sets the pointer to the output compression statistics. More...
orc_writer_options_builder &	enable_dictionary_sort (bool val)
	Sets whether string dictionaries should be sorted. More...
	operator orc_writer_options && ()
	move orc_writer_options member once it's built.
orc_writer_options &&	build ()
	move orc_writer_options member once it's built. More...

Detailed Description

Builds settings to use for write_orc().

Definition at line 697 of file orc.hpp.

Constructor & Destructor Documentation

orc_writer_options_builder() [1/2]

cudf::io::orc_writer_options_builder::orc_writer_options_builder ( )

default

Default constructor.

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

orc_writer_options_builder() [2/2]

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

inline

Constructor from sink and table.

Parameters

sink	The sink used for writer output
table	Table to be written to output

Definition at line 714 of file orc.hpp.

Member Function Documentation

build()

orc_writer_options&& cudf::io::orc_writer_options_builder::build ( )

inline

move orc_writer_options member once it's built.

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

Returns

Built orc_writer_options object's r-value reference

Definition at line 856 of file orc.hpp.

compression()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::compression ( compression_type  comp )

inline

Sets compression type.

Parameters

comp	The compression type to use

Returns

this for chaining

Definition at line 724 of file orc.hpp.

compression_statistics()

orc_writer_options_builder& cudf::io::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_stats

Pointer to compression statistics to be filled once writer is done

Returns

this for chaining

Definition at line 825 of file orc.hpp.

enable_dictionary_sort()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::enable_dictionary_sort ( bool  val )

inline

Sets whether string dictionaries should be sorted.

Parameters

val	Boolean value to enable/disable

Returns

this for chaining

Definition at line 838 of file orc.hpp.

enable_statistics()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::enable_statistics ( statistics_freq  val )

inline

Choose granularity of column statistics to be written.

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	Level of statistics collection

Returns

this for chaining

Definition at line 741 of file orc.hpp.

key_value_metadata()

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

inline

Sets Key-Value footer metadata.

Parameters

metadata

Key-Value footer metadata

Returns

this for chaining

Definition at line 813 of file orc.hpp.

metadata()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::metadata ( table_input_metadata  meta )

inline

Sets associated metadata.

Parameters

meta	Associated metadata

Returns

this for chaining

Definition at line 801 of file orc.hpp.

row_index_stride()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::row_index_stride ( size_type  val )

inline

Sets the row index stride.

Parameters

val	new row index stride

Returns

this for chaining

Definition at line 777 of file orc.hpp.

stripe_size_bytes()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::stripe_size_bytes ( size_t  val )

inline

Sets the maximum stripe size, in bytes.

Parameters

val	maximum stripe size

Returns

this for chaining

Definition at line 753 of file orc.hpp.

stripe_size_rows()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::stripe_size_rows ( size_type  val )

inline

Sets the maximum number of rows in output stripes.

Parameters

val	maximum number or rows

Returns

this for chaining

Definition at line 765 of file orc.hpp.

table()

orc_writer_options_builder& cudf::io::orc_writer_options_builder::table ( table_view  tbl )

inline

Sets table to be written to output.

Parameters

tbl	Table for the output

Returns

this for chaining

Definition at line 789 of file orc.hpp.

---

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

• orc.hpp