|
| 1 | +/* |
| 2 | + * Licensed to the Apache Software Foundation (ASF) under one |
| 3 | + * or more contributor license agreements. See the NOTICE file |
| 4 | + * distributed with this work for additional information |
| 5 | + * regarding copyright ownership. The ASF licenses this file |
| 6 | + * to you under the Apache License, Version 2.0 (the |
| 7 | + * "License"); you may not use this file except in compliance |
| 8 | + * with the License. You may obtain a copy of the License at |
| 9 | + * |
| 10 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | + * |
| 12 | + * Unless required by applicable law or agreed to in writing, |
| 13 | + * software distributed under the License is distributed on an |
| 14 | + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 15 | + * KIND, either express or implied. See the License for the |
| 16 | + * specific language governing permissions and limitations |
| 17 | + * under the License. |
| 18 | + */ |
| 19 | + |
| 20 | +#pragma once |
| 21 | + |
| 22 | +/// \file iceberg/expression/manifest_evaluator.h |
| 23 | +/// |
| 24 | +/// Evaluates an Expression on a ManifestFile to test whether the file contains |
| 25 | +/// matching partitions. |
| 26 | +/// |
| 27 | +/// For row expressions, evaluation is inclusive: it returns true if a file |
| 28 | +/// may match and false if it cannot match. |
| 29 | +/// |
| 30 | +/// Files are passed to #eval(ManifestFile), which returns true if the manifest may |
| 31 | +/// contain data files that match the partition expression. Manifest files may be |
| 32 | +/// skipped if and only if the return value of eval is false. |
| 33 | +/// |
| 34 | + |
| 35 | +#include <memory> |
| 36 | + |
| 37 | +#include "iceberg/iceberg_export.h" |
| 38 | +#include "iceberg/result.h" |
| 39 | +#include "iceberg/type_fwd.h" |
| 40 | + |
| 41 | +namespace iceberg { |
| 42 | + |
| 43 | +/// \brief Evaluates an Expression against manifest. |
| 44 | +/// \note: The evaluator is thread-safe. |
| 45 | +class ICEBERG_EXPORT ManifestEvaluator { |
| 46 | + public: |
| 47 | + /// \brief Make a manifest evaluator for RowFilter |
| 48 | + /// |
| 49 | + /// \param expr The expression to evaluate |
| 50 | + /// \param spec The partition spec |
| 51 | + /// \param schema The schema of the table |
| 52 | + /// \param case_sensitive Whether field name matching is case-sensitive |
| 53 | + static Result<std::unique_ptr<ManifestEvaluator>> MakeRowFilter( |
| 54 | + std::shared_ptr<Expression> expr, const std::shared_ptr<PartitionSpec>& spec, |
| 55 | + const Schema& schema, bool case_sensitive = true); |
| 56 | + |
| 57 | + /// \brief Make a manifest evaluator for PartitionFilter |
| 58 | + /// |
| 59 | + /// \param expr The expression to evaluate |
| 60 | + /// \param spec The partition spec |
| 61 | + /// \param schema The schema of the table |
| 62 | + /// \param case_sensitive Whether field name matching is case-sensitive |
| 63 | + static Result<std::unique_ptr<ManifestEvaluator>> MakePartitionFilter( |
| 64 | + std::shared_ptr<Expression> expr, const std::shared_ptr<PartitionSpec>& spec, |
| 65 | + const Schema& schema, bool case_sensitive = true); |
| 66 | + |
| 67 | + ~ManifestEvaluator(); |
| 68 | + |
| 69 | + /// \brief Evaluate the expression against a manifest. |
| 70 | + /// |
| 71 | + /// \param manifest The manifest to evaluate |
| 72 | + /// \return true if the row matches the expression, false otherwise, or error |
| 73 | + Result<bool> Evaluate(const ManifestFile& manifest) const; |
| 74 | + |
| 75 | + private: |
| 76 | + explicit ManifestEvaluator(std::shared_ptr<Expression> expr); |
| 77 | + |
| 78 | + private: |
| 79 | + std::shared_ptr<Expression> expr_; |
| 80 | +}; |
| 81 | + |
| 82 | +} // namespace iceberg |
0 commit comments