pitrou commented on code in PR #14803: URL: https://github.com/apache/arrow/pull/14803#discussion_r1037236647
########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, Review Comment: Why "inout"? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, Review Comment: Why not a const ref? Is it allowed to be null? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; Review Comment: If the string is persisted in the index, we don't need to copy it on return. So either return a `const std::string&`, or a `std::string_view`. ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; Review Comment: Uppercase can clash with third-party macros unfortunately, we should avoid it as much as possible. ```suggestion enum class PARQUET_EXPORT BoundaryOrder { Unordered = 0, Ascending = 1, Descending = 2 }; ``` ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMax(int64_t page_id) const = 0; +}; + +/// \brief Typed implementation of ColumnIndex. +template <typename DType> +class PARQUET_EXPORT TypedColumnIndex : public ColumnIndex { + public: + using T = typename DType::c_type; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual T min_value(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual T max_value(int64_t page_id) const = 0; + + /// \brief The minimum value of every valid page. + virtual const std::vector<T>& GetMinValues() const = 0; + + /// \brief The maximum value of every valid page. + virtual const std::vector<T>& GetMaxValues() const = 0; + + /// \brief Returns list of page index of all valid pages. Review Comment: Is it useful to have this in addition from `null_pages`? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMax(int64_t page_id) const = 0; +}; + +/// \brief Typed implementation of ColumnIndex. +template <typename DType> +class PARQUET_EXPORT TypedColumnIndex : public ColumnIndex { + public: + using T = typename DType::c_type; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual T min_value(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual T max_value(int64_t page_id) const = 0; + + /// \brief The minimum value of every valid page. + virtual const std::vector<T>& GetMinValues() const = 0; Review Comment: `min_values`? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMax(int64_t page_id) const = 0; +}; + +/// \brief Typed implementation of ColumnIndex. +template <typename DType> +class PARQUET_EXPORT TypedColumnIndex : public ColumnIndex { + public: + using T = typename DType::c_type; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual T min_value(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual T max_value(int64_t page_id) const = 0; + + /// \brief The minimum value of every valid page. + virtual const std::vector<T>& GetMinValues() const = 0; + + /// \brief The maximum value of every valid page. + virtual const std::vector<T>& GetMaxValues() const = 0; + + /// \brief Returns list of page index of all valid pages. + /// It can be used to understand values returned from min_values/max_values. + virtual std::vector<int64_t> GetValidPageIndices() const = 0; +}; + +using BoolColumnIndex = TypedColumnIndex<BooleanType>; +using Int32ColumnIndex = TypedColumnIndex<Int32Type>; +using Int64ColumnIndex = TypedColumnIndex<Int64Type>; +using FloatColumnIndex = TypedColumnIndex<FloatType>; +using DoubleColumnIndex = TypedColumnIndex<DoubleType>; +using ByteArrayColumnIndex = TypedColumnIndex<ByteArrayType>; +using FLBAColumnIndex = TypedColumnIndex<FLBAType>; + +/// \brief PageLocation is a proxy around format::PageLocation. +struct PARQUET_EXPORT PageLocation { + /// File offset of the data page. + int64_t offset_; + /// Total compressed size of the data page and header. + int32_t compressed_page_size_; + // row id of the first row in the page within the row group. + int64_t first_row_index_; Review Comment: If it's plain value struct, there's no need to suffix the members with an underscore IMHO (there are no methodes where a confusion could arise between local and member). ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMax(int64_t page_id) const = 0; +}; + +/// \brief Typed implementation of ColumnIndex. +template <typename DType> +class PARQUET_EXPORT TypedColumnIndex : public ColumnIndex { + public: + using T = typename DType::c_type; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual T min_value(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual T max_value(int64_t page_id) const = 0; + + /// \brief The minimum value of every valid page. + virtual const std::vector<T>& GetMinValues() const = 0; + + /// \brief The maximum value of every valid page. + virtual const std::vector<T>& GetMaxValues() const = 0; + + /// \brief Returns list of page index of all valid pages. + /// It can be used to understand values returned from min_values/max_values. + virtual std::vector<int64_t> GetValidPageIndices() const = 0; +}; + +using BoolColumnIndex = TypedColumnIndex<BooleanType>; +using Int32ColumnIndex = TypedColumnIndex<Int32Type>; +using Int64ColumnIndex = TypedColumnIndex<Int64Type>; +using FloatColumnIndex = TypedColumnIndex<FloatType>; +using DoubleColumnIndex = TypedColumnIndex<DoubleType>; +using ByteArrayColumnIndex = TypedColumnIndex<ByteArrayType>; +using FLBAColumnIndex = TypedColumnIndex<FLBAType>; + +/// \brief PageLocation is a proxy around format::PageLocation. +struct PARQUET_EXPORT PageLocation { + /// File offset of the data page. + int64_t offset_; + /// Total compressed size of the data page and header. + int32_t compressed_page_size_; + // row id of the first row in the page within the row group. + int64_t first_row_index_; +}; + +/// \brief OffsetIndex is a proxy around format::OffsetIndex. +class PARQUET_EXPORT OffsetIndex { + public: + /// \brief Create a OffsetIndex from a serialized thrift message. + static std::unique_ptr<OffsetIndex> Make(const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~OffsetIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns offset for a single page. + virtual int64_t offset(int64_t page_id) const = 0; + + /// \brief Returns total compressed size for a single page. + virtual int32_t compressed_page_size(int64_t page_id) const = 0; + + /// \brief Returns row id of the first row for a single page. + virtual int64_t first_row_index(int64_t page_id) const = 0; Review Comment: Is it useful to have these or can the user just rely on `GetPageLocations`? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; Review Comment: ```suggestion virtual bool is_null_page(int64_t page_id) const = 0; ``` ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; Review Comment: ```suggestion virtual const std::vector<bool>& null_pages() const = 0; ``` ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; Review Comment: We don't have a very well-defined policy on casing, but generally simple accessors should be lowercase. ```suggestion virtual bool has_null_counts() const = 0; ``` ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; Review Comment: ```suggestion virtual const std::vector<int64_t>& null_counts() const = 0; ``` ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMax(int64_t page_id) const = 0; +}; + +/// \brief Typed implementation of ColumnIndex. +template <typename DType> +class PARQUET_EXPORT TypedColumnIndex : public ColumnIndex { + public: + using T = typename DType::c_type; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual T min_value(int64_t page_id) const = 0; + + /// \brief The maximum value of a single page. Throws if it is null page. + virtual T max_value(int64_t page_id) const = 0; + + /// \brief The minimum value of every valid page. + virtual const std::vector<T>& GetMinValues() const = 0; + + /// \brief The maximum value of every valid page. + virtual const std::vector<T>& GetMaxValues() const = 0; + + /// \brief Returns list of page index of all valid pages. + /// It can be used to understand values returned from min_values/max_values. + virtual std::vector<int64_t> GetValidPageIndices() const = 0; +}; + +using BoolColumnIndex = TypedColumnIndex<BooleanType>; +using Int32ColumnIndex = TypedColumnIndex<Int32Type>; +using Int64ColumnIndex = TypedColumnIndex<Int64Type>; +using FloatColumnIndex = TypedColumnIndex<FloatType>; +using DoubleColumnIndex = TypedColumnIndex<DoubleType>; +using ByteArrayColumnIndex = TypedColumnIndex<ByteArrayType>; +using FLBAColumnIndex = TypedColumnIndex<FLBAType>; + +/// \brief PageLocation is a proxy around format::PageLocation. +struct PARQUET_EXPORT PageLocation { + /// File offset of the data page. + int64_t offset_; + /// Total compressed size of the data page and header. + int32_t compressed_page_size_; + // row id of the first row in the page within the row group. + int64_t first_row_index_; +}; + +/// \brief OffsetIndex is a proxy around format::OffsetIndex. +class PARQUET_EXPORT OffsetIndex { + public: + /// \brief Create a OffsetIndex from a serialized thrift message. + static std::unique_ptr<OffsetIndex> Make(const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~OffsetIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns offset for a single page. + virtual int64_t offset(int64_t page_id) const = 0; + + /// \brief Returns total compressed size for a single page. + virtual int32_t compressed_page_size(int64_t page_id) const = 0; + + /// \brief Returns row id of the first row for a single page. + virtual int64_t first_row_index(int64_t page_id) const = 0; + + /// \brief Returns all page locations in the offset index. + virtual const std::vector<PageLocation>& GetPageLocations() const = 0; +}; Review Comment: Perhaps expose a method that returns the `PageLocation` for a given row id? ########## cpp/src/parquet/page_index.h: ########## @@ -0,0 +1,143 @@ +// 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 <set> +#include <string> +#include <vector> + +#include "parquet/platform.h" +#include "parquet/statistics.h" +#include "parquet/types.h" + +namespace parquet { + +/// \brief BoundaryOrder is a proxy around format::BoundaryOrder. +enum class PARQUET_EXPORT BoundaryOrder { UNORDERED = 0, ASCENDING = 1, DESCENDING = 2 }; + +/// \brief ColumnIndex is a proxy around format::ColumnIndex. +class PARQUET_EXPORT ColumnIndex { + public: + /// \brief Create a ColumnIndex from a serialized thrift message. + static std::unique_ptr<ColumnIndex> Make(const ColumnDescriptor* descr, + const void* serialized_index, + uint32_t* inout_index_len, + const ReaderProperties& properties); + + virtual ~ColumnIndex() = default; + + /// \brief Returns number of pages in this column index. + virtual int64_t num_pages() const = 0; + + /// \brief Returns if all values are null in a single page. + virtual bool null_page(int64_t page_id) const = 0; + + /// \brief Returns whether both min_values and max_values are + /// orderd and if so, in which direction. + virtual BoundaryOrder boundary_order() const = 0; + + /// \brief Returns if null count is available. + virtual bool HasNullCount() const = 0; + + /// \brief Returns null count for a single page. + virtual int64_t null_count(int64_t page_id) const = 0; + + /// \brief Returns all null indicator for each page in batch. + virtual const std::vector<bool>& GetNullPages() const = 0; + + /// \brief Returns null count for each page in batch. + virtual const std::vector<int64_t>& GetNullCounts() const = 0; + + /// \brief The minimum value of a single page. Throws if it is null page. + virtual std::string GetEncodedMin(int64_t page_id) const = 0; Review Comment: Also, call this `encoded_min`? -- 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]
