Flow PHP

ColumnMetaData

Description for column metadata.

Properties

$_TSPEC  : mixed
$bloom_filter_length  : int
Size of Bloom filter data including the serialized header, in bytes.
$bloom_filter_offset  : int
Byte offset from beginning of file to Bloom filter data. *.
$codec  : int
Compression codec *.
$data_page_offset  : int
Byte offset from beginning of file to first data page *.
$dictionary_page_offset  : int
Byte offset from the beginning of file to first (only) dictionary page *.
$encoding_stats  : array<string|int, PageEncodingStats>
Set of all encodings used for pages in this column chunk.
$encodings  : array<string|int, int>
Set of all encodings used for this column. The purpose is to validate whether we can decode those pages. *.
$index_page_offset  : int
Byte offset from beginning of file to root index page *.
$isValidate  : mixed
$key_value_metadata  : array<string|int, KeyValue>
Optional key/value metadata *.
$num_values  : int
Number of values in this column *.
$path_in_schema  : array<string|int, string>
Path in schema *.
$size_statistics  : SizeStatistics
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
optional statistics for this column chunk.
$total_compressed_size  : int
total byte size of all compressed, and potentially encrypted, pages in this column chunk (including the headers) *.
$total_uncompressed_size  : int
total byte size of all uncompressed pages in this column chunk (including the headers) *.
$type  : int
Type of this column *.

Methods

__construct()  : mixed
getName()  : mixed
read()  : mixed
write()  : mixed

Properties

$_TSPEC

public static mixed $_TSPEC = [1 => ['var' => 'type', 'isRequired' => true, 'type' => \Thrift\Type\TType::I32, 'class' => '\Flow\Parquet\Thrift\Type'], 2 => ['var' => 'encodings', 'isRequired' => true, 'type' => \Thrift\Type\TType::LST, 'etype' => \Thrift\Type\TType::I32, 'elem' => ['type' => \Thrift\Type\TType::I32, 'class' => '\Flow\Parquet\Thrift\Encoding']], 3 => ['var' => 'path_in_schema', 'isRequired' => true, 'type' => \Thrift\Type\TType::LST, 'etype' => \Thrift\Type\TType::STRING, 'elem' => ['type' => \Thrift\Type\TType::STRING]], 4 => ['var' => 'codec', 'isRequired' => true, 'type' => \Thrift\Type\TType::I32, 'class' => '\Flow\Parquet\Thrift\CompressionCodec'], 5 => ['var' => 'num_values', 'isRequired' => true, 'type' => \Thrift\Type\TType::I64], 6 => ['var' => 'total_uncompressed_size', 'isRequired' => true, 'type' => \Thrift\Type\TType::I64], 7 => ['var' => 'total_compressed_size', 'isRequired' => true, 'type' => \Thrift\Type\TType::I64], 8 => ['var' => 'key_value_metadata', 'isRequired' => false, 'type' => \Thrift\Type\TType::LST, 'etype' => \Thrift\Type\TType::STRUCT, 'elem' => ['type' => \Thrift\Type\TType::STRUCT, 'class' => '\Flow\Parquet\Thrift\KeyValue']], 9 => ['var' => 'data_page_offset', 'isRequired' => true, 'type' => \Thrift\Type\TType::I64], 10 => ['var' => 'index_page_offset', 'isRequired' => false, 'type' => \Thrift\Type\TType::I64], 11 => ['var' => 'dictionary_page_offset', 'isRequired' => false, 'type' => \Thrift\Type\TType::I64], 12 => ['var' => 'statistics', 'isRequired' => false, 'type' => \Thrift\Type\TType::STRUCT, 'class' => '\Flow\Parquet\Thrift\Statistics'], 13 => ['var' => 'encoding_stats', 'isRequired' => false, 'type' => \Thrift\Type\TType::LST, 'etype' => \Thrift\Type\TType::STRUCT, 'elem' => ['type' => \Thrift\Type\TType::STRUCT, 'class' => '\Flow\Parquet\Thrift\PageEncodingStats']], 14 => ['var' => 'bloom_filter_offset', 'isRequired' => false, 'type' => \Thrift\Type\TType::I64], 15 => ['var' => 'bloom_filter_length', 'isRequired' => false, 'type' => \Thrift\Type\TType::I32], 16 => ['var' => 'size_statistics', 'isRequired' => false, 'type' => \Thrift\Type\TType::STRUCT, 'class' => '\Flow\Parquet\Thrift\SizeStatistics']]

$bloom_filter_length

Size of Bloom filter data including the serialized header, in bytes.

public int $bloom_filter_length

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

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

public int $bloom_filter_offset

$data_page_offset

Byte offset from beginning of file to first data page *.

public int $data_page_offset

$dictionary_page_offset

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

public int $dictionary_page_offset

$encoding_stats

Set of all encodings used for pages in this column chunk.

public array<string|int, PageEncodingStats> $encoding_stats

This information can be used to determine if all data pages are dictionary encoded for example *.

$encodings

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

public array<string|int, int> $encodings

$index_page_offset

Byte offset from beginning of file to root index page *.

public int $index_page_offset

$key_value_metadata

Optional key/value metadata *.

public array<string|int, KeyValue> $key_value_metadata

$num_values

Number of values in this column *.

public int $num_values

$path_in_schema

Path in schema *.

public array<string|int, string> $path_in_schema

$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.

public SizeStatistics $size_statistics

$total_compressed_size

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

public int $total_compressed_size

$total_uncompressed_size

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

public int $total_uncompressed_size

Methods

__construct()

public __construct([mixed $vals = null ]) : mixed
Parameters
$vals : mixed = null

read()

public read(mixed $input) : mixed
Parameters
$input : mixed

write()

public write(mixed $output) : mixed
Parameters
$output : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results