Skip to content

Commit 4208662

Browse files
suketasuketa
authored
Merge pull request #1096 from suketa/feature/table-function
feat: Add DuckDB::TableFunction core container (Phase 1/6)
2 parents 1b5b4af + 80fb446 commit 4208662

File tree

8 files changed

+272
-0
lines changed

8 files changed

+272
-0
lines changed

‎CHANGELOG.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
All notable changes to this project will be documented in this file.
44

55
# Unreleased
6+
- add DuckDB::TableFunction class (Phase 1: Core container).
7+
- add DuckDB::TableFunction#initialize for standard Ruby allocation pattern.
8+
- add DuckDB::TableFunction#name= for setting function name.
9+
- add DuckDB::TableFunction#add_parameter for positional parameters.
10+
- add DuckDB::TableFunction#add_named_parameter for named parameters.
611
- bump duckdb to 1.4.4 on CI.
712
- add inline style to DuckDB::Connection#register_scalar_function (accepts keyword arguments + block).
813
- add DuckDB::ScalarFunction.create class method for declarative API.

‎ext/duckdb/duckdb.c‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,4 +42,5 @@ Init_duckdb_native(void) {
4242
rbduckdb_init_duckdb_instance_cache();
4343
rbduckdb_init_duckdb_value_impl();
4444
rbduckdb_init_duckdb_scalar_function();
45+
rbduckdb_init_duckdb_table_function();
4546
}

‎ext/duckdb/ruby-duckdb.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
#include "./instance_cache.h"
3131
#include "./value_impl.h"
3232
#include "./scalar_function.h"
33+
#include "./table_function.h"
3334

3435
extern VALUE mDuckDB;
3536
extern VALUE cDuckDBDatabase;

‎ext/duckdb/table_function.c‎

