-
Notifications
You must be signed in to change notification settings - Fork 3.5k
/
metadata.h
560 lines (457 loc) · 20.3 KB
/
metadata.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
#pragma once
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <string>
#include <utility>
#include <vector>
#include "parquet/encryption/type_fwd.h"
#include "parquet/platform.h"
#include "parquet/properties.h"
#include "parquet/schema.h"
#include "parquet/types.h"
namespace parquet {
class ColumnDescriptor;
class EncodedStatistics;
class FileCryptoMetaData;
class Statistics;
class SchemaDescriptor;
namespace schema {
class ColumnPath;
} // namespace schema
using KeyValueMetadata = ::arrow::KeyValueMetadata;
class PARQUET_EXPORT ApplicationVersion {
public:
// Known Versions with Issues
static const ApplicationVersion& PARQUET_251_FIXED_VERSION();
static const ApplicationVersion& PARQUET_816_FIXED_VERSION();
static const ApplicationVersion& PARQUET_CPP_FIXED_STATS_VERSION();
static const ApplicationVersion& PARQUET_MR_FIXED_STATS_VERSION();
static const ApplicationVersion& PARQUET_CPP_10353_FIXED_VERSION();
// Application that wrote the file. e.g. "IMPALA"
std::string application_;
// Build name
std::string build_;
// Version of the application that wrote the file, expressed as
// (<major>.<minor>.<patch>). Unmatched parts default to 0.
// "1.2.3" => {1, 2, 3}
// "1.2" => {1, 2, 0}
// "1.2-cdh5" => {1, 2, 0}
struct {
int major;
int minor;
int patch;
std::string unknown;
std::string pre_release;
std::string build_info;
} version;
ApplicationVersion() = default;
explicit ApplicationVersion(const std::string& created_by);
ApplicationVersion(std::string application, int major, int minor, int patch);
// Returns true if version is strictly less than other_version
bool VersionLt(const ApplicationVersion& other_version) const;
// Returns true if version is strictly equal with other_version
bool VersionEq(const ApplicationVersion& other_version) const;
// Checks if the Version has the correct statistics for a given column
bool HasCorrectStatistics(Type::type primitive, EncodedStatistics& statistics,
SortOrder::type sort_order = SortOrder::SIGNED) const;
};
class PARQUET_EXPORT ColumnCryptoMetaData {
public:
static std::unique_ptr<ColumnCryptoMetaData> Make(const uint8_t* metadata);
~ColumnCryptoMetaData();
bool Equals(const ColumnCryptoMetaData& other) const;
std::shared_ptr<schema::ColumnPath> path_in_schema() const;
bool encrypted_with_footer_key() const;
const std::string& key_metadata() const;
private:
explicit ColumnCryptoMetaData(const uint8_t* metadata);
class ColumnCryptoMetaDataImpl;
std::unique_ptr<ColumnCryptoMetaDataImpl> impl_;
};
/// \brief Public struct for Thrift PageEncodingStats in ColumnChunkMetaData
struct PageEncodingStats {
PageType::type page_type;
Encoding::type encoding;
int32_t count;
};
/// \brief Public struct for location to page index in ColumnChunkMetaData.
struct IndexLocation {
/// File offset of the given index, in bytes
int64_t offset;
/// Length of the given index, in bytes
int32_t length;
};
/// \brief ColumnChunkMetaData is a proxy around format::ColumnChunkMetaData.
class PARQUET_EXPORT ColumnChunkMetaData {
public:
// API convenience to get a MetaData accessor
static std::unique_ptr<ColumnChunkMetaData> Make(
const void* metadata, const ColumnDescriptor* descr,
const ReaderProperties& properties = default_reader_properties(),
const ApplicationVersion* writer_version = NULLPTR, int16_t row_group_ordinal = -1,
int16_t column_ordinal = -1,
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
~ColumnChunkMetaData();
bool Equals(const ColumnChunkMetaData& other) const;
// Byte offset of `ColumnMetaData` in `file_path()`.
//
// Note that the meaning of this field has been inconsistent among implementations
// so its use has since been deprecated in the Parquet specification. Modern
// implementations will set this to `0` to indicate that the `ColumnMetaData` is solely
// contained in the `ColumnChunk` struct.
int64_t file_offset() const;
// parameter is only used when a dataset is spread across multiple files
const std::string& file_path() const;
// column metadata
bool is_metadata_set() const;
Type::type type() const;
int64_t num_values() const;
std::shared_ptr<schema::ColumnPath> path_in_schema() const;
bool is_stats_set() const;
std::shared_ptr<Statistics> statistics() const;
Compression::type compression() const;
// Indicate if the ColumnChunk compression is supported by the current
// compiled parquet library.
bool can_decompress() const;
const std::vector<Encoding::type>& encodings() const;
const std::vector<PageEncodingStats>& encoding_stats() const;
std::optional<int64_t> bloom_filter_offset() const;
std::optional<int64_t> bloom_filter_length() const;
bool has_dictionary_page() const;
int64_t dictionary_page_offset() const;
int64_t data_page_offset() const;
bool has_index_page() const;
int64_t index_page_offset() const;
int64_t total_compressed_size() const;
int64_t total_uncompressed_size() const;
std::unique_ptr<ColumnCryptoMetaData> crypto_metadata() const;
std::optional<IndexLocation> GetColumnIndexLocation() const;
std::optional<IndexLocation> GetOffsetIndexLocation() const;
const std::shared_ptr<const KeyValueMetadata>& key_value_metadata() const;
private:
explicit ColumnChunkMetaData(
const void* metadata, const ColumnDescriptor* descr, int16_t row_group_ordinal,
int16_t column_ordinal, const ReaderProperties& properties,
const ApplicationVersion* writer_version = NULLPTR,
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
// PIMPL Idiom
class ColumnChunkMetaDataImpl;
std::unique_ptr<ColumnChunkMetaDataImpl> impl_;
};
/// \brief RowGroupMetaData is a proxy around format::RowGroupMetaData.
class PARQUET_EXPORT RowGroupMetaData {
public:
/// \brief Create a RowGroupMetaData from a serialized thrift message.
static std::unique_ptr<RowGroupMetaData> Make(
const void* metadata, const SchemaDescriptor* schema,
const ReaderProperties& properties = default_reader_properties(),
const ApplicationVersion* writer_version = NULLPTR,
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
~RowGroupMetaData();
bool Equals(const RowGroupMetaData& other) const;
/// \brief The number of columns in this row group. The order must match the
/// parent's column ordering.
int num_columns() const;
/// \brief Return the ColumnChunkMetaData of the corresponding column ordinal.
///
/// WARNING, the returned object references memory location in it's parent
/// (RowGroupMetaData) object. Hence, the parent must outlive the returned
/// object.
///
/// \param[in] index of the ColumnChunkMetaData to retrieve.
///
/// \throws ParquetException if the index is out of bound.
std::unique_ptr<ColumnChunkMetaData> ColumnChunk(int index) const;
/// \brief Number of rows in this row group.
int64_t num_rows() const;
/// \brief Total byte size of all the uncompressed column data in this row group.
int64_t total_byte_size() const;
/// \brief Total byte size of all the compressed (and potentially encrypted)
/// column data in this row group.
///
/// This information is optional and may be 0 if omitted.
int64_t total_compressed_size() const;
/// \brief Byte offset from beginning of file to first page (data or
/// dictionary) in this row group
///
/// The file_offset field that this method exposes is optional. This method
/// will return 0 if that field is not set to a meaningful value.
int64_t file_offset() const;
// Return const-pointer to make it clear that this object is not to be copied
const SchemaDescriptor* schema() const;
// Indicate if all of the RowGroup's ColumnChunks can be decompressed.
bool can_decompress() const;
// Sorting columns of the row group if any.
std::vector<SortingColumn> sorting_columns() const;
private:
explicit RowGroupMetaData(
const void* metadata, const SchemaDescriptor* schema,
const ReaderProperties& properties,
const ApplicationVersion* writer_version = NULLPTR,
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
// PIMPL Idiom
class RowGroupMetaDataImpl;
std::unique_ptr<RowGroupMetaDataImpl> impl_;
};
class FileMetaDataBuilder;
/// \brief FileMetaData is a proxy around format::FileMetaData.
class PARQUET_EXPORT FileMetaData {
public:
/// \brief Create a FileMetaData from a serialized thrift message.
static std::shared_ptr<FileMetaData> Make(
const void* serialized_metadata, uint32_t* inout_metadata_len,
const ReaderProperties& properties = default_reader_properties(),
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
~FileMetaData();
bool Equals(const FileMetaData& other) const;
/// \brief The number of parquet "leaf" columns.
///
/// Parquet thrift definition requires that nested schema elements are
/// flattened. This method returns the number of columns in the flattened
/// version.
/// For instance, if the schema looks like this :
/// 0 foo.bar
/// foo.bar.baz 0
/// foo.bar.baz2 1
/// foo.qux 2
/// 1 foo2 3
/// 2 foo3 4
/// This method will return 5, because there are 5 "leaf" fields (so 5
/// flattened fields)
int num_columns() const;
/// \brief The number of flattened schema elements.
///
/// Parquet thrift definition requires that nested schema elements are
/// flattened. This method returns the total number of elements in the
/// flattened list.
int num_schema_elements() const;
/// \brief The total number of rows.
///
/// If the FileMetaData was obtained by calling `SubSet()`, this is the total
/// number of rows in the selected row groups.
int64_t num_rows() const;
/// \brief The number of row groups in the file.
///
/// If the FileMetaData was obtained by calling `SubSet()`, this is the number
/// of selected row groups.
int num_row_groups() const;
/// \brief Return the RowGroupMetaData of the corresponding row group ordinal.
///
/// WARNING, the returned object references memory location in it's parent
/// (FileMetaData) object. Hence, the parent must outlive the returned object.
///
/// \param[in] index of the RowGroup to retrieve.
///
/// \throws ParquetException if the index is out of bound.
std::unique_ptr<RowGroupMetaData> RowGroup(int index) const;
/// \brief Return the "version" of the file
///
/// WARNING: The value returned by this method is unreliable as 1) the Parquet
/// file metadata stores the version as a single integer and 2) some producers
/// are known to always write a hardcoded value. Therefore, you cannot use
/// this value to know which features are used in the file.
ParquetVersion::type version() const;
/// \brief Return the application's user-agent string of the writer.
const std::string& created_by() const;
/// \brief Return the application's version of the writer.
const ApplicationVersion& writer_version() const;
/// \brief Size of the original thrift encoded metadata footer.
uint32_t size() const;
/// \brief Indicate if all of the FileMetaData's RowGroups can be decompressed.
///
/// This will return false if any of the RowGroup's page is compressed with a
/// compression format which is not compiled in the current parquet library.
bool can_decompress() const;
bool is_encryption_algorithm_set() const;
EncryptionAlgorithm encryption_algorithm() const;
const std::string& footer_signing_key_metadata() const;
/// \brief Verify signature of FileMetaData when file is encrypted but footer
/// is not encrypted (plaintext footer).
bool VerifySignature(const void* signature);
void WriteTo(::arrow::io::OutputStream* dst,
const std::shared_ptr<Encryptor>& encryptor = NULLPTR) const;
/// \brief Return Thrift-serialized representation of the metadata as a
/// string
std::string SerializeToString() const;
// Return const-pointer to make it clear that this object is not to be copied
const SchemaDescriptor* schema() const;
const std::shared_ptr<const KeyValueMetadata>& key_value_metadata() const;
/// \brief Set a path to all ColumnChunk for all RowGroups.
///
/// Commonly used by systems (Dask, Spark) who generates an metadata-only
/// parquet file. The path is usually relative to said index file.
///
/// \param[in] path to set.
void set_file_path(const std::string& path);
/// \brief Merge row groups from another metadata file into this one.
///
/// The schema of the input FileMetaData must be equal to the
/// schema of this object.
///
/// This is used by systems who creates an aggregate metadata-only file by
/// concatenating the row groups of multiple files. This newly created
/// metadata file acts as an index of all available row groups.
///
/// \param[in] other FileMetaData to merge the row groups from.
///
/// \throws ParquetException if schemas are not equal.
void AppendRowGroups(const FileMetaData& other);
/// \brief Return a FileMetaData containing a subset of the row groups in this
/// FileMetaData.
std::shared_ptr<FileMetaData> Subset(const std::vector<int>& row_groups) const;
/// \brief Serialize metadata unencrypted as string
///
/// \param[in] scrub whether to remove sensitive information from the metadata.
/// \param[in] debug whether to serialize the metadata as Thrift (if false) or
/// debug text (if true).
std::string SerializeUnencrypted(bool scrub, bool debug) const;
private:
friend FileMetaDataBuilder;
friend class SerializedFile;
friend class SerializedRowGroup;
explicit FileMetaData(const void* serialized_metadata, uint32_t* metadata_len,
const ReaderProperties& properties,
std::shared_ptr<InternalFileDecryptor> file_decryptor = NULLPTR);
void set_file_decryptor(std::shared_ptr<InternalFileDecryptor> file_decryptor);
const std::shared_ptr<InternalFileDecryptor>& file_decryptor() const;
// PIMPL Idiom
FileMetaData();
class FileMetaDataImpl;
std::unique_ptr<FileMetaDataImpl> impl_;
};
class PARQUET_EXPORT FileCryptoMetaData {
public:
// API convenience to get a MetaData accessor
static std::shared_ptr<FileCryptoMetaData> Make(
const uint8_t* serialized_metadata, uint32_t* metadata_len,
const ReaderProperties& properties = default_reader_properties());
~FileCryptoMetaData();
EncryptionAlgorithm encryption_algorithm() const;
const std::string& key_metadata() const;
void WriteTo(::arrow::io::OutputStream* dst) const;
private:
friend FileMetaDataBuilder;
FileCryptoMetaData(const uint8_t* serialized_metadata, uint32_t* metadata_len,
const ReaderProperties& properties);
// PIMPL Idiom
FileCryptoMetaData();
class FileCryptoMetaDataImpl;
std::unique_ptr<FileCryptoMetaDataImpl> impl_;
};
// Builder API
class PARQUET_EXPORT ColumnChunkMetaDataBuilder {
public:
// API convenience to get a MetaData reader
static std::unique_ptr<ColumnChunkMetaDataBuilder> Make(
std::shared_ptr<WriterProperties> props, const ColumnDescriptor* column);
static std::unique_ptr<ColumnChunkMetaDataBuilder> Make(
std::shared_ptr<WriterProperties> props, const ColumnDescriptor* column,
void* contents);
~ColumnChunkMetaDataBuilder();
// column chunk
// Used when a dataset is spread across multiple files
void set_file_path(const std::string& path);
// column metadata
void SetStatistics(const EncodedStatistics& stats);
void SetKeyValueMetadata(std::shared_ptr<const KeyValueMetadata> key_value_metadata);
// get the column descriptor
const ColumnDescriptor* descr() const;
int64_t total_compressed_size() const;
// commit the metadata
void Finish(int64_t num_values, int64_t dictionary_page_offset,
int64_t index_page_offset, int64_t data_page_offset,
int64_t compressed_size, int64_t uncompressed_size, bool has_dictionary,
bool dictionary_fallback,
const std::map<Encoding::type, int32_t>& dict_encoding_stats_,
const std::map<Encoding::type, int32_t>& data_encoding_stats_,
const std::shared_ptr<Encryptor>& encryptor = NULLPTR);
// The metadata contents, suitable for passing to ColumnChunkMetaData::Make
const void* contents() const;
// For writing metadata at end of column chunk
void WriteTo(::arrow::io::OutputStream* sink);
private:
explicit ColumnChunkMetaDataBuilder(std::shared_ptr<WriterProperties> props,
const ColumnDescriptor* column);
explicit ColumnChunkMetaDataBuilder(std::shared_ptr<WriterProperties> props,
const ColumnDescriptor* column, void* contents);
// PIMPL Idiom
class ColumnChunkMetaDataBuilderImpl;
std::unique_ptr<ColumnChunkMetaDataBuilderImpl> impl_;
};
class PARQUET_EXPORT RowGroupMetaDataBuilder {
public:
// API convenience to get a MetaData reader
static std::unique_ptr<RowGroupMetaDataBuilder> Make(
std::shared_ptr<WriterProperties> props, const SchemaDescriptor* schema_,
void* contents);
~RowGroupMetaDataBuilder();
ColumnChunkMetaDataBuilder* NextColumnChunk();
int num_columns();
int64_t num_rows();
int current_column() const;
void set_num_rows(int64_t num_rows);
// commit the metadata
void Finish(int64_t total_bytes_written, int16_t row_group_ordinal = -1);
private:
explicit RowGroupMetaDataBuilder(std::shared_ptr<WriterProperties> props,
const SchemaDescriptor* schema_, void* contents);
// PIMPL Idiom
class RowGroupMetaDataBuilderImpl;
std::unique_ptr<RowGroupMetaDataBuilderImpl> impl_;
};
/// \brief Public struct for location to all page indexes in a parquet file.
struct PageIndexLocation {
/// Alias type of page index location of a row group. The index location
/// is located by column ordinal. If the column does not have the page index,
/// its value is set to std::nullopt.
using RowGroupIndexLocation = std::vector<std::optional<IndexLocation>>;
/// Alias type of page index location of a parquet file. The index location
/// is located by the row group ordinal.
using FileIndexLocation = std::map<size_t, RowGroupIndexLocation>;
/// Row group column index locations which uses row group ordinal as the key.
FileIndexLocation column_index_location;
/// Row group offset index locations which uses row group ordinal as the key.
FileIndexLocation offset_index_location;
};
class PARQUET_EXPORT FileMetaDataBuilder {
public:
// API convenience to get a MetaData builder
static std::unique_ptr<FileMetaDataBuilder> Make(
const SchemaDescriptor* schema, std::shared_ptr<WriterProperties> props);
~FileMetaDataBuilder();
// The prior RowGroupMetaDataBuilder (if any) is destroyed
RowGroupMetaDataBuilder* AppendRowGroup();
// Update location to all page indexes in the parquet file
void SetPageIndexLocation(const PageIndexLocation& location);
// Complete the Thrift structure
std::unique_ptr<FileMetaData> Finish(
const std::shared_ptr<const KeyValueMetadata>& key_value_metadata = NULLPTR);
// crypto metadata
std::unique_ptr<FileCryptoMetaData> GetCryptoMetaData();
private:
explicit FileMetaDataBuilder(const SchemaDescriptor* schema,
std::shared_ptr<WriterProperties> props);
// PIMPL Idiom
class FileMetaDataBuilderImpl;
std::unique_ptr<FileMetaDataBuilderImpl> impl_;
};
PARQUET_EXPORT std::string ParquetVersionToString(ParquetVersion::type ver);
} // namespace parquet