Repository navigation
feat(parquet): add Bloom row-group pruning #1114
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
zhjwpku
wants to merge
1
commit into
apache:main
Choose a base branch
from
zhjwpku:feat/parquet-bloom-row-group-filter
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,241
−1
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,317 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| #include <algorithm> | ||
| #include <cmath> | ||
| #include <limits> | ||
| #include <utility> | ||
| #include <vector> | ||
|
|
||
| #include <parquet/bloom_filter.h> | ||
|
|
||
| #include "iceberg/expression/expression_visitor.h" | ||
| #include "iceberg/expression/rewrite_not.h" | ||
| #include "iceberg/metadata_columns.h" | ||
| #include "iceberg/parquet/parquet_bloom_row_group_filter_internal.h" | ||
| #include "iceberg/parquet/parquet_schema_util_internal.h" | ||
| #include "iceberg/util/macros.h" | ||
|
|
||
| namespace iceberg::parquet { | ||
| namespace { | ||
|
|
||
| bool FindBytes(const ::parquet::BloomFilter& bloom, std::span<const uint8_t> bytes) { | ||
| ::parquet::ByteArray value{static_cast<uint32_t>(bytes.size()), bytes.data()}; | ||
| return bloom.FindHash(bloom.Hash(value)); | ||
| } | ||
|
|
||
| // Hash the file's physical representation, not Iceberg's single-value encoding. | ||
| // Java's BloomEvalVisitor.shouldRead uses the same physical-type dispatch. | ||
| bool MightContain(const ::parquet::ColumnDescriptor& column, const Literal& value, | ||
| const ::parquet::BloomFilter& bloom) { | ||
| if (value.IsNull() || value.IsAboveMax() || value.IsBelowMin() || value.IsNaN()) { | ||
| // Bloom hashes floating-point bits, whereas equality treats all NaN payloads | ||
| // alike. Neither a NaN predicate nor a NaN literal can safely exclude rows. | ||
| return true; | ||
| } | ||
| auto type = value.type()->type_id(); | ||
| switch (column.physical_type()) { | ||
| case ::parquet::Type::INT32: { | ||
| int128_t number; | ||
| switch (type) { | ||
| case TypeId::kInt: | ||
| case TypeId::kDate: | ||
| number = std::get<int32_t>(value.value()); | ||
| break; | ||
| case TypeId::kLong: | ||
| number = std::get<int64_t>(value.value()); | ||
| break; | ||
| case TypeId::kDecimal: | ||
| number = std::get<Decimal>(value.value()).value(); | ||
| break; | ||
| default: | ||
| return true; | ||
| } | ||
| if (number < std::numeric_limits<int32_t>::min() || | ||
| number > std::numeric_limits<int32_t>::max()) { | ||
| return false; | ||
| } | ||
| return bloom.FindHash(bloom.Hash(static_cast<int32_t>(number))); | ||
| } | ||
| case ::parquet::Type::INT64: { | ||
| int128_t number; | ||
| switch (type) { | ||
| case TypeId::kLong: | ||
| case TypeId::kTime: | ||
| case TypeId::kTimestamp: | ||
| case TypeId::kTimestampTz: | ||
| case TypeId::kTimestampNs: | ||
| case TypeId::kTimestampTzNs: | ||
| number = std::get<int64_t>(value.value()); | ||
| break; | ||
| case TypeId::kDecimal: | ||
| number = std::get<Decimal>(value.value()).value(); | ||
| break; | ||
| default: | ||
| return true; | ||
| } | ||
| if (number < std::numeric_limits<int64_t>::min() || | ||
| number > std::numeric_limits<int64_t>::max()) { | ||
| return false; | ||
| } | ||
| return bloom.FindHash(bloom.Hash(static_cast<int64_t>(number))); | ||
| } | ||
| case ::parquet::Type::FLOAT: { | ||
| float number; | ||
| if (type == TypeId::kFloat) { | ||
| number = std::get<float>(value.value()); | ||
| } else if (type == TypeId::kDouble) { | ||
| auto promoted = std::get<double>(value.value()); | ||
| if (std::isfinite(promoted) && | ||
| std::abs(promoted) > std::numeric_limits<float>::max()) { | ||
| return false; | ||
| } | ||
| number = static_cast<float>(promoted); | ||
| } else { | ||
| return true; | ||
| } | ||
| return bloom.FindHash(bloom.Hash(number)); | ||
| } | ||
| case ::parquet::Type::DOUBLE: | ||
| return type != TypeId::kDouble || | ||
| bloom.FindHash(bloom.Hash(std::get<double>(value.value()))); | ||
| case ::parquet::Type::BYTE_ARRAY: | ||
| case ::parquet::Type::FIXED_LEN_BYTE_ARRAY: | ||
| switch (type) { | ||
| case TypeId::kString: | ||
| return bloom.FindHash( | ||
| bloom.Hash(std::string_view(std::get<std::string>(value.value())))); | ||
| case TypeId::kBinary: | ||
| case TypeId::kFixed: | ||
| return FindBytes(bloom, std::get<std::vector<uint8_t>>(value.value())); | ||
| case TypeId::kUuid: | ||
| return FindBytes(bloom, std::get<Uuid>(value.value()).bytes()); | ||
| case TypeId::kDecimal: { | ||
| // Iceberg's Parquet decimal representation is precision-sized, | ||
| // two's-complement big endian, including sign extension. Use the | ||
| // file's precision, since the table decimal may have been promoted. | ||
| const auto& decimal = std::get<Decimal>(value.value()); | ||
| if (!decimal.FitsInPrecision(column.type_precision())) { | ||
| return false; | ||
| } | ||
| auto bytes = decimal.ToBigEndian(); | ||
| if (column.physical_type() == ::parquet::Type::BYTE_ARRAY) { | ||
| // Unlike FIXED, binary metadata does not specify the stored width. | ||
| // Include Java's precision-sized encoding and all other supported | ||
| // sign-extended representations to avoid false negatives. | ||
| for (size_t width = bytes.size(); width <= Decimal::kByteWidth; ++width) { | ||
| if (FindBytes(bloom, bytes)) { | ||
| return true; | ||
| } | ||
| bytes.insert(bytes.begin(), decimal.value() < 0 ? 0xff : 0x00); | ||
| } | ||
| return false; | ||
| } | ||
| int width = column.type_length(); | ||
| if (std::cmp_less(width, bytes.size())) { | ||
| return true; | ||
| } | ||
| bytes.insert(bytes.begin(), width - bytes.size(), | ||
| decimal.value() < 0 ? 0xff : 0x00); | ||
| return FindBytes(bloom, bytes); | ||
| } | ||
| default: | ||
| return true; | ||
| } | ||
| default: | ||
| // Boolean and legacy INT96 have no Iceberg Bloom conversion here. | ||
| return true; | ||
| } | ||
| } | ||
|
|
||
| class BloomVisitor : public BoundVisitor<bool> { | ||
| public: | ||
| BloomVisitor(const ::parquet::arrow::SchemaManifest& manifest, | ||
| const ::parquet::RowGroupMetaData& row_group, | ||
| ::parquet::RowGroupBloomFilterReader* bloom_reader, | ||
| const std::unordered_map<int32_t, int>& columns) | ||
| : manifest_(manifest), | ||
| row_group_(row_group), | ||
| bloom_reader_(bloom_reader), | ||
| columns_(columns) {} | ||
|
|
||
| Result<bool> AlwaysTrue() override { return true; } | ||
| Result<bool> AlwaysFalse() override { return false; } | ||
| // Make rewrites NOT. Negating an inclusive result would be unsafe. | ||
| Result<bool> Not(bool) override { return true; } | ||
| Result<bool> And(bool left, bool right) override { return left && right; } | ||
| Result<bool> Or(bool left, bool right) override { return left || right; } | ||
|
|
||
| Result<bool> Eq(const std::shared_ptr<Bound>& expr, const Literal& value) override { | ||
| if (value.IsNaN()) { | ||
| return true; | ||
| } | ||
| auto ref = std::dynamic_pointer_cast<BoundReference>(expr); | ||
| ICEBERG_ASSIGN_OR_RAISE(auto bloom, GetBloomFilter(ref)); | ||
| return !bloom || MightContain(*manifest_.descr->Column(columns_.at(ref->field_id())), | ||
| value, *bloom); | ||
| } | ||
|
|
||
| Result<bool> In(const std::shared_ptr<Bound>& expr, | ||
| const BoundSetPredicate::LiteralSet& values) override { | ||
| if (std::ranges::any_of(values, [](const auto& value) { return value.IsNaN(); })) { | ||
| return true; | ||
| } | ||
| auto ref = std::dynamic_pointer_cast<BoundReference>(expr); | ||
| ICEBERG_ASSIGN_OR_RAISE(auto bloom, GetBloomFilter(ref)); | ||
| if (!bloom) { | ||
| return true; | ||
| } | ||
| auto column = manifest_.descr->Column(columns_.at(ref->field_id())); | ||
| return std::ranges::any_of( | ||
| values, [&](const auto& value) { return MightContain(*column, value, *bloom); }); | ||
| } | ||
| Result<bool> IsNull(const std::shared_ptr<Bound>&) override { return true; } | ||
| Result<bool> NotNull(const std::shared_ptr<Bound>&) override { return true; } | ||
| Result<bool> IsNaN(const std::shared_ptr<Bound>&) override { return true; } | ||
| Result<bool> NotNaN(const std::shared_ptr<Bound>&) override { return true; } | ||
| Result<bool> Lt(const std::shared_ptr<Bound>&, const Literal&) override { return true; } | ||
| Result<bool> LtEq(const std::shared_ptr<Bound>&, const Literal&) override { | ||
| return true; | ||
| } | ||
| Result<bool> Gt(const std::shared_ptr<Bound>&, const Literal&) override { return true; } | ||
| Result<bool> GtEq(const std::shared_ptr<Bound>&, const Literal&) override { | ||
| return true; | ||
| } | ||
| Result<bool> NotEq(const std::shared_ptr<Bound>&, const Literal&) override { | ||
| return true; | ||
| } | ||
| Result<bool> StartsWith(const std::shared_ptr<Bound>&, const Literal&) override { | ||
| return true; | ||
| } | ||
| Result<bool> NotStartsWith(const std::shared_ptr<Bound>&, const Literal&) override { | ||
| return true; | ||
| } | ||
| Result<bool> NotIn(const std::shared_ptr<Bound>&, | ||
| const BoundSetPredicate::LiteralSet&) override { | ||
| return true; | ||
| } | ||
|
|
||
| private: | ||
| Result<const ::parquet::BloomFilter*> GetBloomFilter( | ||
| const std::shared_ptr<BoundReference>& ref) { | ||
| if (!ref || !ref->type()->is_primitive() || | ||
| MetadataColumns::IsMetadataColumn(ref->field_id())) { | ||
| return nullptr; | ||
| } | ||
| auto index = columns_.find(ref->field_id()); | ||
| if (index == columns_.end()) { | ||
| // Missing fields may have initial defaults; never infer all nulls here. | ||
| return nullptr; | ||
| } | ||
| auto field = manifest_.column_index_to_field.find(index->second); | ||
| if (field == manifest_.column_index_to_field.end() || | ||
| !ValidateParquetTypeCompatibility(*ref->type(), *field->second) || | ||
| manifest_.descr->Column(index->second)->max_repetition_level() > 0) { | ||
| return nullptr; | ||
| } | ||
| auto physical_type = manifest_.descr->Column(index->second)->physical_type(); | ||
| if (physical_type == ::parquet::Type::BOOLEAN || | ||
| physical_type == ::parquet::Type::INT96) { | ||
| return nullptr; | ||
| } | ||
| auto column = row_group_.ColumnChunk(index->second); | ||
| auto offset = column->bloom_filter_offset(); | ||
| if (!offset || *offset <= 0) { | ||
| return nullptr; | ||
| } | ||
| auto [entry, inserted] = cache_.try_emplace(ref->field_id()); | ||
| if (inserted) { | ||
| if (bloom_reader_) { | ||
| entry->second = bloom_reader_->GetColumnBloomFilter(index->second); | ||
| } | ||
| if (!entry->second) { | ||
| return Invalid("Missing Parquet Bloom filter for field {}", ref->field_id()); | ||
| } | ||
| } | ||
| return entry->second.get(); | ||
| } | ||
|
|
||
| const ::parquet::arrow::SchemaManifest& manifest_; | ||
| const ::parquet::RowGroupMetaData& row_group_; | ||
| ::parquet::RowGroupBloomFilterReader* bloom_reader_; | ||
| const std::unordered_map<int32_t, int>& columns_; | ||
| std::unordered_map<int32_t, std::unique_ptr<::parquet::BloomFilter>> cache_; | ||
| }; | ||
|
|
||
| } // namespace | ||
|
|
||
| Result<std::unique_ptr<ParquetBloomRowGroupFilter>> ParquetBloomRowGroupFilter::Make( | ||
| const std::shared_ptr<Expression>& filter, | ||
| const ::parquet::SchemaDescriptor& file_schema) { | ||
| auto result = | ||
| std::unique_ptr<ParquetBloomRowGroupFilter>(new ParquetBloomRowGroupFilter()); | ||
| for (int i = 0; i < file_schema.num_columns(); ++i) { | ||
| auto id = file_schema.Column(i)->schema_node()->field_id(); | ||
| if (id >= 0) { | ||
| result->field_id_to_column_idx_.emplace(id, i); | ||
| } | ||
| } | ||
| result->bound_ = True::Instance(); | ||
| if (filter) { | ||
| ICEBERG_ASSIGN_OR_RAISE(result->bound_, RewriteNot::Visit(filter)); | ||
| } | ||
| return result; | ||
| } | ||
|
|
||
| Result<bool> ParquetBloomRowGroupFilter::ShouldRead( | ||
| const ::parquet::arrow::SchemaManifest& manifest, | ||
| const ::parquet::RowGroupMetaData& row_group, | ||
| ::parquet::RowGroupBloomFilterReader* bloom_reader) const { | ||
| if (row_group.num_rows() <= 0) { | ||
| return false; | ||
| } | ||
| try { | ||
| BloomVisitor visitor(manifest, row_group, bloom_reader, field_id_to_column_idx_); | ||
| return Visit<bool>(bound_, visitor); | ||
| } catch (const ::parquet::ParquetException& e) { | ||
| return Invalid("Cannot read Parquet Bloom filter: {}", e.what()); | ||
| } | ||
| } | ||
|
|
||
| } // namespace iceberg::parquet | ||
54 changes: 54 additions & 0 deletions
54
src/iceberg/parquet/parquet_bloom_row_group_filter_internal.h
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| /* | ||
| * 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 <memory> | ||
| #include <unordered_map> | ||
|
|
||
| #include <parquet/arrow/schema.h> | ||
| #include <parquet/bloom_filter_reader.h> | ||
| #include <parquet/metadata.h> | ||
|
|
||
| #include "iceberg/iceberg_bundle_export.h" | ||
| #include "iceberg/result.h" | ||
| #include "iceberg/type_fwd.h" | ||
|
|
||
| namespace iceberg::parquet { | ||
|
|
||
| // Inclusive Bloom filtering, following Java's ParquetBloomRowGroupFilter. | ||
| // False proves that no row can match; true still requires residual evaluation. | ||
| class ICEBERG_BUNDLE_EXPORT ParquetBloomRowGroupFilter { | ||
| public: | ||
| static Result<std::unique_ptr<ParquetBloomRowGroupFilter>> Make( | ||
| const std::shared_ptr<Expression>& filter, | ||
| const ::parquet::SchemaDescriptor& file_schema); | ||
|
|
||
| Result<bool> ShouldRead(const ::parquet::arrow::SchemaManifest& manifest, | ||
| const ::parquet::RowGroupMetaData& row_group, | ||
| ::parquet::RowGroupBloomFilterReader* bloom_reader) const; | ||
|
|
||
| private: | ||
| ParquetBloomRowGroupFilter() = default; | ||
| std::shared_ptr<Expression> bound_; | ||
| std::unordered_map<int32_t, int> field_id_to_column_idx_; | ||
| }; | ||
|
|
||
| } // namespace iceberg::parquet |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shall we fail on this path? Might it still match?