Lines changed: 154 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,154 @@
1+
#include "ruby-duckdb.h"
2+
3+
static VALUE cDuckDBTableFunction;
4+
5+
static void deallocate(void *ctx);
6+
static VALUE allocate(VALUE klass);
7+
static size_t memsize(const void *p);
8+
static VALUE duckdb_table_function_initialize(VALUE self);
9+
static VALUE rbduckdb_table_function_set_name(VALUE self, VALUE name);
10+
static VALUE rbduckdb_table_function_add_parameter(VALUE self, VALUE logical_type);
11+
static VALUE rbduckdb_table_function_add_named_parameter(VALUE self, VALUE name, VALUE logical_type);
12+
13+
static const rb_data_type_t table_function_data_type = {
14+
"DuckDB/TableFunction",
15+
{NULL, deallocate, memsize,},
16+
0, 0, RUBY_TYPED_FREE_IMMEDIATELY
17+
};
18+
19+
static void deallocate(void *ctx) {
20+
rubyDuckDBTableFunction *p = (rubyDuckDBTableFunction *)ctx;
21+
22+
if (p->table_function) {
23+
duckdb_destroy_table_function(&(p->table_function));
24+
p->table_function = NULL;
25+
}
26+
xfree(p);
27+
}
28+
29+
static VALUE allocate(VALUE klass) {
30+
rubyDuckDBTableFunction *ctx = xcalloc((size_t)1, sizeof(rubyDuckDBTableFunction));
31+
return TypedData_Wrap_Struct(klass, &table_function_data_type, ctx);
32+
}
33+
34+
static size_t memsize(const void *p) {
35+
return sizeof(rubyDuckDBTableFunction);
36+
}
37+
38+
/*
39+
* call-seq:
40+
* DuckDB::TableFunction.new -> DuckDB::TableFunction
41+
*
42+
* Creates a new table function.
43+
*
44+
* tf = DuckDB::TableFunction.new
45+
* tf.name = "my_function"
46+
* # ... configure tf ...
47+
*/
48+
static VALUE duckdb_table_function_initialize(VALUE self) {
49+
rubyDuckDBTableFunction *ctx;
50+
51+
TypedData_Get_Struct(self, rubyDuckDBTableFunction, &table_function_data_type, ctx);
52+
53+
ctx->table_function = duckdb_create_table_function();
54+
if (!ctx->table_function) {
55+
rb_raise(eDuckDBError, "Failed to create table function");
56+
}
57+
58+
return self;
59+
}
60+
61+
/*
62+
* call-seq:
63+
* table_function.name = name -> name
64+
*
65+
* Sets the name of the table function.
66+
*
67+
* tf.name = "my_function"
68+
*/
69+
static VALUE rbduckdb_table_function_set_name(VALUE self, VALUE name) {
70+
rubyDuckDBTableFunction *ctx;
71+
const char *func_name;
72+
73+
TypedData_Get_Struct(self, rubyDuckDBTableFunction, &table_function_data_type, ctx);
74+
75+
if (!ctx->table_function) {
76+
rb_raise(eDuckDBError, "Table function is destroyed");
77+
}
78+
79+
func_name = StringValueCStr(name);
80+
duckdb_table_function_set_name(ctx->table_function, func_name);
81+
82+
return name;
83+
}
84+
85+
/*
86+
* call-seq:
87+
* table_function.add_parameter(logical_type) -> self
88+
*
89+
* Adds a positional parameter to the table function.
90+
*
91+
* tf.add_parameter(DuckDB::LogicalType::BIGINT)
92+
* tf.add_parameter(DuckDB::LogicalType::VARCHAR)
93+
*/
94+
static VALUE rbduckdb_table_function_add_parameter(VALUE self, VALUE logical_type) {
95+
rubyDuckDBTableFunction *ctx;
96+
rubyDuckDBLogicalType *ctx_logical_type;
97+
98+
TypedData_Get_Struct(self, rubyDuckDBTableFunction, &table_function_data_type, ctx);
99+
100+
if (!ctx->table_function) {
101+
rb_raise(eDuckDBError, "Table function is destroyed");
102+
}
103+
104+
ctx_logical_type = get_struct_logical_type(logical_type);
105+
duckdb_table_function_add_parameter(ctx->table_function, ctx_logical_type->logical_type);
106+
107+
return self;
108+
}
109+
110+
/*
111+
* call-seq:
112+
* table_function.add_named_parameter(name, logical_type) -> self
113+
*
114+
* Adds a named parameter to the table function.
115+
*
116+
* tf.add_named_parameter("limit", DuckDB::LogicalType::BIGINT)
117+
*/
118+
static VALUE rbduckdb_table_function_add_named_parameter(VALUE self, VALUE name, VALUE logical_type) {
119+
rubyDuckDBTableFunction *ctx;
120+
rubyDuckDBLogicalType *ctx_logical_type;
121+
const char *param_name;
122+
123+
TypedData_Get_Struct(self, rubyDuckDBTableFunction, &table_function_data_type, ctx);
124+
125+
if (!ctx->table_function) {
126+
rb_raise(eDuckDBError, "Table function is destroyed");
127+
}
128+
129+
param_name = StringValueCStr(name);
130+
ctx_logical_type = get_struct_logical_type(logical_type);
131+
duckdb_table_function_add_named_parameter(ctx->table_function, param_name, ctx_logical_type->logical_type);
132+
133+
return self;
134+
}
135+
136+
rubyDuckDBTableFunction *get_struct_table_function(VALUE self) {
137+
rubyDuckDBTableFunction *ctx;
138+
TypedData_Get_Struct(self, rubyDuckDBTableFunction, &table_function_data_type, ctx);
139+
return ctx;
140+
}
141+
142+
void rbduckdb_init_duckdb_table_function(void) {
143+
#if 0
144+
VALUE mDuckDB = rb_define_module("DuckDB");
145+
#endif
146+
cDuckDBTableFunction = rb_define_class_under(mDuckDB, "TableFunction", rb_cObject);
147+
rb_define_alloc_func(cDuckDBTableFunction, allocate);
148+
149+
rb_define_method(cDuckDBTableFunction, "initialize", duckdb_table_function_initialize, 0);
150+
rb_define_method(cDuckDBTableFunction, "set_name", rbduckdb_table_function_set_name, 1);
151+
rb_define_method(cDuckDBTableFunction, "name=", rbduckdb_table_function_set_name, 1);
152+
rb_define_method(cDuckDBTableFunction, "add_parameter", rbduckdb_table_function_add_parameter, 1);
153+
rb_define_method(cDuckDBTableFunction, "add_named_parameter", rbduckdb_table_function_add_named_parameter, 2);
154+
}

