Serialized Form

Package org.apache.parquet.format

Class org.apache.parquet.format.AesGcmCtrV1

class AesGcmCtrV1 extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

aad_file_unique

ByteBuffer aad_file_unique

Unique file identifier part of AAD suffix *

aad_prefix

ByteBuffer aad_prefix

AAD prefix *

supply_aad_prefix

boolean supply_aad_prefix

In files encrypted with AAD prefix without storing it, readers must supply the prefix *

Class org.apache.parquet.format.AesGcmV1

class AesGcmV1 extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

aad_file_unique

ByteBuffer aad_file_unique

Unique file identifier part of AAD suffix *

aad_prefix

ByteBuffer aad_prefix

AAD prefix *

supply_aad_prefix

boolean supply_aad_prefix

In files encrypted with AAD prefix without storing it, readers must supply the prefix *

Class org.apache.parquet.format.BloomFilterAlgorithm

class BloomFilterAlgorithm extends org.apache.thrift.TUnion<BloomFilterAlgorithm,BloomFilterAlgorithm._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.BloomFilterCompression

class BloomFilterCompression extends org.apache.thrift.TUnion<BloomFilterCompression,BloomFilterCompression._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.BloomFilterHash

class BloomFilterHash extends org.apache.thrift.TUnion<BloomFilterHash,BloomFilterHash._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.BloomFilterHeader

class BloomFilterHeader extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

algorithm

BloomFilterAlgorithm algorithm

The algorithm for setting bits. *

compression

BloomFilterCompression compression

The compression used in the Bloom filter *

hash

BloomFilterHash hash

The hash function used for Bloom filter. *

numBytes

int numBytes

The size of bitset in bytes *

Class org.apache.parquet.format.BoundingBox

class BoundingBox extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

mmax

double mmax

mmin

double mmin

xmax

double xmax

xmin

double xmin

ymax

double ymax

ymin

double ymin

zmax

double zmax

zmin

double zmin

Class org.apache.parquet.format.BsonType

class BsonType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.ColumnChunk

class ColumnChunk extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

column_index_length

int column_index_length

Size of ColumnChunk's ColumnIndex, in bytes *

column_index_offset

long column_index_offset

File offset of ColumnChunk's ColumnIndex *

crypto_metadata

ColumnCryptoMetaData crypto_metadata

Crypto metadata of encrypted columns *

encrypted_column_metadata

ByteBuffer encrypted_column_metadata

Encrypted column metadata for this chunk *

file_offset

long file_offset

DEPRECATED: Byte offset in file_path to the ColumnMetaData Past use of this field has been inconsistent, with some implementations using it to point to the ColumnMetaData and some using it to point to the first page in the column chunk. In many cases, the ColumnMetaData at this location is wrong. This field is now deprecated and should not be used. Writers should set this field to 0 if no ColumnMetaData has been written outside the footer.

file_path

String file_path

File where column data is stored. If not set, assumed to be same file as metadata. This path is relative to the current file. As of December 2025, the only known use-case for this field is writing summary parquet files (i.e. "_metadata" files). These files consolidate footers from multiple parquet files to allow for efficient reading of footers to avoid file listing costs and prune out files that do not need to be read based on statistics. These files do not appear to have ever been formally specified in the specification. and are potentially problematic from a correctness perspective [1]. [1] https://lists.apache.org/thread/ootf2kmyg3p01b1bvplpvp4ftd1bt72d There is no other known usage of this field. Specifically, there are no known reference implementations that will read externally stored column data if this field is populated within a standard parquet file. Making use of the field for this purpose is not considered part of the Parquet specification.

meta_data

ColumnMetaData meta_data

Column metadata for this chunk. Some writers may also replicate this at the location pointed to by file_path/file_offset. Note: while marked as optional, this field is in fact required by most major Parquet implementations. As such, writers MUST populate this field.

offset_index_length

int offset_index_length

Size of ColumnChunk's OffsetIndex, in bytes *

offset_index_offset

long offset_index_offset

File offset of ColumnChunk's OffsetIndex *

Class org.apache.parquet.format.ColumnCryptoMetaData

