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

Schema of a parquet column, including the nested columns. More...

#include <parquet_metadata.hpp>

Public Member Functions

 parquet_column_schema ()
 Default constructor. More...
 
 parquet_column_schema (std::string_view name, Type type, std::vector< parquet_column_schema > &&children, data_type cudf_type)
 constructor More...
 
auto name () const
 Returns parquet column name; can be empty. More...
 
auto type () const
 Returns parquet physical 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...
 
auto cudf_type () const
 Returns the cudf data type for this column. More...
 

Detailed Description

Schema of a parquet column, including the nested columns.

Definition at line 35 of file parquet_metadata.hpp.

Constructor & Destructor Documentation

◆ parquet_column_schema() [1/2]

cudf::io::parquet_column_schema::parquet_column_schema ( )
inlineexplicit

Default constructor.

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

Definition at line 42 of file parquet_metadata.hpp.

◆ parquet_column_schema() [2/2]

cudf::io::parquet_column_schema::parquet_column_schema ( std::string_view  name,
Type  type,
std::vector< parquet_column_schema > &&  children,
data_type  cudf_type 
)
inline

constructor

Parameters
namecolumn name
typeparquet type
childrenchild columns (empty for non-nested types)
cudf_typecudf data type

Definition at line 52 of file parquet_metadata.hpp.

Member Function Documentation

◆ child() [1/2]

auto cudf::io::parquet_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 100 of file parquet_metadata.hpp.

◆ child() [2/2]

auto const& cudf::io::parquet_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 94 of file parquet_metadata.hpp.

◆ children() [1/2]

auto cudf::io::parquet_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 85 of file parquet_metadata.hpp.

◆ children() [2/2]

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

Returns schemas of all child columns.

Returns
Children schemas

Definition at line 79 of file parquet_metadata.hpp.

◆ cudf_type()

auto cudf::io::parquet_column_schema::cudf_type ( ) const
inline

Returns the cudf data type for this column.

This is the resolved cudf data type mapped from the Parquet physical/logical types.

Returns
cudf data type

Definition at line 116 of file parquet_metadata.hpp.

◆ name()

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

Returns parquet column name; can be empty.

Returns
Column name

Definition at line 65 of file parquet_metadata.hpp.

◆ num_children()

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

Returns the number of child columns.

Returns
Children count

Definition at line 107 of file parquet_metadata.hpp.

◆ type()

auto cudf::io::parquet_column_schema::type ( ) const
inline

Returns parquet physical type of the column.

Returns
Column parquet physical type

Definition at line 72 of file parquet_metadata.hpp.


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