列的元数据。更多...

#include <types.hpp>

公共成员函数
	column_in_metadata (std::string_view name)
	构造一个新的列元数据对象。更多...

column_in_metadata &	add_child (column_in_metadata const &child)
	添加此列的子元数据。更多...

column_in_metadata &	set_name (std::string const &name) noexcept
	设置此列的名称。更多...

column_in_metadata &	set_nullability (bool nullable) noexcept
	设置此列的可空性。更多...

column_in_metadata &	set_list_column_as_map () noexcept
	指定此列表列在写入文件时应编码为 map。更多...

column_in_metadata &	set_int96_timestamps (bool req) noexcept
	指定此时间戳列是否应使用已弃用的 int96 物理类型进行编码。仅对以下列类型有效：timestamp_s, timestamp_ms, timestamp_us, timestamp_ns。更多...

column_in_metadata &	set_decimal_precision (uint8_t precision) noexcept
	设置此列的十进制精度。仅当此列为十进制（定点）类型时有效。更多...

column_in_metadata &	set_type_length (int32_t length) noexcept
	设置此列的数据长度。仅当此列为固定长度字节数组时有效。更多...

column_in_metadata &	set_parquet_field_id (int32_t field_id) noexcept
	设置此列的 parquet 字段 ID。更多...

column_in_metadata &	set_output_as_binary (bool binary) noexcept
	指定此列应写为二进制还是字符串数据。仅对以下列类型有效：string。更多...

column_in_metadata &	set_skip_compression (bool skip) noexcept
	指定无论为文件指定何种压缩编解码器，都不应对此列进行压缩。更多...

column_in_metadata &	set_encoding (column_encoding encoding) noexcept
	设置此列使用的编码。更多...

column_in_metadata &	child (size_type i) noexcept
	获取此列的子引用。更多...

column_in_metadata const &	child (size_type i) const noexcept
	获取此列的子常引用。更多...

std::string const &	get_name () const noexcept
	获取此列的名称。更多...

bool	is_nullability_defined () const noexcept
	获取此列的可空性是否已显式设置。更多...

bool	nullable () const
	获取此列的显式设置的可空性。更多...

bool	is_map () const noexcept
	如果这是列表列的元数据，则返回它是否将被编码为 map。更多...

bool	is_enabled_int96_timestamps () const noexcept
	获取是否使用已弃用的 int96 物理类型编码此时间戳列。更多...

bool	is_decimal_precision_set () const noexcept
	获取此十进制列的精度是否已设置。更多...

uint8_t	get_decimal_precision () const
	获取为此列设置的十进制精度。更多...

bool	is_type_length_set () const noexcept
	获取此列的类型长度是否已设置。更多...

uint8_t	get_type_length () const
	获取为此列设置的类型长度。更多...

bool	is_parquet_field_id_set () const noexcept
	获取此列的 parquet 字段 ID 是否已设置。更多...

int32_t	get_parquet_field_id () const
	获取为此列设置的 parquet 字段 ID。更多...

size_type	num_children () const noexcept
	获取此列的子数量。更多...

bool	is_enabled_output_as_binary () const noexcept
	获取是否将此列编码为二进制或字符串数据。更多...

bool	is_enabled_skip_compression () const noexcept
	获取是否跳过压缩此列。更多...

column_encoding	get_encoding () const
	获取为此列设置的编码。更多...

详细描述

列的元数据。

定义于文件 io/types.hpp 的第 634 行。

构造函数与析构函数文档

◆ column_in_metadata()

cudf::io::column_in_metadata::column_in_metadata ( std::string_view name )

inline

构造一个新的列元数据对象。

参数

name 列名称

定义于文件 io/types.hpp 的第 655 行。

成员函数文档

◆ add_child()

column_in_metadata& cudf::io::column_in_metadata::add_child ( column_in_metadata const & child )

inline

添加此列的子元数据。

参数

child 要添加的此列的子元数据

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 662 行。

◆ child() [1/2]

column_in_metadata const& cudf::io::column_in_metadata::child ( size_type i ) const

inlinenoexcept

获取此列的子常引用。

参数

i 要获取的子索引

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 819 行。

◆ child() [2/2]

column_in_metadata& cudf::io::column_in_metadata::child ( size_type i )

inlinenoexcept

获取此列的子引用。

参数

i 要获取的子索引

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 811 行。

