cudf::io::parquet_metadata Class Reference

Information about content of a parquet file. More...

#include <parquet_metadata.hpp>

Public Types
using	key_value_metadata = std::unordered_map< std::string, std::string >
	Key-value metadata in the file footer.
using	row_group_metadata = std::unordered_map< std::string, int64_t >
	row group metadata from each RowGroup element.

Public Member Functions
	parquet_metadata ()=default
	Default constructor. More...
	parquet_metadata (parquet_schema schema, int64_t num_rows, size_type num_rowgroups, key_value_metadata file_metadata, std::vector< row_group_metadata > rg_metadata)
	constructor More...
auto const &	schema () const
	Returns the parquet schema. More...
auto	num_rows () const
	Returns the number of rows of the root column. More...
auto	num_rowgroups () const
	Returns the number of rowgroups in the file. More...
auto const &	metadata () const
	Returns the Key value metadata in the file footer. More...
auto const &	rowgroup_metadata () const
	Returns the row group metadata in the file footer. More...

Detailed Description

Information about content of a parquet file.

Definition at line 179 of file parquet_metadata.hpp.

Constructor & Destructor Documentation

parquet_metadata() [1/2]

cudf::io::parquet_metadata::parquet_metadata ( )

explicitdefault

Default constructor.

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

parquet_metadata() [2/2]

cudf::io::parquet_metadata::parquet_metadata ( parquet_schema  schema, int64_t  num_rows, size_type  num_rowgroups, key_value_metadata  file_metadata, std::vector< row_group_metadata >  rg_metadata  )

inline

constructor

Parameters

schema	parquet schema
num_rows	number of rows
num_rowgroups	number of row groups
file_metadata	key-value metadata in the file footer
rg_metadata	vector of maps containing metadata for each row group

Definition at line 202 of file parquet_metadata.hpp.

Member Function Documentation

metadata()

auto const& cudf::io::parquet_metadata::metadata ( ) const

inline

Returns the Key value metadata in the file footer.

Returns

Key value metadata as a map

Definition at line 243 of file parquet_metadata.hpp.

num_rowgroups()

auto cudf::io::parquet_metadata::num_rowgroups ( ) const

inline

Returns the number of rowgroups in the file.

Returns

Number of row groups

Definition at line 236 of file parquet_metadata.hpp.

num_rows()

auto cudf::io::parquet_metadata::num_rows ( ) const

inline

Returns the number of rows of the root column.

If a file contains list columns, nested columns can have a different number of rows.

Returns

Number of rows

Definition at line 229 of file parquet_metadata.hpp.

rowgroup_metadata()

auto const& cudf::io::parquet_metadata::rowgroup_metadata ( ) const

inline

Returns the row group metadata in the file footer.

Returns

vector of row group metadata as maps

Definition at line 250 of file parquet_metadata.hpp.

schema()

auto const& cudf::io::parquet_metadata::schema ( ) const

inline

Returns the parquet schema.

Returns

parquet schema

Definition at line 220 of file parquet_metadata.hpp.

---

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

• parquet_metadata.hpp