用于 read_orc() 的设置。更多...

#include <orc.hpp>

公共成员函数
	orc_reader_options ()=default
	默认构造函数。更多...

source_info const &	get_source () const
	返回源信息。更多...

auto const &	get_columns () const
	返回要读取的列的名称（如果已设置）。更多...

auto const &	get_stripes () const
	返回向量的向量，表示每个输入源要读取的条带。更多...

int64_t	get_skip_rows () const
	返回要从开头跳过的行数。更多...

std::optional< int64_t > const &	get_num_rows () const
	返回要读取的行数。更多...

bool	is_enabled_use_index () const
	是否使用行索引来加速读取。更多...

bool	is_enabled_use_np_dtypes () const
	是否使用与 numpy 兼容的数据类型。更多...

data_type	get_timestamp_type () const
	返回时间戳列将被转换为的时间戳类型。更多...

std::vector< std::string > const &	get_decimal128_columns () const
	返回应读取为 128 位 Decimal 的列的完全限定名称。更多...

void	set_columns (std::vector< std::string > col_names)
	设置要读取的列的名称。更多...

void	set_stripes (std::vector< std::vector< size_type >> stripes)
	设置每个输入源要读取的条带列表。更多...

void	set_skip_rows (int64_t rows)
	设置要从开头跳过的行数。更多...

void	set_num_rows (int64_t nrows)
	设置要读取的行数。更多...

void	enable_use_index (bool use)
	启用/禁用使用行索引来加速读取。更多...

void	enable_use_np_dtypes (bool use)
	启用/禁用使用与 numpy 兼容的数据类型。更多...

void	set_timestamp_type (data_type type)
	设置时间戳列将被转换为的时间戳类型。更多...

void	set_decimal128_columns (std::vector< std::string > val)
	设置应读取为 128 位 Decimal 的列。更多...

静态公共成员函数
static orc_reader_options_builder	builder (source_info src)
	创建 `orc_reader_options_builder`，它将用于构建 `orc_reader_options`。更多...

详细描述

用于 read_orc() 的设置。

定义于文件 orc.hpp 的第 53 行。

构造函数和析构函数文档

◆ orc_reader_options()

cudf::io::orc_reader_options::orc_reader_options ( )

default

默认构造函数。

添加此构造函数是因为 Cython 需要一个默认构造函数来在栈上创建对象。

成员函数文档

◆ builder()

static orc_reader_options_builder cudf::io::orc_reader_options::builder ( source_info src )

static

创建 orc_reader_options_builder，它将用于构建 orc_reader_options。更多...

参数

src	要读取 ORC 文件的源信息

返回值: 用于构建读取器选项的构建器

◆ enable_use_index()

void cudf::io::orc_reader_options::enable_use_index ( bool use )

inline

启用/禁用使用行索引来加速读取。

参数

use	用于启用/禁用行索引使用的布尔值

定义于文件 orc.hpp 的第 231 行。

◆ enable_use_np_dtypes()

void cudf::io::orc_reader_options::enable_use_np_dtypes ( bool use )

inline

启用/禁用使用与 numpy 兼容的数据类型。

参数

use	用于启用/禁用的布尔值

定义于文件 orc.hpp 的第 238 行。

◆ get_columns()

auto const& cudf::io::orc_reader_options::get_columns ( ) const

inline

返回要读取的列的名称（如果已设置）。

返回值: 要读取的列的名称；如果未设置该选项，则为 nullopt

定义于文件 orc.hpp 的第 114 行。

◆ get_decimal128_columns()

std::vector<std::string> const& cudf::io::orc_reader_options::get_decimal128_columns ( ) const

inline

返回应读取为 128 位 Decimal 的列的完全限定名称。

返回值: 应读取为 128 位 Decimal 的列的完全限定名称

定义于文件 orc.hpp 的第 164 行。

◆ get_num_rows()

std::optional<int64_t> const& cudf::io::orc_reader_options::get_num_rows ( ) const

inline

返回要读取的行数。

返回值: 要读取的行数；如果未设置该选项，则为 nullopt（在这种情况下，文件将读取到末尾）

定义于文件 orc.hpp 的第 136 行。

◆ get_skip_rows()

