cudf::io::orc_reader_options_builder Class Reference

Builds settings to use for read_orc(). More...

#include <orc.hpp>

Public Member Functions
	orc_reader_options_builder ()=default
	Default constructor. More...
	orc_reader_options_builder (source_info src)
	Constructor from source info. More...
orc_reader_options_builder &	columns (std::vector< std::string > col_names)
	Sets names of the column to read. More...
orc_reader_options_builder &	stripes (std::vector< std::vector< size_type >> stripes)
	Sets list of individual stripes to read per source. More...
orc_reader_options_builder &	skip_rows (int64_t rows)
	Sets number of rows to skip from the start. More...
orc_reader_options_builder &	num_rows (int64_t nrows)
	Sets number of row to read. More...
orc_reader_options_builder &	use_index (bool use)
	Enable/Disable use of row index to speed-up reading. More...
orc_reader_options_builder &	use_np_dtypes (bool use)
	Enable/Disable use of numpy-compatible dtypes. More...
orc_reader_options_builder &	timestamp_type (data_type type)
	Sets timestamp type to which timestamp column will be cast. More...
orc_reader_options_builder &	decimal128_columns (std::vector< std::string > val)
	Columns that should be read as 128-bit Decimal. More...
orc_reader_options_builder &	ignore_timezone_in_stripe_footer (bool ignore)
	Set whether to ignore writer timezone in the stripe footer. More...
	operator orc_reader_options && ()
	move orc_reader_options member once it's built.
orc_reader_options &&	build ()
	move orc_reader_options member once it's built. More...

Detailed Description

Builds settings to use for read_orc().

Definition at line 296 of file orc.hpp.

Constructor & Destructor Documentation

orc_reader_options_builder() [1/2]

cudf::io::orc_reader_options_builder::orc_reader_options_builder ( )

explicitdefault

Default constructor.

This has been added since Cython requires a default constructor to create objects on stack.

orc_reader_options_builder() [2/2]

cudf::io::orc_reader_options_builder::orc_reader_options_builder ( source_info  src )

inlineexplicit

Constructor from source info.

Parameters

src	The source information used to read orc file

Definition at line 312 of file orc.hpp.

Member Function Documentation

build()

orc_reader_options&& cudf::io::orc_reader_options_builder::build ( )

inline

move orc_reader_options member once it's built.

This has been added since Cython does not support overloading of conversion operators.

Returns

Built orc_reader_options object's r-value reference

Definition at line 434 of file orc.hpp.

columns()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::columns ( std::vector< std::string >  col_names )

inline

Sets names of the column to read.

Parameters

col_names

Vector of column names

Returns

this for chaining

Definition at line 320 of file orc.hpp.

decimal128_columns()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::decimal128_columns ( std::vector< std::string >  val )

inline

Columns that should be read as 128-bit Decimal.

Parameters

val	Vector of column names

Returns

this for chaining

Definition at line 404 of file orc.hpp.

ignore_timezone_in_stripe_footer()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::ignore_timezone_in_stripe_footer ( bool  ignore )

inline

Set whether to ignore writer timezone in the stripe footer.

Parameters

ignore

Boolean value to enable/disable ignoring writer timezone

Returns

this for chaining

Definition at line 416 of file orc.hpp.

num_rows()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::num_rows ( int64_t  nrows )

inline

Sets number of row to read.

Parameters

nrows

Number of rows

Returns

this for chaining

Definition at line 356 of file orc.hpp.

skip_rows()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::skip_rows ( int64_t  rows )

inline

Sets number of rows to skip from the start.

Parameters

rows	Number of rows

Returns

this for chaining

Definition at line 344 of file orc.hpp.

stripes()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::stripes ( std::vector< std::vector< size_type >>  stripes )

inline

Sets list of individual stripes to read per source.

Parameters

stripes

Vector of vectors, mapping stripes to read to input sources

Returns

this for chaining

Definition at line 332 of file orc.hpp.

timestamp_type()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::timestamp_type ( data_type  type )

inline

Sets timestamp type to which timestamp column will be cast.

Parameters

type	Type of timestamp

Returns

this for chaining

Definition at line 392 of file orc.hpp.

use_index()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::use_index ( bool  use )

inline

Enable/Disable use of row index to speed-up reading.

Parameters

use	Boolean value to enable/disable row index use

Returns

this for chaining

Definition at line 368 of file orc.hpp.

use_np_dtypes()

orc_reader_options_builder& cudf::io::orc_reader_options_builder::use_np_dtypes ( bool  use )

inline

Enable/Disable use of numpy-compatible dtypes.

Parameters

use	Boolean value to enable/disable

Returns

this for chaining

Definition at line 380 of file orc.hpp.

---

The documentation for this class was generated from the following file:

• orc.hpp