‎ext/duckdb/table_function.h‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#ifndef RUBY_DUCKDB_TABLE_FUNCTION_H
2+
#define RUBY_DUCKDB_TABLE_FUNCTION_H
3+
4+
struct _rubyDuckDBTableFunction {
5+
duckdb_table_function table_function;
6+
};
7+
8+
typedef struct _rubyDuckDBTableFunction rubyDuckDBTableFunction;
9+
10+
rubyDuckDBTableFunction *get_struct_table_function(VALUE self);
11+
void rbduckdb_init_duckdb_table_function(void);
12+
13+
#endif

‎lib/duckdb.rb‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
require 'duckdb/column'
1616
require 'duckdb/logical_type'
1717
require 'duckdb/scalar_function'
18+
require 'duckdb/table_function'
1819
require 'duckdb/infinity'
1920
require 'duckdb/instance_cache'
2021

‎lib/duckdb/table_function.rb‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# frozen_string_literal: true
2+
3+
module DuckDB
4+
#
5+
# The DuckDB::TableFunction encapsulates a DuckDB table function.
6+
#
7+
# require 'duckdb'
8+
#
9+
# db = DuckDB::Database.new
10+
# conn = db.connect
11+
#
12+
# tf = DuckDB::TableFunction.new
13+
# tf.name = 'my_function'
14+
# tf.add_parameter(DuckDB::LogicalType::BIGINT)
15+
#
16+
# tf.bind do |bind_info|
17+
# bind_info.add_result_column('value', DuckDB::LogicalType::BIGINT)
18+
# end
19+
#
20+
# tf.execute do |func_info, output|
21+
# # Fill output data...
22+
# output.size = 0
23+
# end
24+
#
25+
# conn.register_table_function(tf)
26+
#
27+
# rubocop:disable Lint/EmptyClass
28+
class TableFunction
29+
# TableFunction#initialize is defined in C extension
30+
# Additional Ruby methods can be added here in future phases
31+
end
32+
# rubocop:enable Lint/EmptyClass
33+
end

‎test/duckdb_test/table_function_test.rb‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# frozen_string_literal: true
2+
3+
require 'test_helper'
4+
5+
module DuckDBTest
6+
class TableFunctionTest < Minitest::Test
7+
# Test 1: Create using new
8+
def test_new
9+
tf = DuckDB::TableFunction.new
10+
11+
assert_instance_of DuckDB::TableFunction, tf
12+
end
13+
14+
# Test 2: Set name
15+
def test_set_name
16+
tf = DuckDB::TableFunction.new
17+
tf.name = 'my_function'
18+
tf
19+
end
20+
21+
# Test 3: Add positional parameter
22+
def test_add_parameter
23+
tf = DuckDB::TableFunction.new
24+
tf.name = 'my_function'
25+
tf.add_parameter(DuckDB::LogicalType::BIGINT)
26+
end
27+
28+
# Test 4: Add named parameter
29+
def test_add_named_parameter
30+
tf = DuckDB::TableFunction.new
31+
tf.name = 'my_function'
32+
tf.add_named_parameter('limit', DuckDB::LogicalType::BIGINT)
33+
end
34+
35+
# Test 5: Register without callbacks (should fail gracefully)
36+
# TODO: Enable this test once database connection issue is resolved
37+
def _test_register_without_callbacks
38+
database, conn, table_function = setup_incomplete_function
39+
40+
# Should fail because no bind/init/execute callbacks set
41+
assert_raises(DuckDB::Error) do
42+
conn.register_table_function(table_function)
43+
end
44+
45+
cleanup_function(table_function, conn, database)
46+
end
47+
48+
private
49+
50+
def setup_incomplete_function
51+
database = DuckDB::Database.open
52+
conn = database.connect
53+
table_function = DuckDB::TableFunction.new
54+
table_function.name = 'incomplete_function'
55+
table_function.add_parameter(DuckDB::LogicalType::BIGINT)
56+
[database, conn, table_function]
57+
end
58+
59+
def cleanup_function(_table_function, conn, database)
60+
conn.disconnect
61+
database.close
62+
end
63+
end
64+
end

0 commit comments

Comments
 (0)