libcudf  23.12.00
Public Types | Public Member Functions | List of all members
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.
 

Public Member Functions

 parquet_metadata (parquet_schema schema, int64_t num_rows, size_type num_rowgroups, key_value_metadata file_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...
 

Detailed Description

Information about content of a parquet file.

Definition at line 158 of file parquet_metadata.hpp.

Constructor & Destructor Documentation

◆ parquet_metadata()

cudf::io::parquet_metadata::parquet_metadata ( parquet_schema  schema,
int64_t  num_rows,
size_type  num_rowgroups,
key_value_metadata  file_metadata 
)
inline

constructor

Parameters
schemaparquet schema
num_rowsnumber of rows
num_rowgroupsnumber of row groups
file_metadatakey-value metadata in the file footer

Definition at line 171 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 209 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 203 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 196 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 187 of file parquet_metadata.hpp.


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