class ColumnCryptoMetaData extends org.apache.thrift.TUnion<ColumnCryptoMetaData,ColumnCryptoMetaData._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.ColumnIndex

class ColumnIndex extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

boundary_order

BoundaryOrder boundary_order

Stores whether both min_values and max_values are ordered and if so, in which direction. This allows readers to perform binary searches in both lists. Readers cannot assume that max_values[i] <= min_values[i+1], even if the lists are ordered.

See Also:

• BoundaryOrder

definition_level_histograms

List<Long> definition_level_histograms

Same as repetition_level_histograms except for definitions levels.

max_values

List<ByteBuffer> max_values

min_values

List<ByteBuffer> min_values

Two lists containing lower and upper bounds for the values of each page determined by the ColumnOrder of the column. These may be the actual minimum and maximum values found on a page, but can also be (more compact) values that do not exist on a page. For example, instead of storing "Blart Versenwald III", a writer may set min_values[i]="B", max_values[i]="C". Such more compact values must still be valid values within the column's logical type. Readers must make sure that list entries are populated before using them by inspecting null_pages. For columns of physical type FLOAT or DOUBLE, or logical type FLOAT16, NaN values are not to be included in these bounds. If all non-null values of a page are NaN, then a writer must do the following: - If the order of this column is TYPE_ORDER, then a column index must not be written for this column chunk. While this is unfortunate for performance, it is necessary to avoid conflict with legacy files that still included NaN in min_values and max_values even if the page had non-NaN values. To mitigate this, IEEE754_TOTAL_ORDER is recommended. - If the order of this column is IEEE754_TOTAL_ORDER, then min_values[i] and max_values[i] of that page must be set to the smallest and largest NaN values as defined by IEEE 754 total order.

nan_counts

List<Long> nan_counts

A list containing the number of NaN values for each page. Only present for columns of physical type FLOAT or DOUBLE, or logical type FLOAT16. If this field is not present, readers MUST assume that there might be NaN values in any page.

null_counts

List<Long> null_counts

A list containing the number of null values for each page Writers SHOULD always write this field even if no null values are present or the column is not nullable. Readers MUST distinguish between null_counts not being present and null_count being 0. If null_counts are not present, readers MUST NOT assume all null counts are 0.

null_pages

List<Boolean> null_pages

A list of Boolean values to determine the validity of the corresponding min and max values. If true, a page contains only null values, and writers have to set the corresponding entries in min_values and max_values to byte[0], so that all lists have the same length. If false, the corresponding entries in min_values and max_values must be valid.

repetition_level_histograms

List<Long> repetition_level_histograms

Contains repetition level histograms for each page concatenated together. The repetition_level_histogram field on SizeStatistics contains more details. When present the length should always be (number of pages * (max_repetition_level + 1)) elements. Element 0 is the first element of the histogram for the first page. Element (max_repetition_level + 1) is the first element of the histogram for the second page.

Class org.apache.parquet.format.ColumnMetaData

class ColumnMetaData extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

bloom_filter_length

int bloom_filter_length

Size of Bloom filter data including the serialized header, in bytes. Added in 2.10 so readers may not read this field from old files and it can be obtained after the BloomFilterHeader has been deserialized. Writers should write this field so readers can read the bloom filter in a single I/O.

bloom_filter_offset

long bloom_filter_offset

Byte offset from beginning of file to Bloom filter data. *

codec

CompressionCodec codec

Compression codec *

See Also:

• CompressionCodec

data_page_offset

long data_page_offset

Byte offset from beginning of file to first data page *

dictionary_page_offset

long dictionary_page_offset

Byte offset from the beginning of file to first (only) dictionary page *

encoding_stats

List<PageEncodingStats> encoding_stats

Set of all encodings used for pages in this column chunk. This information can be used to determine if all data pages are dictionary encoded for example *

encodings

List<Encoding> encodings

Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *

geospatial_statistics

GeospatialStatistics geospatial_statistics

Optional statistics specific for Geometry and Geography logical types

index_page_offset

long index_page_offset

Byte offset from beginning of file to root index page *

key_value_metadata

List<KeyValue> key_value_metadata

Optional key/value metadata *

num_values

long num_values

Number of values in this column *

path_in_schema

List<String> path_in_schema

