Add getters and setters for field_nullability and field_metadata

Author: stenlarsson

c_glib/arrow-glib/compute.cpp

@@ -34,6 +34,7 @@
 #include <arrow-glib/schema.hpp>
 #include <arrow-glib/table.hpp>
 #include <arrow-glib/type.hpp>
+#include <arrow-glib/internal-hash-table.hpp>
 
 #include <arrow/acero/exec_plan.h>
 #include <arrow/acero/options.h>
@@ -7615,6 +7616,115 @@ garrow_make_struct_options_new(void)
   return GARROW_MAKE_STRUCT_OPTIONS(options);
 }
 
+/**
+ * garrow_make_struct_options_set_field_nullability:
+ * @options: A #GArrowMakeStructOptions.
+ * @nullability: (element-type gboolean) (nullable) (transfer none): A #GList
+ *   of nullability values, or %NULL.
+ *
+ * Sets the nullability information for each struct field.
+ *
+ * Since: 23.0.0
+ */
+void
+garrow_make_struct_options_set_field_nullability(GArrowMakeStructOptions *options,
+                                                  GList *nullability)
+{
+  auto arrow_options = static_cast<arrow::compute::MakeStructOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+  arrow_options->field_nullability.clear();
+  if (nullability) {
+    for (GList *node = nullability; node; node = node->next) {
+      gboolean value = GPOINTER_TO_INT(node->data);
+      arrow_options->field_nullability.push_back(value != FALSE);
+    }
+  }
+}
+
+/**
+ * garrow_make_struct_options_get_field_nullability:
+ * @options: A #GArrowMakeStructOptions.
+ *
+ * Returns: (element-type gboolean) (transfer full): A #GList of nullability
+ *   values. It should be freed with g_list_free() when no longer needed.
+ *
+ * Gets the nullability information for each struct field.
+ *
+ * Since: 23.0.0
+ */
+GList *
+garrow_make_struct_options_get_field_nullability(GArrowMakeStructOptions *options)
+{
+  auto arrow_options = static_cast<arrow::compute::MakeStructOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+  const auto &arrow_nullability = arrow_options->field_nullability;
+  GList *list = NULL;
+  for (gsize i = 0; i < arrow_nullability.size(); ++i) {
+    gboolean value = arrow_nullability[i] ? TRUE : FALSE;
+    list = g_list_prepend(list, GINT_TO_POINTER(value));
+  }
+  return g_list_reverse(list);
+}
+
+/**
+ * garrow_make_struct_options_set_field_metadata:
+ * @options: A #GArrowMakeStructOptions.
+ * @metadata: (element-type GHashTable) (nullable) (transfer none): A #GList of
+ *   #GHashTable for each field's metadata, or %NULL.
+ *
+ * Sets the metadata for each struct field.
+ *
+ * Since: 23.0.0
+ */
+void
+garrow_make_struct_options_set_field_metadata(GArrowMakeStructOptions *options,
+                                               GList *metadata)
+{
+  auto arrow_options = static_cast<arrow::compute::MakeStructOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+  arrow_options->field_metadata.clear();
+  if (metadata) {
+    for (GList *node = metadata; node; node = node->next) {
+      auto hash_table = static_cast<GHashTable *>(node->data);
+      if (hash_table) {
+        arrow_options->field_metadata.push_back(
+          garrow_internal_hash_table_to_metadata(hash_table));
+      } else {
+        arrow_options->field_metadata.push_back(NULLPTR);
+      }
+    }
+  }
+}
+
+/**
+ * garrow_make_struct_options_get_field_metadata:
+ * @options: A #GArrowMakeStructOptions.
+ *
+ * Returns: (element-type GHashTable) (transfer full): A #GList of #GHashTable
+ *   for each field's metadata. It should be freed with g_list_free_full() and
+ *   g_hash_table_unref() when no longer needed.
+ *
+ * Gets the metadata for each struct field.
+ *
+ * Since: 23.0.0
+ */
+GList *
+garrow_make_struct_options_get_field_metadata(GArrowMakeStructOptions *options)
+{
+  auto arrow_options = static_cast<arrow::compute::MakeStructOptions *>(
+    garrow_function_options_get_raw(GARROW_FUNCTION_OPTIONS(options)));
+  const auto &arrow_metadata = arrow_options->field_metadata;
+  GList *list = NULL;
+  for (gsize i = 0; i < arrow_metadata.size(); ++i) {
+    GHashTable *hash_table = NULL;
+    if (arrow_metadata[i] && arrow_metadata[i].get()) {
+      hash_table = garrow_internal_hash_table_from_metadata(arrow_metadata[i]);
+    }
+    list = g_list_prepend(list, hash_table);
+  }
+  return g_list_reverse(list);
+}
+
 G_END_DECLS
 
 arrow::Result<arrow::FieldRef>

