scalar func: main extra info

jraymakers · jraymakers · commit 76fb84a5c3e2 · 2025-07-28T19:28:59.000-07:00
diff --git a/bindings/pkgs/@duckdb/node-bindings/duckdb.d.ts b/bindings/pkgs/@duckdb/node-bindings/duckdb.d.ts
@@ -1039,17 +1039,21 @@ export function scalar_function_set_name(scalar_function: ScalarFunction, name:
 export function scalar_function_set_return_type(scalar_function: ScalarFunction, logical_type: LogicalType): void;
 
 // DUCKDB_C_API void duckdb_scalar_function_set_extra_info(duckdb_scalar_function scalar_function, void *extra_info, duckdb_delete_callback_t destroy);
+// not exposed: combined with scalar_function_set_function
+
 // DUCKDB_C_API void duckdb_scalar_function_set_bind(duckdb_scalar_function scalar_function, duckdb_scalar_function_bind_t bind);
 // DUCKDB_C_API void duckdb_scalar_function_set_bind_data(duckdb_bind_info info, void *bind_data, duckdb_delete_callback_t destroy);
 // DUCKDB_C_API void duckdb_scalar_function_bind_set_error(duckdb_bind_info info, const char *error);
 
 // DUCKDB_C_API void duckdb_scalar_function_set_function(duckdb_scalar_function scalar_function, duckdb_scalar_function_t function);
-export function scalar_function_set_function(scalar_function: ScalarFunction, func: ScalarFunctionMainFunction): void;
+export function scalar_function_set_function(scalar_function: ScalarFunction, func: ScalarFunctionMainFunction, extra_info?: object): void;
 
 // DUCKDB_C_API duckdb_state duckdb_register_scalar_function(duckdb_connection con, duckdb_scalar_function scalar_function);
 export function register_scalar_function(connection: Connection, scalar_function: ScalarFunction): void;
 
 // DUCKDB_C_API void *duckdb_scalar_function_get_extra_info(duckdb_function_info info);
+export function scalar_function_get_extra_info(function_info: FunctionInfo): object | undefined;
+
 // DUCKDB_C_API void *duckdb_scalar_function_get_bind_data(duckdb_function_info info);
 // DUCKDB_C_API void duckdb_scalar_function_get_client_context(duckdb_bind_info info, duckdb_client_context *out_context);
 
diff --git a/bindings/src/duckdb_node_bindings.cpp b/bindings/src/duckdb_node_bindings.cpp
@@ -712,22 +712,28 @@ using ScalarFunctionMainTSFN = Napi::TypedThreadSafeFunction<ScalarFunctionMainC
 
 struct ScalarFunctionMainExtraInfo {
   ScalarFunctionMainTSFN tsfn;
-  // TODO: user extra info
+  Napi::ObjectReference user_extra_info_ref;
 };
 
-ScalarFunctionMainExtraInfo *CreateScalarFunctionMainExtraInfo(Napi::Env env, Napi::Function func) {
+ScalarFunctionMainExtraInfo *CreateScalarFunctionMainExtraInfo(Napi::Env env, Napi::Function func, Napi::Object user_extra_info) {
   auto extra_info = reinterpret_cast<ScalarFunctionMainExtraInfo*>(duckdb_malloc(sizeof(ScalarFunctionMainExtraInfo)));
   extra_info->tsfn = ScalarFunctionMainTSFN::New(env, func, "ScalarFunctionMain", 0, 1);
+  extra_info->user_extra_info_ref = user_extra_info.IsUndefined() ? Napi::ObjectReference() : Napi::Persistent(user_extra_info);
   return extra_info;
 }
 
+ScalarFunctionMainExtraInfo *GetScalarFunctionMainExtraInfo(duckdb_function_info function_info) {
+  return reinterpret_cast<ScalarFunctionMainExtraInfo*>(duckdb_scalar_function_get_extra_info(function_info));
+}
+
 void DeleteScalarFunctionMainExtraInfo(ScalarFunctionMainExtraInfo *extra_info) {
   extra_info->tsfn.Release();
+  extra_info->user_extra_info_ref.Reset();
   duckdb_free(extra_info);
 }
 
 void ScalarFunctionMainFunction(duckdb_function_info info, duckdb_data_chunk input, duckdb_vector output) {
-  auto extra_info = reinterpret_cast<ScalarFunctionMainExtraInfo*>(duckdb_scalar_function_get_extra_info(info));
+  auto extra_info = GetScalarFunctionMainExtraInfo(info);
   auto data = reinterpret_cast<ScalarFunctionMainData*>(duckdb_malloc(sizeof(ScalarFunctionMainData)));
   data->info = info;
   data->input = input;
@@ -1553,6 +1559,7 @@ class DuckDBNodeAddon : public Napi::Addon<DuckDBNodeAddon> {
       InstanceMethod("scalar_function_set_return_type", &DuckDBNodeAddon::scalar_function_set_return_type),
       InstanceMethod("scalar_function_set_function", &DuckDBNodeAddon::scalar_function_set_function),
       InstanceMethod("register_scalar_function", &DuckDBNodeAddon::register_scalar_function),
+      InstanceMethod("scalar_function_get_extra_info", &DuckDBNodeAddon::scalar_function_get_extra_info),
       InstanceMethod("scalar_function_set_error", &DuckDBNodeAddon::scalar_function_set_error),
 
       InstanceMethod("appender_create", &DuckDBNodeAddon::appender_create),
@@ -4055,17 +4062,20 @@ class DuckDBNodeAddon : public Napi::Addon<DuckDBNodeAddon> {
   }
 
   // DUCKDB_C_API void duckdb_scalar_function_set_extra_info(duckdb_scalar_function scalar_function, void *extra_info, duckdb_delete_callback_t destroy);
+  // not exposed: combined with scalar_function_set_function
+
   // DUCKDB_C_API void duckdb_scalar_function_set_bind(duckdb_scalar_function scalar_function, duckdb_scalar_function_bind_t bind);
   // DUCKDB_C_API void duckdb_scalar_function_set_bind_data(duckdb_bind_info info, void *bind_data, duckdb_delete_callback_t destroy);
   // DUCKDB_C_API void duckdb_scalar_function_bind_set_error(duckdb_bind_info info, const char *error);
 
   // DUCKDB_C_API void duckdb_scalar_function_set_function(duckdb_scalar_function scalar_function, duckdb_scalar_function_t function);
-  // function scalar_function_set_function(scalar_function: ScalarFunction, func: ScalarFunctionMainFunction): void
+  // function scalar_function_set_function(scalar_function: ScalarFunction, func: ScalarFunctionMainFunction, extra_info?: object): void
   Napi::Value scalar_function_set_function(const Napi::CallbackInfo& info) {
     auto env = info.Env();
     auto scalar_function = GetScalarFunctionFromExternal(env, info[0]);
     auto func = info[1].As<Napi::Function>();
-    auto extra_info = CreateScalarFunctionMainExtraInfo(env, func);
+    auto user_extra_info = info[2].As<Napi::Object>();
+    auto extra_info = CreateScalarFunctionMainExtraInfo(env, func, user_extra_info);
     duckdb_scalar_function_set_extra_info(scalar_function, extra_info, reinterpret_cast<duckdb_delete_callback_t>(DeleteScalarFunctionMainExtraInfo));
     duckdb_scalar_function_set_function(scalar_function, &ScalarFunctionMainFunction);
     return env.Undefined();
@@ -4084,6 +4094,17 @@ class DuckDBNodeAddon : public Napi::Addon<DuckDBNodeAddon> {
   }
 
   // DUCKDB_C_API void *duckdb_scalar_function_get_extra_info(duckdb_function_info info);
+  // function scalar_function_get_extra_info(function_info: FunctionInfo): object | undefined
+  Napi::Value scalar_function_get_extra_info(const Napi::CallbackInfo& info) {
+    auto env = info.Env();
+    auto function_info = GetFunctionInfoFromExternal(env, info[0]);
+    auto extra_info = GetScalarFunctionMainExtraInfo(function_info);
+    if (extra_info->user_extra_info_ref.IsEmpty()) {
+      return env.Undefined();
+    }
+    return extra_info->user_extra_info_ref.Value();
+  }
+
   // DUCKDB_C_API void *duckdb_scalar_function_get_bind_data(duckdb_function_info info);
   // DUCKDB_C_API void duckdb_scalar_function_get_client_context(duckdb_bind_info info, duckdb_client_context *out_context);
 
@@ -4691,14 +4712,14 @@ NODE_API_ADDON(DuckDBNodeAddon)
   ---
   431 total functions
 
-  252 instance methods
+  253 instance methods
     3 unimplemented client context functions
     1 unimplemented table names function
     1 unimplemented value to string function
     1 unimplemented logical type function
     2 unimplemented vector creation functions
     3 unimplemented vector manipulation functions
-   11 unimplemented scalar function functions
+   10 unimplemented scalar function functions
     4 unimplemented scalar function set functions
     3 unimplemented selection vector functions
    12 unimplemented aggregate function functions
@@ -4713,7 +4734,7 @@ NODE_API_ADDON(DuckDBNodeAddon)
     6 unimplemented table description functions
     8 unimplemented tasks functions
    12 unimplemented cast function functions
-   23 functions not exposed
+   24 functions not exposed
 +  41 unimplemented deprecated functions (of 47)
   ---
   431 functions accounted for
diff --git a/bindings/test/scalar_functions.test.ts b/bindings/test/scalar_functions.test.ts
@@ -18,7 +18,7 @@ suite('scalar functions', () => {
     const int_type = duckdb.create_logical_type(duckdb.Type.INTEGER);
     duckdb.scalar_function_set_return_type(scalar_function, int_type);
   });
-  test('register & run', async () => {
+  test('register & run (no extra info)', async () => {
     await withConnection(async (connection) => {
       const scalar_function = duckdb.create_scalar_function();
       duckdb.scalar_function_set_name(scalar_function, 'my_func');
@@ -46,4 +46,33 @@ suite('scalar functions', () => {
       duckdb.destroy_scalar_function_sync(scalar_function);
     });
   });
+  test('register & run (extra info)', async () => {
+    await withConnection(async (connection) => {
+      const scalar_function = duckdb.create_scalar_function();
+      duckdb.scalar_function_set_name(scalar_function, 'my_func');
+      const int_type = duckdb.create_logical_type(duckdb.Type.VARCHAR);
+      duckdb.scalar_function_set_return_type(scalar_function, int_type);
+      duckdb.scalar_function_set_function(scalar_function, (info, input, output) => {
+        const extra_info = duckdb.scalar_function_get_extra_info(info);
+        const inputSize = duckdb.data_chunk_get_size(input);
+        for (let i = 0; i < inputSize; i++) {
+          duckdb.vector_assign_string_element(output, i, `output_${i}_${JSON.stringify(extra_info)}`);
+        }
+      }, { 'my_extra_info_key': 'my_extra_info_value' });
+      duckdb.register_scalar_function(connection, scalar_function);
+
+      const result = await duckdb.query(connection, "select my_func()");
+      await expectResult(result, {
+        chunkCount: 1,
+        rowCount: 1,
+        columns: [
+          { name: 'my_func()', logicalType: { typeId: duckdb.Type.VARCHAR } }
+        ],
+        chunks: [
+          { rowCount: 1, vectors: [data(16, [true], ['output_0_{"my_extra_info_key":"my_extra_info_value"}'])]}
+        ],
+      });
+      duckdb.destroy_scalar_function_sync(scalar_function);
+    });
+  });
 });