Path in schema *

size_statistics

SizeStatistics size_statistics

Optional statistics to help estimate total memory when converted to in-memory representations. The histograms contained in these statistics can also be useful in some cases for more fine-grained nullability/list length filter pushdown.

statistics

Statistics statistics

optional statistics for this column chunk

total_compressed_size

long total_compressed_size

total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *

total_uncompressed_size

long total_uncompressed_size

total byte size of all uncompressed pages in this column chunk (including the headers) *

type

Type type

Type of this column *

See Also:

• Type

Class org.apache.parquet.format.ColumnOrder

class ColumnOrder extends org.apache.thrift.TUnion<ColumnOrder,ColumnOrder._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.DataPageHeader

class DataPageHeader extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

definition_level_encoding

Encoding definition_level_encoding

Encoding used for definition levels *

See Also:

• Encoding

encoding

Encoding encoding

Encoding used for this data page *

See Also:

• Encoding

num_values

int num_values

Number of values, including NULLs, in this data page. If an OffsetIndex is present, a page must begin at a row boundary (repetition_level = 0). Otherwise, pages may begin within a row (repetition_level > 0).

repetition_level_encoding

Encoding repetition_level_encoding

Encoding used for repetition levels *

See Also:

• Encoding

statistics

Statistics statistics

Optional statistics for the data in this page *

Class org.apache.parquet.format.DataPageHeaderV2

class DataPageHeaderV2 extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

definition_levels_byte_length

int definition_levels_byte_length

Length of the definition levels

encoding

Encoding encoding

Encoding used for data in this page *

See Also:

• Encoding

is_compressed

boolean is_compressed

Whether the values are compressed. Which means the section of the page between definition_levels_byte_length + repetition_levels_byte_length and compressed_page_size (included) is compressed with the compression_codec. If missing it is considered compressed

num_nulls

int num_nulls

Number of NULL values, in this data page. Number of non-null = num_values - num_nulls which is also the number of values in the data section *

num_rows

int num_rows

Number of rows in this data page. Every page must begin at a row boundary (repetition_level = 0): rows must **not** be split across page boundaries when using V2 data pages.

num_values

int num_values

Number of values, including NULLs, in this data page. *

repetition_levels_byte_length

int repetition_levels_byte_length

Length of the repetition levels

statistics

Statistics statistics

Optional statistics for the data in this page *

Class org.apache.parquet.format.DateType

class DateType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.DecimalType

class DecimalType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

precision

int precision

scale

int scale

Class org.apache.parquet.format.DictionaryPageHeader

class DictionaryPageHeader extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

encoding

Encoding encoding

Encoding using this dictionary page *

See Also:

• Encoding

is_sorted

boolean is_sorted

If true, the entries in the dictionary are sorted in ascending order *

num_values

int num_values

Number of values in the dictionary *

Class org.apache.parquet.format.EncryptionAlgorithm

class EncryptionAlgorithm extends org.apache.thrift.TUnion<EncryptionAlgorithm,EncryptionAlgorithm._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.EncryptionWithColumnKey

class EncryptionWithColumnKey extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

key_metadata

ByteBuffer key_metadata

Retrieval metadata of column encryption key *

path_in_schema

List<String> path_in_schema

Column path in schema *

Class org.apache.parquet.format.EncryptionWithFooterKey

class EncryptionWithFooterKey extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.EnumType

class EnumType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.FileCryptoMetaData

class FileCryptoMetaData extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

encryption_algorithm

EncryptionAlgorithm encryption_algorithm

Encryption algorithm. This field is only used for files with encrypted footer. Files with plaintext footer store algorithm id inside footer (FileMetaData structure).

key_metadata

ByteBuffer key_metadata

Retrieval metadata of key used for encryption of footer, and (possibly) columns *

Class org.apache.parquet.format.FileMetaData

class FileMetaData extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

column_orders

List<ColumnOrder> column_orders

