Merge branch 'main' into add_table_metadata

Author: wgtmac

LICENSE

@@ -227,3 +227,30 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
+
+--------------------------------------------------------------------------------
+
+3rdparty dependency nlohmann-json is statically linked in certain binary
+distributions. nlohmann-json has the following license:
+
+MIT License
+
+Copyright (c) 2013-2022 Niels Lohmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

cmake_modules/IcebergThirdpartyToolchain.cmake

@@ -226,3 +226,36 @@ function(resolve_nanoarrow_dependency)
 endfunction()
 
 resolve_nanoarrow_dependency()
+
+# ----------------------------------------------------------------------
+# nlohmann-json
+
+function(resolve_nlohmann_json_dependency)
+  prepare_fetchcontent()
+
+  set(JSON_BuildTests
+      OFF
+      CACHE BOOL "" FORCE)
+
+  fetchcontent_declare(nlohmann_json
+                       ${FC_DECLARE_COMMON_OPTIONS}
+                       URL "https://github.com/nlohmann/json/releases/download/v3.11.3/json.tar.xz"
+  )
+  fetchcontent_makeavailable(nlohmann_json)
+
+  set_target_properties(nlohmann_json
+                        PROPERTIES OUTPUT_NAME "iceberg_vendored_nlohmann_json"
+                                   POSITION_INDEPENDENT_CODE ON)
+  if(MSVC_TOOLCHAIN)
+    set(NLOHMANN_NATVIS_FILE ${nlohmann_json_SOURCE_DIR}/nlohmann_json.natvis)
+    install(FILES ${NLOHMANN_NATVIS_FILE} DESTINATION .)
+  endif()
+
+  install(TARGETS nlohmann_json
+          EXPORT iceberg_targets
+          RUNTIME DESTINATION "${ICEBERG_INSTALL_BINDIR}"
+          ARCHIVE DESTINATION "${ICEBERG_INSTALL_LIBDIR}"
+          LIBRARY DESTINATION "${ICEBERG_INSTALL_LIBDIR}")
+endfunction()
+
+resolve_nlohmann_json_dependency()

src/iceberg/CMakeLists.txt

