Settings to use for write_orc_chunked().
More...
#include <cudf/io/orc.hpp>
Settings to use for write_orc_chunked().
Definition at line 1077 of file orc.hpp.
◆ 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.
◆ builder()
◆ 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 1228 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 1137 of file orc.hpp.
◆ get_compression_statistics()
Returns a shared pointer to the user-provided compression statistics.
- Returns
- Compression statistics
Definition at line 1193 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 1203 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 1183 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 1176 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 1165 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 1130 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 1144 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 1151 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 1158 of file orc.hpp.
◆ metadata()
Sets associated metadata.
- Parameters
-
Definition at line 1279 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 1212 of file orc.hpp.
◆ set_compression_statistics()
Sets the pointer to the output compression statistics.
- Parameters
-
| comp_stats | Pointer to compression statistics to be updated after writing |
Definition at line 1296 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 1306 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 1286 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 1268 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
-
Definition at line 1237 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
-
Definition at line 1253 of file orc.hpp.
The documentation for this class was generated from the following file:
