Public Member Functions | List of all members
cudf::io::orc_column_schema Struct Reference

Schema of an ORC column, including the nested columns. More...

#include <orc_metadata.hpp>

Public Member Functions

 orc_column_schema (std::string_view name, orc::TypeKind type, std::vector< orc_column_schema > children)
 constructor More...
 
auto name () const
 Returns ORC column name; can be empty. More...
 
auto type_kind () const
 Returns ORC type of the column. More...
 
auto const & children () const &
 Returns schemas of all child columns. More...
 
auto children () &&
 Returns schemas of all child columns. More...
 
auto const & child (int idx) const &
 Returns schema of the child with the given index. More...
 
auto child (int idx) &&
 Returns schema of the child with the given index. More...
 
auto num_children () const
 Returns the number of child columns. More...
 

Detailed Description

Schema of an ORC column, including the nested columns.

Definition at line 229 of file orc_metadata.hpp.

Constructor & Destructor Documentation

◆ orc_column_schema()

cudf::io::orc_column_schema::orc_column_schema ( std::string_view  name,
orc::TypeKind  type,
std::vector< orc_column_schema children 
)
inline

constructor

Parameters
namecolumn name
typeORC type
childrenchild columns (empty for non-nested types)

Definition at line 238 of file orc_metadata.hpp.

Member Function Documentation

◆ child() [1/2]

auto cudf::io::orc_column_schema::child ( int  idx) &&
inline

Returns schema of the child with the given index.

Parameters
idxchild index
Returns
Child schema Child is moved out of the object (rvalues only).

Definition at line 285 of file orc_metadata.hpp.

◆ child() [2/2]

auto const& cudf::io::orc_column_schema::child ( int  idx) const &
inline

Returns schema of the child with the given index.

Parameters
idxchild index
Returns
Child schema

Definition at line 279 of file orc_metadata.hpp.

◆ children() [1/2]

auto cudf::io::orc_column_schema::children ( ) &&
inline

Returns schemas of all child columns.

Returns
Children schemas Children array is moved out of the object (rvalues only).

Definition at line 270 of file orc_metadata.hpp.

◆ children() [2/2]

auto const& cudf::io::orc_column_schema::children ( ) const &
inline

Returns schemas of all child columns.

Returns
Children schemas

Definition at line 264 of file orc_metadata.hpp.

◆ name()

auto cudf::io::orc_column_schema::name ( ) const
inline

Returns ORC column name; can be empty.

Returns
Column name

Definition at line 250 of file orc_metadata.hpp.

◆ num_children()

auto cudf::io::orc_column_schema::num_children ( ) const
inline

Returns the number of child columns.

Returns
Children count

Definition at line 292 of file orc_metadata.hpp.

◆ type_kind()

auto cudf::io::orc_column_schema::type_kind ( ) const
inline

Returns ORC type of the column.

Returns
Column ORC type

Definition at line 257 of file orc_metadata.hpp.


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