@@ -25,6 +25,8 @@ set(ICEBERG_SOURCES
     schema_internal.cc
     partition_field.cc
     partition_spec.cc
+    sort_field.cc
+    sort_order.cc
     statistics_file.cc
     table_metadata.cc
     transform.cc
@@ -35,10 +37,14 @@ set(ICEBERG_SHARED_BUILD_INTERFACE_LIBS)
 set(ICEBERG_STATIC_INSTALL_INTERFACE_LIBS)
 set(ICEBERG_SHARED_INSTALL_INTERFACE_LIBS)
 
-list(APPEND ICEBERG_STATIC_BUILD_INTERFACE_LIBS nanoarrow::nanoarrow)
-list(APPEND ICEBERG_SHARED_BUILD_INTERFACE_LIBS nanoarrow::nanoarrow)
-list(APPEND ICEBERG_STATIC_INSTALL_INTERFACE_LIBS "Iceberg::nanoarrow")
-list(APPEND ICEBERG_SHARED_INSTALL_INTERFACE_LIBS "Iceberg::nanoarrow")
+list(APPEND ICEBERG_STATIC_BUILD_INTERFACE_LIBS nanoarrow::nanoarrow
+     nlohmann_json::nlohmann_json)
+list(APPEND ICEBERG_SHARED_BUILD_INTERFACE_LIBS nanoarrow::nanoarrow
+     nlohmann_json::nlohmann_json)
+list(APPEND ICEBERG_STATIC_INSTALL_INTERFACE_LIBS "Iceberg::nanoarrow"
+     "Iceberg::nlohmann_json")
+list(APPEND ICEBERG_SHARED_INSTALL_INTERFACE_LIBS "Iceberg::nanoarrow"
+     "Iceberg::nlohmann_json")
 
 add_iceberg_lib(iceberg
                 SOURCES

src/iceberg/arrow_c_data_internal.cc

@@ -23,6 +23,8 @@
 #include <string>
 #include <utility>
 
+#include <nlohmann/json.hpp>
+
 namespace iceberg::internal {
 
 std::pair<ArrowSchema, ArrowArray> CreateExampleArrowSchemaAndArrayByNanoarrow() {
@@ -73,4 +75,11 @@ std::pair<ArrowSchema, ArrowArray> CreateExampleArrowSchemaAndArrayByNanoarrow()
   return {out_schema, out_array};
 }
 
+void TestNlohmannJsonCompile() {
+  nlohmann::json j;
+  j["name"] = "foo";
+  j["age"] = 30;
+  j["city"] = "New York";
+}
+
 }  // namespace iceberg::internal

src/iceberg/sort_field.cc

@@ -0,0 +1,84 @@
+/*
+ * 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 "iceberg/sort_field.h"
+
+#include <format>
+
+#include "iceberg/transform.h"
+#include "iceberg/type.h"
+#include "iceberg/util/formatter.h"
+
+namespace iceberg {
+
+namespace {
+/// \brief Get the relative sort direction name
+constexpr std::string_view ToString(SortDirection direction) {
+  switch (direction) {
+    case SortDirection::kAscending:
+      return "asc";
+    case SortDirection::kDescending:
+      return "desc";
+    default:
+      return "invalid";
+  }
+}
+
+/// \brief Get the relative null order name
+constexpr std::string_view ToString(NullOrder null_order) {
+  switch (null_order) {
+    case NullOrder::kFirst:
+      return "nulls-first";
+    case NullOrder::kLast:
+      return "nulls-last";
+    default:
+      return "invalid";
+  }
+}
+}  // namespace
+
+SortField::SortField(int32_t source_id, std::shared_ptr<TransformFunction> transform,
+                     SortDirection direction, NullOrder null_order)
+    : source_id_(source_id),
+      transform_(std::move(transform)),
+      direction_(direction),
+      null_order_(null_order) {}
+
+int32_t SortField::source_id() const { return source_id_; }
+
+std::shared_ptr<TransformFunction> const& SortField::transform() const {
+  return transform_;
+}
+
+SortDirection SortField::direction() const { return direction_; }
+
+NullOrder SortField::null_order() const { return null_order_; }
+
+std::string SortField::ToString() const {
+  return std::format(
+      "sort_field(source_id={}, transform={}, direction={}, null_order={})", source_id_,
+      *transform_, iceberg::ToString(direction_), iceberg::ToString(null_order_));
+}
+
+bool SortField::Equals(const SortField& other) const {
+  return source_id_ == other.source_id_ && *transform_ == *other.transform_ &&
+         direction_ == other.direction_ && null_order_ == other.null_order_;
+}
+
+}  // namespace iceberg

src/iceberg/sort_field.h

@@ -0,0 +1,95 @@
+/*
+ * 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/sort_field.h
+/// A sort field in a sort order
+
+#include <cstdint>
+#include <memory>
+#include <string>
+#include <string_view>
+#include <vector>
+
+#include "iceberg/iceberg_export.h"
+#include "iceberg/type_fwd.h"
+#include "iceberg/util/formattable.h"
+
+namespace iceberg {
+
+/// \brief Sort direction in a partition, either ascending or descending
+enum class SortDirection {
+  /// Ascending
+  kAscending,
+  /// Descending
+  kDescending,
+};
+
+enum class NullOrder {
+  /// Nulls are sorted first
+  kFirst,
+  /// Nulls are sorted last
+  kLast,
+};
+
+/// \brief a field with its transform.
+class ICEBERG_EXPORT SortField : public util::Formattable {
+ public:
+  /// \brief Construct a field.
+  /// \param[in] source_id The source field ID.
+  /// \param[in] transform The transform function.
+  /// \param[in] direction The sort direction.
+  /// \param[in] null_order The null order.
+  SortField(int32_t source_id, std::shared_ptr<TransformFunction> transform,
+            SortDirection direction, NullOrder null_order);
+
+  /// \brief Get the source field ID.
+  int32_t source_id() const;
+
+  /// \brief Get the transform type.
+  const std::shared_ptr<TransformFunction>& transform() const;
+
+  /// \brief Get the sort direction.
+  SortDirection direction() const;
+
+  /// \brief Get the null order.
+  NullOrder null_order() const;
+
+  std::string ToString() const override;
+
+  friend bool operator==(const SortField& lhs, const SortField& rhs) {
+    return lhs.Equals(rhs);
+  }
+
+  friend bool operator!=(const SortField& lhs, const SortField& rhs) {
+    return !(lhs == rhs);
+  }
+
+ private:
+  /// \brief Compare two fields for equality.
+  [[nodiscard]] bool Equals(const SortField& other) const;
+
+  int32_t source_id_;
+  std::shared_ptr<TransformFunction> transform_;
+  SortDirection direction_;
+  NullOrder null_order_;
+};
+
+}  // namespace iceberg

src/iceberg/sort_order.cc

@@ -0,0 +1,48 @@
+/*
+ * 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 "iceberg/sort_order.h"
+
+#include <format>
+
+#include "iceberg/util/formatter.h"
+
+namespace iceberg {
+
+SortOrder::SortOrder(int64_t order_id, std::vector<SortField> fields)
+    : order_id_(order_id), fields_(std::move(fields)) {}
+
+int64_t SortOrder::order_id() const { return order_id_; }
+
+std::span<const SortField> SortOrder::fields() const { return fields_; }
+
+std::string SortOrder::ToString() const {
+  std::string repr = std::format("sort_order[order_id<{}>,\n", order_id_);
+  for (const auto& field : fields_) {
+    std::format_to(std::back_inserter(repr), "  {}\n", field);
+  }
+  repr += "]";
+  return repr;
+}
+
+bool SortOrder::Equals(const SortOrder& other) const {
+  return order_id_ == other.order_id_ && fields_ == other.fields_;
+}
+
+}  // namespace iceberg