◆ get_decimal_precision()

uint8_t cudf::io::column_in_metadata::get_decimal_precision ( ) const

inline

获取为此列设置的十进制精度。

异常

std::bad_optional_access 如果未为此列设置十进制精度。首先使用 is_decimal_precision_set() 进行检查。

返回值: 为此列设置的十进制精度

定义于文件 io/types.hpp 的第 876 行。

◆ get_encoding()

column_encoding cudf::io::column_in_metadata::get_encoding ( ) const

inline

获取为此列设置的编码。

返回值: 为此列设置的编码

定义于文件 io/types.hpp 的第 939 行。

◆ get_name()

std::string const& cudf::io::column_in_metadata::get_name ( ) const

inlinenoexcept

获取此列的名称。

返回值: 此列的名称

定义于文件 io/types.hpp 的第 826 行。

◆ get_parquet_field_id()

int32_t cudf::io::column_in_metadata::get_parquet_field_id ( ) const

inline

获取为此列设置的 parquet 字段 ID。

异常

std::bad_optional_access 如果未为此列设置 parquet 字段 ID。首先使用 is_parquet_field_id_set() 进行检查。

返回值: 为此列设置的 parquet 字段 ID

定义于文件 io/types.hpp 的第 911 行。

◆ get_type_length()

uint8_t cudf::io::column_in_metadata::get_type_length ( ) const

inline

获取为此列设置的类型长度。

异常

std::bad_optional_access 如果未为此列设置类型长度。首先使用 is_type_length_set() 进行检查。

返回值: 为此列设置的十进制精度

定义于文件 io/types.hpp 的第 892 行。

◆ is_decimal_precision_set()

bool cudf::io::column_in_metadata::is_decimal_precision_set ( ) const

inlinenoexcept

获取此十进制列的精度是否已设置。

返回值: 布尔值，指示是否已为此十进制列设置精度

定义于文件 io/types.hpp 的第 864 行。

◆ is_enabled_int96_timestamps()

bool cudf::io::column_in_metadata::is_enabled_int96_timestamps ( ) const

inlinenoexcept

获取是否使用已弃用的 int96 物理类型编码此时间戳列。

返回值: 布尔值，指示是否使用已弃用的 int96 物理类型编码此时间戳列

定义于文件 io/types.hpp 的第 857 行。

◆ is_enabled_output_as_binary()

bool cudf::io::column_in_metadata::is_enabled_output_as_binary ( ) const

inlinenoexcept

获取是否将此列编码为二进制或字符串数据。

返回值: 布尔值，指示是否将此列编码为二进制数据

定义于文件 io/types.hpp 的第 925 行。

◆ is_enabled_skip_compression()

bool cudf::io::column_in_metadata::is_enabled_skip_compression ( ) const

inlinenoexcept

获取是否跳过压缩此列。

返回值: 布尔值，指示是否跳过压缩此列

定义于文件 io/types.hpp 的第 932 行。

◆ is_map()

bool cudf::io::column_in_metadata::is_map ( ) const

inlinenoexcept

如果这是列表列的元数据，则返回它是否将被编码为 map。

返回值: 布尔值，指示此列是否将被编码为 map

定义于文件 io/types.hpp 的第 849 行。

◆ is_nullability_defined()

bool cudf::io::column_in_metadata::is_nullability_defined ( ) const

inlinenoexcept

获取此列的可空性是否已显式设置。

返回值: 布尔值，指示此列的可空性是否已显式设置

定义于文件 io/types.hpp 的第 833 行。

◆ is_parquet_field_id_set()

bool cudf::io::column_in_metadata::is_parquet_field_id_set ( ) const

inlinenoexcept

获取此列的 parquet 字段 ID 是否已设置。

返回值: 布尔值，指示此列的 parquet 字段 ID 是否已设置

定义于文件 io/types.hpp 的第 899 行。

◆ is_type_length_set()

bool cudf::io::column_in_metadata::is_type_length_set ( ) const

inlinenoexcept

获取此列的类型长度是否已设置。

返回值: 布尔值，指示此列的类型长度是否已设置

定义于文件 io/types.hpp 的第 883 行。

◆ nullable()

bool cudf::io::column_in_metadata::nullable ( ) const

inline

获取此列的显式设置的可空性。

异常

std::bad_optional_access 如果未为此列显式定义可空性。首先使用 is_nullability_defined() 进行检查。