int64_t cudf::io::orc_reader_options::get_skip_rows ( ) const

inline

返回要从开头跳过的行数。

返回值: 要从开头跳过的行数

定义于文件 orc.hpp 的第 128 行。

◆ get_source()

source_info const& cudf::io::orc_reader_options::get_source ( ) const

inline

返回源信息。

返回值: 源信息

定义于文件 orc.hpp 的第 107 行。

◆ get_stripes()

auto const& cudf::io::orc_reader_options::get_stripes ( ) const

inline

返回向量的向量，表示每个输入源要读取的条带。

返回值: 向量的向量，表示每个输入源要读取的条带

定义于文件 orc.hpp 的第 121 行。

◆ get_timestamp_type()

data_type cudf::io::orc_reader_options::get_timestamp_type ( ) const

inline

返回时间戳列将被转换为的时间戳类型。

返回值: 时间戳列将被转换为的时间戳类型

定义于文件 orc.hpp 的第 157 行。

◆ is_enabled_use_index()

bool cudf::io::orc_reader_options::is_enabled_use_index ( ) const

inline

是否使用行索引来加速读取。

返回值: 如果使用行索引加速读取，则为 true

定义于文件 orc.hpp 的第 143 行。

◆ is_enabled_use_np_dtypes()

bool cudf::io::orc_reader_options::is_enabled_use_np_dtypes ( ) const

inline

是否使用与 numpy 兼容的数据类型。

返回值: 如果使用与 numpy 兼容的数据类型，则为 true

定义于文件 orc.hpp 的第 150 行。

◆ set_columns()

void cudf::io::orc_reader_options::set_columns ( std::vector< std::string > col_names )

inline

设置要读取的列的名称。

参数

col_names 列名称向量

定义于文件 orc.hpp 的第 176 行。

◆ set_decimal128_columns()

void cudf::io::orc_reader_options::set_decimal128_columns ( std::vector< std::string > val )

inline

设置应读取为 128 位 Decimal 的列。

参数

val 完全限定列名称向量

定义于文件 orc.hpp 的第 252 行。

◆ set_num_rows()

void cudf::io::orc_reader_options::set_num_rows ( int64_t nrows )

inline

设置要读取的行数。

参数

nrows 行数

异常

cudf::logic_error	如果传入负值
cudf::logic_error	如果之前已设置条带

定义于文件 orc.hpp 的第 219 行。

◆ set_skip_rows()

void cudf::io::orc_reader_options::set_skip_rows ( int64_t rows )

inline

设置要从开头跳过的行数。

参数

rows 行数

异常

cudf::logic_error	如果传入负值
cudf::logic_error	如果之前已设置条带

定义于文件 orc.hpp 的第 204 行。

◆ set_stripes()

void cudf::io::orc_reader_options::set_stripes ( std::vector< std::vector< size_type >> stripes )

inline

设置每个输入源要读取的条带列表。

参数

stripes 向量的向量，映射要读取的条带到输入源

异常

cudf::logic_error	如果传入非空向量，并且之前已设置 `skip_rows`
cudf::logic_error	如果传入非空向量，并且之前已设置 `num_rows`

定义于文件 orc.hpp 的第 188 行。

◆ set_timestamp_type()

void cudf::io::orc_reader_options::set_timestamp_type ( data_type type )

inline

设置时间戳列将被转换为的时间戳类型。

参数

type 时间戳类型

定义于文件 orc.hpp 的第 245 行。

本类的文档生成自以下文件

orc.hpp

公共成员函数

静态公共成员函数

详细描述

构造函数和析构函数文档

◆ orc_reader_options()

成员函数文档

◆ builder()

◆ enable_use_index()

◆ enable_use_np_dtypes()

◆ get_columns()

◆ get_decimal128_columns()

◆ get_num_rows()

◆ get_skip_rows()

◆ get_source()

◆ get_stripes()

◆ get_timestamp_type()

◆ is_enabled_use_index()

◆ is_enabled_use_np_dtypes()

◆ set_columns()

◆ set_decimal128_columns()

◆ set_num_rows()

◆ set_skip_rows()

◆ set_stripes()

◆ set_timestamp_type()