Sort order used for the min_value and max_value fields in the Statistics objects and the min_values and max_values fields in the ColumnIndex objects of each column in this file. Sort orders are listed in the order matching the columns in the schema. The indexes are not necessarily the same though, because only leaf nodes of the schema are represented in the list of sort orders. Without column_orders, the meaning of the min_value and max_value fields in the Statistics object and the ColumnIndex object is undefined. To ensure well-defined behaviour, if these fields are written to a Parquet file, column_orders must be written as well. The obsolete min and max fields in the Statistics object are always sorted by signed comparison regardless of column_orders.

created_by

String created_by

String for application that wrote this file. This should be in the format version (build ). e.g. impala version 1.0 (build 6cf94d29b2b7115df4de2c06e2ab4326d721eb55)

encryption_algorithm

EncryptionAlgorithm encryption_algorithm

Encryption algorithm. This field is set only in encrypted files with plaintext footer. Files with encrypted footer store algorithm id in FileCryptoMetaData structure.

footer_signing_key_metadata

ByteBuffer footer_signing_key_metadata

Retrieval metadata of key used for signing the footer. Used only in encrypted files with plaintext footer.

key_value_metadata

List<KeyValue> key_value_metadata

Optional key/value metadata *

num_rows

long num_rows

Number of rows in this file *

row_groups

List<RowGroup> row_groups

Row groups in this file *

schema

List<SchemaElement> schema

Parquet schema for this file. This schema contains metadata for all the columns. The schema is represented as a tree with a single root. The nodes of the tree are flattened to a list by doing a depth-first traversal. The column metadata contains the path in the schema for that column which can be used to map columns to nodes in the schema. The first element is the root *

version

int version

Version of this file As of December 2025, there is no agreed upon consensus of what constitutes version 2 of the file. For maximum compatibility with readers, writers should always populate "1" for version. For maximum compatibility with writers, readers should accept "1" and "2" interchangeably. All other versions are reserved for potential future use-cases.

Class org.apache.parquet.format.Float16Type

class Float16Type extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.GeographyType

class GeographyType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

algorithm

EdgeInterpolationAlgorithm algorithm

See Also:

• EdgeInterpolationAlgorithm

crs

String crs

Class org.apache.parquet.format.GeometryType

class GeometryType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

crs

String crs

Class org.apache.parquet.format.GeospatialStatistics

class GeospatialStatistics extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

bbox

BoundingBox bbox

A bounding box of geospatial instances

geospatial_types

List<Integer> geospatial_types

Geospatial type codes of all instances, or an empty list if not known

Class org.apache.parquet.format.IEEE754TotalOrder

class IEEE754TotalOrder extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.IndexPageHeader

class IndexPageHeader extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.IntType

class IntType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

bitWidth

byte bitWidth

isSigned

boolean isSigned

Exception org.apache.parquet.format.InvalidParquetMetadataException

class InvalidParquetMetadataException extends RuntimeException implements Serializable

Class org.apache.parquet.format.JsonType

class JsonType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.KeyValue

class KeyValue extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

key

String key

value

String value

Class org.apache.parquet.format.ListType

class ListType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.LogicalType

class LogicalType extends org.apache.thrift.TUnion<LogicalType,LogicalType._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.MapType

class MapType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.MicroSeconds

class MicroSeconds extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.MilliSeconds

class MilliSeconds extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.NanoSeconds

class NanoSeconds extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.NullType

class NullType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.OffsetIndex

class OffsetIndex extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

page_locations

List<PageLocation> page_locations

PageLocations, ordered by increasing PageLocation.offset. It is required that page_locations[i].first_row_index < page_locations[i+1].first_row_index.

unencoded_byte_array_data_bytes

List<Long> unencoded_byte_array_data_bytes

Unencoded/uncompressed size for BYTE_ARRAY types. See documentation for unencoded_byte_array_data_bytes in SizeStatistics for more details on this field.

Class org.apache.parquet.format.PageEncodingStats

class PageEncodingStats extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

count

int count

number of pages of this type with this encoding *

encoding

Encoding encoding

encoding of the page *

See Also:

• Encoding

page_type

PageType page_type

the page type (data/dic/...) *

See Also:

• PageType

Class org.apache.parquet.format.PageHeader

class PageHeader extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

compressed_page_size

int compressed_page_size

Compressed (and potentially encrypted) page size in bytes, not including this header *

crc

int crc