返回值: 布尔值，指示此列是否可空

定义于文件 io/types.hpp 的第 842 行。

◆ num_children()

size_type cudf::io::column_in_metadata::num_children ( ) const

inlinenoexcept

获取此列的子数量。

返回值: 此列的子数量

定义于文件 io/types.hpp 的第 918 行。

◆ set_decimal_precision()

column_in_metadata& cudf::io::column_in_metadata::set_decimal_precision ( uint8_t precision )

inlinenoexcept

设置此列的十进制精度。仅当此列为十进制（定点）类型时有效。

参数

precision 为此十进制列设置的整数精度

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 726 行。

◆ set_encoding()

column_in_metadata& cudf::io::column_in_metadata::set_encoding ( column_encoding encoding )

inlinenoexcept

设置此列使用的编码。

这只是一个请求，编码器仍可能根据资源限制选择使用不同的编码。使用 parquet_encoding struct 中定义的常量。

参数

encoding 要使用的编码

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 799 行。

◆ set_int96_timestamps()

column_in_metadata& cudf::io::column_in_metadata::set_int96_timestamps ( bool req )

inlinenoexcept

指定此时间戳列是否应使用已弃用的 int96 物理类型进行编码。仅对以下列类型有效：timestamp_s, timestamp_ms, timestamp_us, timestamp_ns。

参数

req	True = 使用 int96 物理类型。 False = 使用 int64 物理类型

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 713 行。

◆ set_list_column_as_map()

column_in_metadata& cudf::io::column_in_metadata::set_list_column_as_map ( )

inlinenoexcept

指定此列表列在写入文件时应编码为 map。

该列必须具有 list> 结构。否则此选项无效

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 699 行。

◆ set_name()

column_in_metadata& cudf::io::column_in_metadata::set_name ( std::string const & name )

inlinenoexcept

设置此列的名称。

参数

name 列的名称

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 674 行。

◆ set_nullability()

column_in_metadata& cudf::io::column_in_metadata::set_nullability ( bool nullable )

inlinenoexcept

设置此列的可空性。

参数

nullable 此列是否可空

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 686 行。

◆ set_output_as_binary()

column_in_metadata& cudf::io::column_in_metadata::set_output_as_binary ( bool binary )

inlinenoexcept

指定此列应写为二进制还是字符串数据。仅对以下列类型有效：string。

参数

binary True = 使用二进制数据类型。 False = 使用字符串数据类型

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 765 行。

◆ set_parquet_field_id()

column_in_metadata& cudf::io::column_in_metadata::set_parquet_field_id ( int32_t field_id )

inlinenoexcept

设置此列的 parquet 字段 ID。

参数

field_id 要设置的 parquet 字段 ID

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 751 行。

◆ set_skip_compression()

column_in_metadata& cudf::io::column_in_metadata::set_skip_compression ( bool skip )

inlinenoexcept

指定无论为文件指定何种压缩编解码器，都不应对此列进行压缩。

参数

skip	如果 `true` 则不压缩此列

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 783 行。

◆ set_type_length()

column_in_metadata& cudf::io::column_in_metadata::set_type_length ( int32_t length )

inlinenoexcept

设置此列的数据长度。仅当此列为固定长度字节数组时有效。

参数

length 为此列设置的数据长度

返回值: this 用于链式调用

定义于文件 io/types.hpp 的第 739 行。

此类的文档由以下文件生成

io/types.hpp

公共成员函数

详细描述

构造函数与析构函数文档

◆ column_in_metadata()

成员函数文档

◆ add_child()

◆ child() [1/2]

◆ child() [2/2]

◆ get_decimal_precision()

◆ get_encoding()

◆ get_name()

◆ get_parquet_field_id()

◆ get_type_length()

◆ is_decimal_precision_set()

◆ is_enabled_int96_timestamps()

◆ is_enabled_output_as_binary()

◆ is_enabled_skip_compression()

◆ is_map()

◆ is_nullability_defined()

◆ is_parquet_field_id_set()

◆ is_type_length_set()

◆ nullable()

◆ num_children()

◆ set_decimal_precision()

◆ set_encoding()

◆ set_int96_timestamps()

◆ set_list_column_as_map()

◆ set_name()

◆ set_nullability()

◆ set_output_as_binary()

◆ set_parquet_field_id()

◆ set_skip_compression()

◆ set_type_length()