Class to build parquet_writer_options.
More...
#include <parquet.hpp>
Inheritance diagram for cudf::io::parquet_writer_options_builder:
Public Member Functions | |
| parquet_writer_options_builder ()=default | |
| Default constructor. More... | |
| parquet_writer_options_builder (sink_info const &sink, table_view const &table) | |
| Constructor from sink and table. More... | |
| parquet_writer_options_builder & | partitions (std::vector< partition_info > partitions) |
| Sets partitions in parquet_writer_options. More... | |
| parquet_writer_options_builder & | column_chunks_file_paths (std::vector< std::string > file_paths) |
| Sets column chunks file path to be set in the raw output metadata. More... | |
 Public Member Functions inherited from cudf::io::parquet_writer_options_builder_base< parquet_writer_options_builder, parquet_writer_options > | |
| parquet_writer_options_builder_base ()=default | |
| Default constructor. More... | |
| parquet_writer_options_builder & | metadata (table_input_metadata metadata) |
| Sets metadata. More... | |
| parquet_writer_options_builder & | key_value_metadata (std::vector< std::map< std::string, std::string >> metadata) |
| Sets Key-Value footer metadata. More... | |
| parquet_writer_options_builder & | stats_level (statistics_freq sf) |
| Sets the level of statistics. More... | |
| parquet_writer_options_builder & | compression (compression_type compression) |
| Sets compression type. More... | |
| parquet_writer_options_builder & | row_group_size_bytes (size_t val) |
| Sets the maximum row group size, in bytes. More... | |
| parquet_writer_options_builder & | row_group_size_rows (size_type val) |
| Sets the maximum number of rows in output row groups. More... | |
| parquet_writer_options_builder & | max_page_size_bytes (size_t val) |
| Sets the maximum uncompressed page size, in bytes. More... | |
| parquet_writer_options_builder & | max_page_size_rows (size_type val) |
| Sets the maximum page size, in rows. Counts only top-level rows, ignoring any nesting. Cannot be larger than the row group size in rows, and will be adjusted to match if it is. More... | |
| parquet_writer_options_builder & | column_index_truncate_length (int32_t val) |
| Sets the desired maximum size in bytes for min and max values in the column index. More... | |
| parquet_writer_options_builder & | dictionary_policy (enum dictionary_policy val) |
| Sets the policy for dictionary use. More... | |
| parquet_writer_options_builder & | max_dictionary_size (size_t val) |
| Sets the maximum dictionary size, in bytes. More... | |
| parquet_writer_options_builder & | max_page_fragment_size (size_type val) |
| Sets the maximum page fragment size, in rows. More... | |
| parquet_writer_options_builder & | compression_statistics (std::shared_ptr< writer_compression_statistics > const &comp_stats) |
| Sets the pointer to the output compression statistics. More... | |
| parquet_writer_options_builder & | int96_timestamps (bool enabled) |
| Sets whether int96 timestamps are written or not. More... | |
| parquet_writer_options_builder & | utc_timestamps (bool enabled) |
| Set to true if timestamps are to be written as UTC. More... | |
| parquet_writer_options_builder & | write_arrow_schema (bool enabled) |
| Set to true if arrow schema is to be written. More... | |
| parquet_writer_options_builder & | write_v2_headers (bool enabled) |
| Set to true if V2 page headers are to be written. More... | |
| parquet_writer_options_builder & | sorting_columns (std::vector< sorting_column > sorting_columns) |
| Sets column sorting metadata. More... | |
| operator parquet_writer_options && () | |
| move options member once it's built. | |
| parquet_writer_options && | build () |
| move options member once it's built. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from cudf::io::parquet_writer_options_builder_base< parquet_writer_options_builder, parquet_writer_options > | |
| parquet_writer_options & | get_options () |
| Return reference to the options object being built. More... | |
| parquet_writer_options_builder_base (parquet_writer_options options) | |
| Constructor from options. More... | |
Detailed Description
Class to build parquet_writer_options.
Definition at line 1275 of file parquet.hpp.
Constructor & Destructor Documentation
◆ parquet_writer_options_builder() [1/2]
|
explicitdefault |
Default constructor.
This has been added since Cython requires a default constructor to create objects on stack.
◆ parquet_writer_options_builder() [2/2]
|
explicit |
Constructor from sink and table.
- Parameters
-
sink The sink used for writer output table Table to be written to output
Member Function Documentation
◆ column_chunks_file_paths()
| parquet_writer_options_builder& cudf::io::parquet_writer_options_builder::column_chunks_file_paths | ( | std::vector< std::string > | file_paths | ) |
Sets column chunks file path to be set in the raw output metadata.
- Parameters
-
file_paths Vector of Strings which indicates file path. Must be same size as number of data sinks
- Returns
- this for chaining
◆ partitions()
| parquet_writer_options_builder& cudf::io::parquet_writer_options_builder::partitions | ( | std::vector< partition_info > | partitions | ) |
Sets partitions in parquet_writer_options.
- Parameters
-
partitions Partitions of input table in {start_row, num_rows} pairs. If specified, must be same size as number of sinks in sink_info
- Returns
- this for chaining
The documentation for this class was generated from the following file:
