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.
using	column_chunk_metadata = std::unordered_map< std::string, std::vector< int64_t > >
	Column chunk metadata from each ColumnChunkMetaData element.

Public Member Functions
	parquet_metadata ()=default
	Default constructor. More...
	parquet_metadata (parquet_schema schema, int64_t num_rows, size_type num_rowgroups, std::vector< size_type > num_rowgroups_per_file, key_value_metadata file_metadata, std::vector< row_group_metadata > rg_metadata, column_chunk_metadata column_chunk_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 total number of rowgroups. More...
auto const &	num_rowgroups_per_file () const
	Returns the number of rowgroups in each 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...
auto const &	columnchunk_metadata () const
	Returns a map of column names to vectors of total_uncompressed_size metadata from all their column chunks. More...

Detailed Description

Information about content of a parquet file.

Definition at line 163 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, std::vector< size_type >  num_rowgroups_per_file, key_value_metadata  file_metadata, std::vector< row_group_metadata >  rg_metadata, column_chunk_metadata  column_chunk_metadata  )

inline

constructor

Parameters

schema	parquet schema
num_rows	number of rows
num_rowgroups	total number of row groups
num_rowgroups_per_file	number of row groups per file
file_metadata	key-value metadata in the file footer
rg_metadata	vector of maps containing metadata for each row group
column_chunk_metadata	map of column names to vectors of total_uncompressed_size metadata from all their column chunks

Definition at line 191 of file parquet_metadata.hpp.

Member Function Documentation

columnchunk_metadata()

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

inline

Returns a map of column names to vectors of total_uncompressed_size metadata from all their column chunks.

Returns

Map of column names to vectors of total_uncompressed_size metadata from all their column chunks

Definition at line 259 of file parquet_metadata.hpp.

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 total number of rowgroups.

Returns

Total number of row groups

Definition at line 229 of file parquet_metadata.hpp.

num_rowgroups_per_file()

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

inline

Returns the number of rowgroups in each file.

Returns

Number of row groups per file

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 222 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 213 of file parquet_metadata.hpp.

---

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

• parquet_metadata.hpp