The 32-bit CRC checksum for the page, to be calculated as follows: - The standard CRC32 algorithm is used (with polynomial 0x04C11DB7, the same as in e.g. GZIP). - All page types can have a CRC (v1 and v2 data pages, dictionary pages, etc.). - The CRC is computed on the serialization binary representation of the page (as written to disk), excluding the page header. For example, for v1 data pages, the CRC is computed on the concatenation of repetition levels, definition levels and column values (optionally compressed, optionally encrypted). - The CRC computation therefore takes place after any compression and encryption steps, if any. If enabled, this allows for disabling checksumming in HDFS if only a few pages need to be read.

data_page_header

DataPageHeader data_page_header

data_page_header_v2

DataPageHeaderV2 data_page_header_v2

dictionary_page_header

DictionaryPageHeader dictionary_page_header

index_page_header

IndexPageHeader index_page_header

type

PageType type

the type of the page: indicates which of the *_header fields is set *

See Also:

• PageType

uncompressed_page_size

int uncompressed_page_size

Uncompressed page size in bytes (not including this header) *

Class org.apache.parquet.format.PageLocation

class PageLocation extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

compressed_page_size

int compressed_page_size

Size of the page, including header. Equal to the sum of the page's PageHeader.compressed_page_size and the size of the serialized PageHeader.

first_row_index

long first_row_index

Index within the RowGroup of the first row of the page. When an OffsetIndex is present, pages must begin on row boundaries (repetition_level = 0).

offset

long offset

Offset of the page in the file *

Class org.apache.parquet.format.RowGroup

class RowGroup extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

columns

List<ColumnChunk> columns

Metadata for each column chunk in this row group. This list must have the same order as the SchemaElement list in FileMetaData.

file_offset

long file_offset

Byte offset from beginning of file to first page (data or dictionary) in this row group *

num_rows

long num_rows

Number of rows in this row group *

ordinal

short ordinal

Row group ordinal in the file *

sorting_columns

List<SortingColumn> sorting_columns

If set, specifies a sort ordering of the rows in this RowGroup. The sorting columns can be a subset of all the columns.

total_byte_size

long total_byte_size

Total byte size of all the uncompressed column data in this row group *

total_compressed_size

long total_compressed_size

Total byte size of all compressed (and potentially encrypted) column data in this row group *

Class org.apache.parquet.format.SchemaElement

class SchemaElement extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

converted_type

ConvertedType converted_type

DEPRECATED: When the schema is the result of a conversion from another model. Used to record the original type to help with cross conversion. This is superseded by logicalType.

See Also:

• ConvertedType

field_id

int field_id

When the original schema supports field ids, this will save the original field id in the parquet schema

logicalType

LogicalType logicalType

The logical type of this SchemaElement LogicalType replaces ConvertedType, but ConvertedType is still required for some logical types to ensure forward-compatibility in format v1.

name

String name

Name of the field in the schema

num_children

int num_children

Nested fields. Since thrift does not support nested fields, the nesting is flattened to a single list by a depth-first traversal. The children count is used to construct the nested relationship. This field is not set when the element is a primitive type

precision

int precision

repetition_type

FieldRepetitionType repetition_type

repetition of the field. The root of the schema does not have a repetition_type. All other nodes must have one

See Also:

• FieldRepetitionType

scale

int scale

DEPRECATED: Used when this column contains decimal data. See the DECIMAL converted type for more details. This is superseded by using the DecimalType annotation in logicalType.

type

Type type

Data type for this field. Not set if the current element is a non-leaf node

See Also:

• Type

type_length

int type_length

If type is FIXED_LEN_BYTE_ARRAY, this is the byte length of the values. Otherwise, if specified, this is the maximum bit length to store any of the values. (e.g. a low cardinality INT col could have this set to 3). Note that this is in the schema, and therefore fixed for the entire file.

Class org.apache.parquet.format.SizeStatistics

class SizeStatistics extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

definition_level_histogram

List<Long> definition_level_histogram

Same as repetition_level_histogram except for definition levels. This field may be omitted if max_definition_level is 0 or 1 without loss of information.

repetition_level_histogram

List<Long> repetition_level_histogram

