fix: properly handle structs and nested list when decoding (#90)

* fix: properly handle nested lists when decoding * test: add a test case for `Adbc.Result.to_map/1` when list views in the result set * fix: properly handle structs when decoding * revert the default value of `metadata` to `nil` * minor fix for timestamp types
elixir-explorer · Jun 3, 2024 · 46bcbca · 46bcbca
1 parent 53dc000
commit 46bcbca
Show file tree

Hide file tree

Showing 8 changed files with 287 additions and 493 deletions.
diff --git a/c_src/adbc_arrow_array.hpp b/c_src/adbc_arrow_array.hpp
diff --git a/c_src/adbc_consts.h b/c_src/adbc_consts.h
@@ -18,7 +18,7 @@ static ERL_NIF_TERM kAtomStructKey;
 //   name: "sample_list_view",
 //   type: :list_view,
 //   nullable: true,
-//   metadata: %{},
+//   metadata: nil,
 //   data: %{
 //     validity: [true, false, true, true, true],
 //     offsets: [4, 7, 0, 0, 3],
@@ -27,7 +27,7 @@ static ERL_NIF_TERM kAtomStructKey;
 //       name: "sample_list",
 //       type: :i32,
 //       nullable: false,
-//       metadata: %{},
+//       metadata: nil,
 //       data: [0, -127, 127, 50, 12, -7, 25]
 //     }
 //   }

diff --git a/c_src/adbc_nif.cpp b/c_src/adbc_nif.cpp
@@ -519,15 +519,15 @@ static ERL_NIF_TERM adbc_arrow_array_stream_next(ErlNifEnv *env, int argc, const
         if (out.release) out.release(&out);
         return error;
     }
+    if (end_of_series) {
+        if (out.release) {
+            out.release(&out);
+        }
+        return kAtomEndOfSeries;
+    }
 
     if (out_terms.size() == 1) {
         ret = out_terms[0];
-        if (end_of_series) {
-            if (out.release) {
-                out.release(&out);
-            }
-            return kAtomEndOfSeries;
-        }
     } else {
         ret = enif_make_tuple2(env, out_terms[0], out_terms[1]);
     }

diff --git a/lib/adbc_column.ex b/lib/adbc_column.ex
@@ -8,7 +8,7 @@ defmodule Adbc.Column do
   defstruct name: nil,
             type: nil,
             nullable: false,
-            metadata: %{},
+            metadata: nil,
             data: nil
 
   @type i8 :: -128..127
@@ -98,6 +98,7 @@ defmodule Adbc.Column do
           | :large_string
           | decimal_t
           | {:fixed_size_binary, non_neg_integer()}
+          | :struct
           | :date32
           | :date64
           | time_t
@@ -110,7 +111,7 @@ defmodule Adbc.Column do
              (is_list(data) or (type in @list_view_types and is_map(data))) and is_list(opts) do
     name = opts[:name]
     nullable = opts[:nullable] || false
-    metadata = opts[:metadata] || %{}
+    metadata = opts[:metadata] || nil
 
     %Adbc.Column{
       name: name,
@@ -165,7 +166,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :boolean,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [true, false, true]
       }
 
@@ -196,7 +197,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :u8,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -227,7 +228,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :u16,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -258,7 +259,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :u32,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -289,7 +290,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :u32,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -320,7 +321,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :i8,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -351,7 +352,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :i16,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -382,7 +383,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :i32,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -413,7 +414,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :i64,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1, 2, 3]
       }
 
@@ -444,7 +445,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :f16,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1.0, 2.0, 3.0]
       }
 
@@ -475,7 +476,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :f32,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1.0, 2.0, 3.0]
       }
 
@@ -506,7 +507,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :f64,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [1.0, 2.0, 3.0]
       }
 
@@ -646,7 +647,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :string,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: ["a", "ab", "abc"]
       }
 
@@ -679,7 +680,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :large_string,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: ["a", "ab", "abc"]
       }
 
@@ -710,7 +711,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :binary,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [<<0>>, <<1>>, <<2>>]
       }
 
@@ -743,7 +744,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :large_binary,
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [<<0>>, <<1>>, <<2>>]
       }
 
@@ -777,7 +778,7 @@ defmodule Adbc.Column do
         name: nil,
         type: {:fixed_size_binary, 1},
         nullable: false,
-        metadata: %{},
+        metadata: nil,
         data: [<<0>>, <<1>>, <<2>>]
       }
 
@@ -1096,7 +1097,7 @@ defmodule Adbc.Column do
       ...>   name: nil,
       ...>   type: :list_view,
       ...>   nullable: true,
-      ...>   metadata: %{},
+      ...>   metadata: nil,
       ...>   data: %{
       ...>     values: %Adbc.Column{
       ...>       name: "item",
@@ -1114,7 +1115,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :list_view,
         nullable: true,
-        metadata: %{},
+        metadata: nil,
         data: %{
           offsets: [4, 7, 0, 0, 3],
           sizes: [3, 0, 4, 0, 2],
@@ -1133,7 +1134,7 @@ defmodule Adbc.Column do
         name: nil,
         type: :list,
         nullable: true,
-        metadata: %{},
+        metadata: nil,
         data: [
           %Adbc.Column{
             name: "item",

diff --git a/lib/adbc_result.ex b/lib/adbc_result.ex
@@ -18,9 +18,8 @@ defmodule Adbc.Result do
   @doc """
   Returns a map of columns as a result.
   """
-  def to_map(result=%Adbc.Result{}) do
-    result = list_view_to_list(result)
-    Map.new(result.data, fn %Adbc.Column{name: name, type: type, data: data} ->
+  def to_map(result = %Adbc.Result{}) do
+    Map.new(list_view_to_list(result).data, fn %Adbc.Column{name: name, type: type, data: data} ->
       case type do
         :list -> {name, Enum.map(data, &list_to_map/1)}
         _ -> {name, data}
@@ -47,6 +46,9 @@ defmodule Adbc.Result do
           {name, list}
         end
 
+      :struct ->
+        Enum.map(data, &list_to_map/1)
+
       _ ->
         if name == "item" do
           data