Metadata for a column. More...
#include <types.hpp>
Public Member Functions | |
column_in_metadata (std::string_view name) | |
Construct a new column in metadata object. More... | |
column_in_metadata & | add_child (column_in_metadata const &child) |
Add the children metadata of this column. More... | |
column_in_metadata & | set_name (std::string const &name) noexcept |
Set the name of this column. More... | |
column_in_metadata & | set_nullability (bool nullable) noexcept |
Set the nullability of this column. More... | |
column_in_metadata & | set_list_column_as_map () noexcept |
Specify that this list column should be encoded as a map in the written file. More... | |
column_in_metadata & | set_int96_timestamps (bool req) noexcept |
Specifies whether this timestamp column should be encoded using the deprecated int96 physical type. Only valid for the following column types: timestamp_s, timestamp_ms, timestamp_us, timestamp_ns. More... | |
column_in_metadata & | set_decimal_precision (uint8_t precision) noexcept |
Set the decimal precision of this column. Only valid if this column is a decimal (fixed-point) type. More... | |
column_in_metadata & | set_type_length (int32_t length) noexcept |
Set the data length of the column. Only valid if this column is a fixed-length byte array. More... | |
column_in_metadata & | set_parquet_field_id (int32_t field_id) noexcept |
Set the parquet field id of this column. More... | |
column_in_metadata & | set_output_as_binary (bool binary) noexcept |
Specifies whether this column should be written as binary or string data Only valid for the following column types: string. More... | |
column_in_metadata & | set_skip_compression (bool skip) noexcept |
Specifies whether this column should not be compressed regardless of the compression codec specified for the file. More... | |
column_in_metadata & | set_encoding (column_encoding encoding) noexcept |
Sets the encoding to use for this column. More... | |
column_in_metadata & | child (size_type i) noexcept |
Get reference to a child of this column. More... | |
column_in_metadata const & | child (size_type i) const noexcept |
Get const reference to a child of this column. More... | |
std::string | get_name () const noexcept |
Get the name of this column. More... | |
bool | is_nullability_defined () const noexcept |
Get whether nullability has been explicitly set for this column. More... | |
bool | nullable () const |
Gets the explicitly set nullability for this column. More... | |
bool | is_map () const noexcept |
If this is the metadata of a list column, returns whether it is to be encoded as a map. More... | |
bool | is_enabled_int96_timestamps () const noexcept |
Get whether to encode this timestamp column using deprecated int96 physical type. More... | |
bool | is_decimal_precision_set () const noexcept |
Get whether precision has been set for this decimal column. More... | |
uint8_t | get_decimal_precision () const |
Get the decimal precision that was set for this column. More... | |
bool | is_type_length_set () const noexcept |
Get whether type length has been set for this column. More... | |
uint8_t | get_type_length () const |
Get the type length that was set for this column. More... | |
bool | is_parquet_field_id_set () const noexcept |
Get whether parquet field id has been set for this column. More... | |
int32_t | get_parquet_field_id () const |
Get the parquet field id that was set for this column. More... | |
size_type | num_children () const noexcept |
Get the number of children of this column. More... | |
bool | is_enabled_output_as_binary () const noexcept |
Get whether to encode this column as binary or string data. More... | |
bool | is_enabled_skip_compression () const noexcept |
Get whether to skip compressing this column. More... | |
column_encoding | get_encoding () const |
Get the encoding that was set for this column. More... | |
Metadata for a column.
Definition at line 621 of file io/types.hpp.
|
inline |
Construct a new column in metadata object.
name | Column name |
Definition at line 642 of file io/types.hpp.
|
inline |
Add the children metadata of this column.
child | The children metadata of this column to add |
Definition at line 649 of file io/types.hpp.
|
inlinenoexcept |
Get const reference to a child of this column.
i | Index of the child to get |
Definition at line 806 of file io/types.hpp.
|
inlinenoexcept |
Get reference to a child of this column.
i | Index of the child to get |
Definition at line 798 of file io/types.hpp.
|
inline |
Get the decimal precision that was set for this column.
std::bad_optional_access | If decimal precision was not set for this column. Check using is_decimal_precision_set() first. |
Definition at line 863 of file io/types.hpp.
|
inline |
Get the encoding that was set for this column.
Definition at line 926 of file io/types.hpp.
|
inlinenoexcept |
Get the name of this column.
Definition at line 813 of file io/types.hpp.
|
inline |
Get the parquet field id that was set for this column.
std::bad_optional_access | If parquet field id was not set for this column. Check using is_parquet_field_id_set() first. |
Definition at line 898 of file io/types.hpp.
|
inline |
Get the type length that was set for this column.
std::bad_optional_access | If type length was not set for this column. Check using is_type_length_set() first. |
Definition at line 879 of file io/types.hpp.
|
inlinenoexcept |
Get whether precision has been set for this decimal column.
Definition at line 851 of file io/types.hpp.
|
inlinenoexcept |
Get whether to encode this timestamp column using deprecated int96 physical type.
Definition at line 844 of file io/types.hpp.
|
inlinenoexcept |
Get whether to encode this column as binary or string data.
Definition at line 912 of file io/types.hpp.
|
inlinenoexcept |
Get whether to skip compressing this column.
Definition at line 919 of file io/types.hpp.
|
inlinenoexcept |
If this is the metadata of a list column, returns whether it is to be encoded as a map.
Definition at line 836 of file io/types.hpp.
|
inlinenoexcept |
Get whether nullability has been explicitly set for this column.
Definition at line 820 of file io/types.hpp.
|
inlinenoexcept |
Get whether parquet field id has been set for this column.
Definition at line 886 of file io/types.hpp.
|
inlinenoexcept |
Get whether type length has been set for this column.
Definition at line 870 of file io/types.hpp.
|
inline |
Gets the explicitly set nullability for this column.
std::bad_optional_access | If nullability is not explicitly defined for this column. Check using is_nullability_defined() first. |
Definition at line 829 of file io/types.hpp.
|
inlinenoexcept |
Get the number of children of this column.
Definition at line 905 of file io/types.hpp.
|
inlinenoexcept |
Set the decimal precision of this column. Only valid if this column is a decimal (fixed-point) type.
precision | The integer precision to set for this decimal column |
Definition at line 713 of file io/types.hpp.
|
inlinenoexcept |
Sets the encoding to use for this column.
This is just a request, and the encoder may still choose to use a different encoding depending on resource constraints. Use the constants defined in the parquet_encoding
struct.
encoding | The encoding to use |
Definition at line 786 of file io/types.hpp.
|
inlinenoexcept |
Specifies whether this timestamp column should be encoded using the deprecated int96 physical type. Only valid for the following column types: timestamp_s, timestamp_ms, timestamp_us, timestamp_ns.
req | True = use int96 physical type. False = use int64 physical type |
Definition at line 700 of file io/types.hpp.
|
inlinenoexcept |
Specify that this list column should be encoded as a map in the written file.
The column must have the structure list<struct<key, value>>. This option is invalid otherwise
Definition at line 686 of file io/types.hpp.
|
inlinenoexcept |
Set the name of this column.
name | Name of the column |
Definition at line 661 of file io/types.hpp.
|
inlinenoexcept |
Set the nullability of this column.
nullable | Whether this column is nullable |
Definition at line 673 of file io/types.hpp.
|
inlinenoexcept |
Specifies whether this column should be written as binary or string data Only valid for the following column types: string.
binary | True = use binary data type. False = use string data type |
Definition at line 752 of file io/types.hpp.
|
inlinenoexcept |
Set the parquet field id of this column.
field_id | The parquet field id to set |
Definition at line 738 of file io/types.hpp.
|
inlinenoexcept |
Specifies whether this column should not be compressed regardless of the compression codec specified for the file.
skip | If true do not compress this column |
Definition at line 770 of file io/types.hpp.
|
inlinenoexcept |
Set the data length of the column. Only valid if this column is a fixed-length byte array.
length | The data length to set for this column |
Definition at line 726 of file io/types.hpp.