wgtmac commented on code in PR #31: URL: https://github.com/apache/iceberg-cpp/pull/31#discussion_r1924866221
########## src/iceberg/type.h: ########## @@ -0,0 +1,397 @@ +/* + * 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 + +/// \file iceberg/type.h +/// Data types for Iceberg. This header defines the data types, but see +/// iceberg/type_fwd.h for the enum defining the list of types. + +#include <array> +#include <cstdint> +#include <memory> +#include <optional> +#include <span> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/schema_field.h" +#include "iceberg/util/formattable.h" + +namespace iceberg { + +/// \brief Interface for a data type for a field. +class ICEBERG_EXPORT Type : public iceberg::util::Formattable { + public: + virtual ~Type() = default; + + /// \brief Get the type ID. + [[nodiscard]] virtual TypeId type_id() const = 0; + + /// \brief Is this a primitive type (may not have child fields)? + [[nodiscard]] virtual bool is_primitive() const = 0; + + /// \brief Is this a nested type (may have child fields)? + [[nodiscard]] virtual bool is_nested() const = 0; + + /// \brief Compare two types for equality. + friend bool operator==(const Type& lhs, const Type& rhs) { return lhs.Equals(rhs); } + + /// \brief Compare two types for inequality. + friend bool operator!=(const Type& lhs, const Type& rhs) { return !(lhs == rhs); } + + protected: + /// \brief Compare two types for equality. + [[nodiscard]] virtual bool Equals(const Type& other) const = 0; +}; + +/// \brief A data type that may not have child fields. +class ICEBERG_EXPORT PrimitiveType : public Type { + public: + bool is_primitive() const override { return true; } + bool is_nested() const override { return false; } +}; + +/// \brief A data type that may have child fields. +class ICEBERG_EXPORT NestedType : public Type { + public: + bool is_primitive() const override { return false; } + bool is_nested() const override { return true; } + + /// \brief Get a view of the child fields. + [[nodiscard]] virtual std::span<const SchemaField> fields() const = 0; + /// \brief Get a field by field ID. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldById(int32_t field_id) const = 0; + /// \brief Get a field by index. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldByIndex(int i) const = 0; Review Comment: ```suggestion GetFieldByIndex(int32_t i) const = 0; ``` I'd prefer explicit width ########## src/iceberg/schema_field.h: ########## @@ -0,0 +1,87 @@ +/* + * 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 + +/// \file iceberg/schema_field.h +/// A (schema) field is a name and a type and is part of a schema or nested +/// type (e.g. a struct). + +#include <cstdint> +#include <memory> +#include <string> +#include <string_view> + +#include "iceberg/iceberg_export.h" +#include "iceberg/type_fwd.h" +#include "iceberg/util/formattable.h" + +namespace iceberg { + +/// \brief A type combined with a name. +class ICEBERG_EXPORT SchemaField : public iceberg::util::Formattable { + public: + /// \brief Construct a field. + /// \param[in] field_id The field ID. + /// \param[in] name The field name. + /// \param[in] type The field type. + /// \param[in] optional Whether values of this field are required or nullable. + SchemaField(int32_t field_id, std::string name, std::shared_ptr<Type> type, + bool optional); + + /// \brief Construct an optional (nullable) field. + static SchemaField MakeOptional(int32_t field_id, std::string name, + std::shared_ptr<Type> type); + /// \brief Construct a required (non-null) field. + static SchemaField MakeRequired(int32_t field_id, std::string name, + std::shared_ptr<Type> type); + + /// \brief Get the field ID. + [[nodiscard]] int32_t field_id() const; Review Comment: Is it an overkill to add `[[nodiscard]]` to these accessors? ########## src/iceberg/type.h: ########## @@ -0,0 +1,397 @@ +/* + * 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 + +/// \file iceberg/type.h +/// Data types for Iceberg. This header defines the data types, but see +/// iceberg/type_fwd.h for the enum defining the list of types. + +#include <array> +#include <cstdint> +#include <memory> +#include <optional> +#include <span> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/schema_field.h" +#include "iceberg/util/formattable.h" + +namespace iceberg { + +/// \brief Interface for a data type for a field. +class ICEBERG_EXPORT Type : public iceberg::util::Formattable { + public: + virtual ~Type() = default; + + /// \brief Get the type ID. + [[nodiscard]] virtual TypeId type_id() const = 0; + + /// \brief Is this a primitive type (may not have child fields)? + [[nodiscard]] virtual bool is_primitive() const = 0; + + /// \brief Is this a nested type (may have child fields)? + [[nodiscard]] virtual bool is_nested() const = 0; + + /// \brief Compare two types for equality. + friend bool operator==(const Type& lhs, const Type& rhs) { return lhs.Equals(rhs); } + + /// \brief Compare two types for inequality. + friend bool operator!=(const Type& lhs, const Type& rhs) { return !(lhs == rhs); } + + protected: + /// \brief Compare two types for equality. + [[nodiscard]] virtual bool Equals(const Type& other) const = 0; +}; + +/// \brief A data type that may not have child fields. +class ICEBERG_EXPORT PrimitiveType : public Type { + public: + bool is_primitive() const override { return true; } + bool is_nested() const override { return false; } +}; + +/// \brief A data type that may have child fields. +class ICEBERG_EXPORT NestedType : public Type { + public: + bool is_primitive() const override { return false; } + bool is_nested() const override { return true; } + + /// \brief Get a view of the child fields. + [[nodiscard]] virtual std::span<const SchemaField> fields() const = 0; + /// \brief Get a field by field ID. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldById(int32_t field_id) const = 0; + /// \brief Get a field by index. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldByIndex(int i) const = 0; + /// \brief Get a field by name. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldByName(std::string_view name) const = 0; +}; + +/// \defgroup type-primitive Primitive Types +/// Primitive types do not have nested fields. +/// @{ + +/// \brief A data type representing a boolean. +class ICEBERG_EXPORT BooleanType : public PrimitiveType { + public: + BooleanType() = default; + ~BooleanType() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 32-bit signed integer. +class ICEBERG_EXPORT Int32Type : public PrimitiveType { + public: + Int32Type() = default; + ~Int32Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 64-bit signed integer. +class ICEBERG_EXPORT Int64Type : public PrimitiveType { + public: + Int64Type() = default; + ~Int64Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 32-bit (single precision) float. +class ICEBERG_EXPORT Float32Type : public PrimitiveType { + public: + Float32Type() = default; + ~Float32Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 64-bit (double precision) float. +class ICEBERG_EXPORT Float64Type : public PrimitiveType { + public: + Float64Type() = default; + ~Float64Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a fixed-precision decimal. +class ICEBERG_EXPORT DecimalType : public PrimitiveType { + public: + constexpr static const int32_t kMaxPrecision = 38; + + /// \brief Construct a decimal type with the given precision and scale. + DecimalType(int32_t precision, int32_t scale); + ~DecimalType() = default; + + /// \brief Get the precision (the number of decimal digits). + [[nodiscard]] int32_t precision() const; + /// \brief Get the scale (essentially, the number of decimal digits after + /// the decimal point; precisely, the value is scaled by $$10^{-s}$$.). + [[nodiscard]] int32_t scale() const; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; + + private: + int32_t precision_; + int32_t scale_; +}; + +/// \brief A data type representing a calendar date without reference to a +/// timezone or time. +class ICEBERG_EXPORT DateType : public PrimitiveType { + public: + DateType() = default; + ~DateType() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a wall clock time in microseconds without +/// reference to a timezone or date. +class ICEBERG_EXPORT TimeType : public PrimitiveType { + public: + TimeType() = default; + ~TimeType() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a timestamp in microseconds without +/// reference to a timezone. +class ICEBERG_EXPORT TimestampType : public PrimitiveType { + public: + TimestampType() = default; + ~TimestampType() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a timestamp in microseconds in a +/// particular timezone. +class ICEBERG_EXPORT TimestampTzType : public PrimitiveType { Review Comment: Should we add an abstract base class for all timestamp types? We will need `timestamp_ns` and `timestamptz_ns` for v3. The only differences are `timezone` and `precision`. ########## src/iceberg/type.h: ########## @@ -0,0 +1,397 @@ +/* + * 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 + +/// \file iceberg/type.h +/// Data types for Iceberg. This header defines the data types, but see +/// iceberg/type_fwd.h for the enum defining the list of types. + +#include <array> +#include <cstdint> +#include <memory> +#include <optional> +#include <span> +#include <string> +#include <unordered_map> +#include <vector> + +#include "iceberg/iceberg_export.h" +#include "iceberg/schema_field.h" +#include "iceberg/util/formattable.h" + +namespace iceberg { + +/// \brief Interface for a data type for a field. +class ICEBERG_EXPORT Type : public iceberg::util::Formattable { + public: + virtual ~Type() = default; + + /// \brief Get the type ID. + [[nodiscard]] virtual TypeId type_id() const = 0; + + /// \brief Is this a primitive type (may not have child fields)? + [[nodiscard]] virtual bool is_primitive() const = 0; + + /// \brief Is this a nested type (may have child fields)? + [[nodiscard]] virtual bool is_nested() const = 0; + + /// \brief Compare two types for equality. + friend bool operator==(const Type& lhs, const Type& rhs) { return lhs.Equals(rhs); } + + /// \brief Compare two types for inequality. + friend bool operator!=(const Type& lhs, const Type& rhs) { return !(lhs == rhs); } + + protected: + /// \brief Compare two types for equality. + [[nodiscard]] virtual bool Equals(const Type& other) const = 0; +}; + +/// \brief A data type that may not have child fields. +class ICEBERG_EXPORT PrimitiveType : public Type { + public: + bool is_primitive() const override { return true; } + bool is_nested() const override { return false; } +}; + +/// \brief A data type that may have child fields. +class ICEBERG_EXPORT NestedType : public Type { + public: + bool is_primitive() const override { return false; } + bool is_nested() const override { return true; } + + /// \brief Get a view of the child fields. + [[nodiscard]] virtual std::span<const SchemaField> fields() const = 0; + /// \brief Get a field by field ID. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldById(int32_t field_id) const = 0; + /// \brief Get a field by index. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldByIndex(int i) const = 0; + /// \brief Get a field by name. + [[nodiscard]] virtual std::optional<std::reference_wrapper<const SchemaField>> + GetFieldByName(std::string_view name) const = 0; +}; + +/// \defgroup type-primitive Primitive Types +/// Primitive types do not have nested fields. +/// @{ + +/// \brief A data type representing a boolean. +class ICEBERG_EXPORT BooleanType : public PrimitiveType { + public: + BooleanType() = default; + ~BooleanType() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 32-bit signed integer. +class ICEBERG_EXPORT Int32Type : public PrimitiveType { + public: + Int32Type() = default; + ~Int32Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 64-bit signed integer. +class ICEBERG_EXPORT Int64Type : public PrimitiveType { + public: + Int64Type() = default; + ~Int64Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 32-bit (single precision) float. +class ICEBERG_EXPORT Float32Type : public PrimitiveType { + public: + Float32Type() = default; + ~Float32Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a 64-bit (double precision) float. +class ICEBERG_EXPORT Float64Type : public PrimitiveType { + public: + Float64Type() = default; + ~Float64Type() = default; + + TypeId type_id() const override; + std::string ToString() const override; + + protected: + bool Equals(const Type& other) const override; +}; + +/// \brief A data type representing a fixed-precision decimal. +class ICEBERG_EXPORT DecimalType : public PrimitiveType { + public: + constexpr static const int32_t kMaxPrecision = 38; Review Comment: Is it worth adding enforcement of constant style to `.clang-tidy`? Now it seems that we prefer `kMaxPrecision` over `MAX_PRECISION` -- 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] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