c_glib/arrow-glib/compute.h

@@ -1354,4 +1354,22 @@ GARROW_AVAILABLE_IN_23_0
 GArrowMakeStructOptions *
 garrow_make_struct_options_new(void);
 
+GARROW_AVAILABLE_IN_23_0
+void
+garrow_make_struct_options_set_field_nullability(GArrowMakeStructOptions *options,
+                                                  GList *nullability);
+
+GARROW_AVAILABLE_IN_23_0
+GList *
+garrow_make_struct_options_get_field_nullability(GArrowMakeStructOptions *options);
+
+GARROW_AVAILABLE_IN_23_0
+void
+garrow_make_struct_options_set_field_metadata(GArrowMakeStructOptions *options,
+                                               GList *metadata);
+
+GARROW_AVAILABLE_IN_23_0
+GList *
+garrow_make_struct_options_get_field_metadata(GArrowMakeStructOptions *options);
+
 G_END_DECLS

c_glib/arrow-glib/internal-hash-table.hpp

@@ -40,7 +40,7 @@ garrow_internal_hash_table_to_metadata(GHashTable *metadata)
 
 static inline GHashTable *
 garrow_internal_hash_table_from_metadata(
-  const std::shared_ptr<arrow::KeyValueMetadata> &arrow_metadata)
+  const std::shared_ptr<const arrow::KeyValueMetadata> &arrow_metadata)
 {
   auto metadata = g_hash_table_new_full(g_str_hash, g_str_equal, g_free, g_free);
   const auto &keys = arrow_metadata->keys();

c_glib/test/test-make-struct-options.rb

@@ -28,6 +28,25 @@ def test_field_names_property
     assert_equal(["a", "b", "c"], @options.field_names)
   end
 
+  def test_field_nullability_property
+    assert_equal([], @options.field_nullability)
+    @options.field_names = ["a", "b", "c"]
+    @options.field_nullability = [true, false, true]
+    assert_equal([true, false, true], @options.field_nullability)
+  end
+
+  def test_field_metadata_property
+    assert_equal([], @options.field_metadata)
+    @options.field_names = ["a", "b"]
+    metadata1 = {"key1" => "value1", "key2" => "value2"}
+    metadata2 = {"key3" => "value3"}
+    @options.field_metadata = [metadata1, metadata2]
+    result = @options.field_metadata
+    assert_equal(2, result.size)
+    assert_equal(metadata1, result[0])
+    assert_equal(metadata2, result[1])
+  end
+
   def test_make_struct_function
     a = build_int8_array([1, 2, 3])
     b = build_boolean_array([true, false, nil])
@@ -52,4 +71,49 @@ def test_make_struct_function
     )
     assert_equal(expected, result)
   end
+
+  def test_make_struct_function_with_nullability
+    a = build_int8_array([1, 2, 3])
+    b = build_boolean_array([true, false, nil])
+    args = [
+      Arrow::ArrayDatum.new(a),
+      Arrow::ArrayDatum.new(b),
+    ]
+    @options.field_names = ["a", "b"]
+    @options.field_nullability = [false, true]
+    make_struct_function = Arrow::Function.find("make_struct")
+    result = make_struct_function.execute(args, @options).value
+
+    expected = build_struct_array(
+      [
+        Arrow::Field.new("a", Arrow::Int8DataType.new, false),
+        Arrow::Field.new("b", Arrow::BooleanDataType.new, true),
+      ],
+      [
+        {"a" => 1, "b" => true},
+        {"a" => 2, "b" => false},
+        {"a" => 3, "b" => nil},
+      ]
+    )
+    assert_equal(expected, result)
+  end
+
+  def test_make_struct_function_with_metadata
+    a = build_int8_array([1, 2, 3])
+    b = build_boolean_array([true, false, nil])
+    args = [
+      Arrow::ArrayDatum.new(a),
+      Arrow::ArrayDatum.new(b),
+    ]
+    @options.field_names = ["a", "b"]
+    metadata1 = {"key1" => "value1"}
+    metadata2 = {"key2" => "value2"}
+    @options.field_metadata = [metadata1, metadata2]
+    make_struct_function = Arrow::Function.find("make_struct")
+    result = make_struct_function.execute(args, @options).value
+
+    fields = result.value_data_type.fields
+    assert_equal(metadata1, fields[0].metadata)
+    assert_equal(metadata2, fields[1].metadata)
+  end
 end