When present, there is expected to be one element corresponding to each repetition (i.e. size=max repetition_level+1) where each element represents the number of times the repetition level was observed in the data. This field may be omitted if max_repetition_level is 0 without loss of information.

unencoded_byte_array_data_bytes

long unencoded_byte_array_data_bytes

The number of physical bytes stored for BYTE_ARRAY data values assuming no encoding. This is exclusive of the bytes needed to store the length of each byte array. In other words, this field is equivalent to the `(size of PLAIN-ENCODING the byte array values) - (4 bytes * number of values written)`. To determine unencoded sizes of other types readers can use schema information multiplied by the number of non-null and null values. The number of null/non-null values can be inferred from the histograms below. For example, if a column chunk is dictionary-encoded with dictionary ["a", "bc", "cde"], and a data page contains the indices [0, 0, 1, 2], then this value for that data page should be 7 (1 + 1 + 2 + 3). This field should only be set for types that use BYTE_ARRAY as their physical type.

Class org.apache.parquet.format.SortingColumn

class SortingColumn extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

column_idx

int column_idx

The ordinal position of the column (in this row group) *

descending

boolean descending

If true, indicates this column is sorted in descending order. *

nulls_first

boolean nulls_first

If true, nulls will come before non-null values, otherwise, nulls go at the end.

Class org.apache.parquet.format.SplitBlockAlgorithm

class SplitBlockAlgorithm extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.Statistics

class Statistics extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

distinct_count

long distinct_count

count of distinct values occurring

is_max_value_exact

boolean is_max_value_exact

If true, max_value is the actual maximum value for a column

is_min_value_exact

boolean is_min_value_exact

If true, min_value is the actual minimum value for a column

max

ByteBuffer max

DEPRECATED: min and max value of the column. Use min_value and max_value. Values are encoded using PLAIN encoding, except that variable-length byte arrays do not include a length prefix. These fields encode min and max values determined by signed comparison only. New files should use the correct order for a column's logical type and store the values in the min_value and max_value fields. To support older readers, these may be set when the column order is signed.

max_value

ByteBuffer max_value

Lower and upper bound values for the column, determined by its ColumnOrder. These may be the actual minimum and maximum values found on a page or column chunk, but can also be (more compact) values that do not exist on a page or column chunk. For example, instead of storing "Blart Versenwald III", a writer may set min_value="B", max_value="C". Such more compact values must still be valid values within the column's logical type. Values are encoded using PLAIN encoding, except that variable-length byte arrays do not include a length prefix.

min

ByteBuffer min

min_value

ByteBuffer min_value

nan_count

long nan_count

Count of NaN values in the column; only present if physical type is FLOAT or DOUBLE, or logical type is FLOAT16. If this field is not present, readers MUST assume NaNs may be present (i.e. MUST assume nan_count > 0 and MAY NOT assume nan_count == 0).

null_count

long null_count

Count of null values in the column. Writers SHOULD always write this field even if it is zero (i.e. no null value) or the column is not nullable. Readers MUST distinguish between null_count not being present and null_count == 0. If null_count is not present, readers MUST NOT assume null_count == 0.

Class org.apache.parquet.format.StringType

class StringType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.TimestampType

class TimestampType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

isAdjustedToUTC

boolean isAdjustedToUTC

unit

TimeUnit unit

Class org.apache.parquet.format.TimeType

class TimeType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

isAdjustedToUTC

boolean isAdjustedToUTC

unit

TimeUnit unit

Class org.apache.parquet.format.TimeUnit

class TimeUnit extends org.apache.thrift.TUnion<TimeUnit,TimeUnit._Fields> implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.TypeDefinedOrder

class TypeDefinedOrder extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.Uncompressed

class Uncompressed extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.UUIDType

class UUIDType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Class org.apache.parquet.format.VariantType

class VariantType extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException

Serialized Fields

__isset_bitfield

byte __isset_bitfield

specification_version

byte specification_version

Class org.apache.parquet.format.XxHash

class XxHash extends Object implements Serializable

Serialization Methods

readObject

private void readObject(ObjectInputStream in)
                 throws IOException,
ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeObject

private void writeObject(ObjectOutputStream out)
                  throws IOException

Throws:

IOException