wgtmac commented on code in PR #37400: URL: https://github.com/apache/arrow/pull/37400#discussion_r2593225569
########## cpp/src/parquet/bloom_filter_writer.h: ########## @@ -0,0 +1,105 @@ +// 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 "arrow/type_fwd.h" + +#include "parquet/bloom_filter.h" +#include "parquet/type_fwd.h" + +namespace parquet { + +/// \brief Writer for updating a bloom filter with values of a specific Parquet type. +template <typename ParquetType> +class PARQUET_EXPORT BloomFilterWriter { + public: + using T = typename ParquetType::c_type; + + /// \param descr The descriptor of the column to write. Must outlive this writer. + /// \param bloom_filter The bloom filter to update. If nullptr, this writer does not + /// enable bloom filter. Otherwise, the input bloom filter must outlive this writer. + BloomFilterWriter(const ColumnDescriptor* descr, BloomFilter* bloom_filter); + + /// \brief Update the bloom filter with typed values. + /// + /// \param values The values to update the bloom filter with. + /// \param num_values The number of values to update the bloom filter with. + void Update(const T* values, int64_t num_values); + + /// \brief Update the bloom filter with typed values that have spaces. + /// + /// \param values The values to update the bloom filter with. + /// \param num_values The number of values to update the bloom filter with. + /// \param valid_bits The validity bitmap of the values. + /// \param valid_bits_offset The offset of the validity bitmap. + void UpdateSpaced(const T* values, int64_t num_values, const uint8_t* valid_bits, + int64_t valid_bits_offset); + + /// \brief Update the bloom filter with an Arrow array. + /// + /// \param values The Arrow array to update the bloom filter with. + void Update(const ::arrow::Array& values); + + /// \brief Check if this writer has enabled the bloom filter. + bool bloom_filter_enabled() const; + + private: + const ColumnDescriptor* descr_; + BloomFilter* bloom_filter_; +}; + +/// \brief Interface for building bloom filters of a parquet file. +class PARQUET_EXPORT BloomFilterBuilder { + public: + virtual ~BloomFilterBuilder() = default; + + /// \brief API to create a BloomFilterBuilder. + /// + /// \param schema The schema of the file and it must outlive the created builder. + /// \param properties Properties to get bloom filter options. It must outlive the + /// created builder. + static std::unique_ptr<BloomFilterBuilder> Make(const SchemaDescriptor* schema, + const WriterProperties* properties); + + /// \brief Start a new row group to write bloom filters, meaning that next calls + /// to `GetOrCreateBloomFilter` will create bloom filters for the new row group. + /// + /// \throws ParquetException if `WriteTo()` has been called already. + virtual void AppendRowGroup() = 0; + + /// \brief Get or create a BloomFilter from the column ordinal of the current row group. + /// + /// \param column_ordinal Column ordinal for the bloom filter. + /// \return designated BloomFilter whose ownership belongs to the builder. Review Comment: Make sense. Let me add it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
