1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
#include "capi_tester.hpp"
#include "duckdb/common/numeric_utils.hpp"
using namespace duckdb;
using namespace std;
struct my_bind_data_struct {
int64_t size;
};
void my_bind(duckdb_bind_info info) {
REQUIRE(duckdb_bind_get_parameter_count(info) == 1);
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_bind_add_result_column(info, "forty_two", type);
duckdb_destroy_logical_type(&type);
auto my_bind_data = (my_bind_data_struct *)malloc(sizeof(my_bind_data_struct));
auto param = duckdb_bind_get_parameter(info, 0);
my_bind_data->size = duckdb_get_int64(param);
duckdb_destroy_value(¶m);
duckdb_bind_set_bind_data(info, my_bind_data, free);
}
struct my_init_data_struct {
int64_t pos;
};
void my_init(duckdb_init_info info) {
REQUIRE(duckdb_init_get_bind_data(info) != nullptr);
REQUIRE(duckdb_init_get_bind_data(nullptr) == nullptr);
auto my_init_data = (my_init_data_struct *)malloc(sizeof(my_init_data_struct));
my_init_data->pos = 0;
duckdb_init_set_init_data(info, my_init_data, free);
}
void my_function(duckdb_function_info info, duckdb_data_chunk output) {
auto bind_data = (my_bind_data_struct *)duckdb_function_get_bind_data(info);
auto init_data = (my_init_data_struct *)duckdb_function_get_init_data(info);
auto ptr = (int64_t *)duckdb_vector_get_data(duckdb_data_chunk_get_vector(output, 0));
idx_t i;
for (i = 0; i < STANDARD_VECTOR_SIZE; i++) {
if (init_data->pos >= bind_data->size) {
break;
}
ptr[i] = init_data->pos % 2 == 0 ? 42 : 84;
init_data->pos++;
}
duckdb_data_chunk_set_size(output, i);
}
static void capi_register_table_function(duckdb_connection connection, const char *name,
duckdb_table_function_bind_t bind, duckdb_table_function_init_t init,
duckdb_table_function_t f, duckdb_state expected_state = DuckDBSuccess) {
duckdb_state status;
// create a table function
auto function = duckdb_create_table_function();
duckdb_table_function_set_name(nullptr, name);
duckdb_table_function_set_name(function, nullptr);
duckdb_table_function_set_name(function, name);
duckdb_table_function_set_name(function, name);
// add a string parameter
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_table_function_add_parameter(function, type);
duckdb_destroy_logical_type(&type);
// add a named parameter
duckdb_logical_type itype = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_table_function_add_named_parameter(function, "my_parameter", itype);
duckdb_destroy_logical_type(&itype);
// set up the function pointers
duckdb_table_function_set_bind(function, bind);
duckdb_table_function_set_init(function, init);
duckdb_table_function_set_function(function, f);
// register and cleanup
status = duckdb_register_table_function(connection, function);
duckdb_destroy_table_function(&function);
duckdb_destroy_table_function(&function);
duckdb_destroy_table_function(nullptr);
REQUIRE(status == expected_state);
}
TEST_CASE("Test Table Functions C API", "[capi]") {
CAPITester tester;
duckdb::unique_ptr<CAPIResult> result;
REQUIRE(tester.OpenDatabase(nullptr));
capi_register_table_function(tester.connection, "my_function", my_bind, my_init, my_function);
// registering again does not cause error, because we overload
capi_register_table_function(tester.connection, "my_function", my_bind, my_init, my_function);
// now call it
result = tester.Query("SELECT * FROM my_function(1)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 42);
result = tester.Query("SELECT * FROM my_function(1, my_parameter=3)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 42);
result = tester.Query("SELECT * FROM my_function(1, my_parameter=\"val\")");
REQUIRE(result->HasError());
result = tester.Query("SELECT * FROM my_function(1, nota_parameter=\"val\")");
REQUIRE(result->HasError());
result = tester.Query("SELECT * FROM my_function(3)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 42);
REQUIRE(result->Fetch<int64_t>(0, 1) == 84);
REQUIRE(result->Fetch<int64_t>(0, 2) == 42);
result = tester.Query("SELECT forty_two, COUNT(*) FROM my_function(10000) GROUP BY 1 ORDER BY 1");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 42);
REQUIRE(result->Fetch<int64_t>(0, 1) == 84);
REQUIRE(result->Fetch<int64_t>(1, 0) == 5000);
REQUIRE(result->Fetch<int64_t>(1, 1) == 5000);
}
void my_error_bind(duckdb_bind_info info) {
duckdb_bind_set_error(nullptr, nullptr);
duckdb_bind_set_error(info, "My error message");
}
void my_error_init(duckdb_init_info info) {
duckdb_init_set_error(nullptr, nullptr);
duckdb_init_set_error(info, "My error message");
}
void my_error_function(duckdb_function_info info, duckdb_data_chunk output) {
duckdb_function_set_error(nullptr, nullptr);
duckdb_function_set_error(info, "My error message");
}
TEST_CASE("Test Table Function errors in C API", "[capi]") {
CAPITester tester;
duckdb::unique_ptr<CAPIResult> result;
REQUIRE(tester.OpenDatabase(nullptr));
capi_register_table_function(tester.connection, "my_error_bind", my_error_bind, my_init, my_function);
capi_register_table_function(tester.connection, "my_error_init", my_bind, my_error_init, my_function);
capi_register_table_function(tester.connection, "my_error_function", my_bind, my_init, my_error_function);
result = tester.Query("SELECT * FROM my_error_bind(1)");
REQUIRE(result->HasError());
result = tester.Query("SELECT * FROM my_error_init(1)");
REQUIRE(result->HasError());
result = tester.Query("SELECT * FROM my_error_function(1)");
REQUIRE(result->HasError());
}
TEST_CASE("Test Table Function register errors in C API", "[capi]") {
CAPITester tester;
REQUIRE(tester.OpenDatabase(nullptr));
capi_register_table_function(tester.connection, "x", my_error_bind, my_init, my_function, DuckDBSuccess);
// Try to register it again with the same name, is ok (because of overloading)
capi_register_table_function(tester.connection, "x", my_error_bind, my_init, my_function, DuckDBSuccess);
}
struct my_named_bind_data_struct {
int64_t size;
int64_t multiplier;
};
void my_named_bind(duckdb_bind_info info) {
REQUIRE(duckdb_bind_get_parameter_count(info) == 1);
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_bind_add_result_column(info, "forty_two", type);
duckdb_destroy_logical_type(&type);
auto my_bind_data = (my_named_bind_data_struct *)malloc(sizeof(my_named_bind_data_struct));
auto param = duckdb_bind_get_parameter(info, 0);
my_bind_data->size = duckdb_get_int64(param);
duckdb_destroy_value(¶m);
auto nparam = duckdb_bind_get_named_parameter(info, "my_parameter");
if (nparam) {
my_bind_data->multiplier = duckdb_get_int64(nparam);
} else {
my_bind_data->multiplier = 1;
}
duckdb_destroy_value(&nparam);
duckdb_bind_set_bind_data(info, my_bind_data, free);
}
void my_named_init(duckdb_init_info info) {
REQUIRE(duckdb_init_get_bind_data(info) != nullptr);
REQUIRE(duckdb_init_get_bind_data(nullptr) == nullptr);
auto my_init_data = (my_init_data_struct *)malloc(sizeof(my_init_data_struct));
my_init_data->pos = 0;
duckdb_init_set_init_data(info, my_init_data, free);
}
void my_named_function(duckdb_function_info info, duckdb_data_chunk output) {
auto bind_data = (my_named_bind_data_struct *)duckdb_function_get_bind_data(info);
auto init_data = (my_init_data_struct *)duckdb_function_get_init_data(info);
auto ptr = (int64_t *)duckdb_vector_get_data(duckdb_data_chunk_get_vector(output, 0));
idx_t i;
for (i = 0; i < STANDARD_VECTOR_SIZE; i++) {
if (init_data->pos >= bind_data->size) {
break;
}
ptr[i] = init_data->pos % 2 == 0 ? (42 * bind_data->multiplier) : (84 * bind_data->multiplier);
init_data->pos++;
}
duckdb_data_chunk_set_size(output, i);
}
TEST_CASE("Test Table Function named parameters in C API", "[capi]") {
CAPITester tester;
duckdb::unique_ptr<CAPIResult> result;
REQUIRE(tester.OpenDatabase(nullptr));
capi_register_table_function(tester.connection, "my_multiplier_function", my_named_bind, my_named_init,
my_named_function);
result = tester.Query("SELECT * FROM my_multiplier_function(3)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 42);
REQUIRE(result->Fetch<int64_t>(0, 1) == 84);
REQUIRE(result->Fetch<int64_t>(0, 2) == 42);
result = tester.Query("SELECT * FROM my_multiplier_function(2, my_parameter=2)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 84);
REQUIRE(result->Fetch<int64_t>(0, 1) == 168);
result = tester.Query("SELECT * FROM my_multiplier_function(2, my_parameter=3)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == 126);
REQUIRE(result->Fetch<int64_t>(0, 1) == 252);
}
struct my_bind_connection_id_data {
idx_t connection_id;
idx_t rows_requested;
};
void my_bind_connection_id(duckdb_bind_info info) {
REQUIRE(duckdb_bind_get_parameter_count(info) == 1);
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_bind_add_result_column(info, "connection_id", type);
duckdb_destroy_logical_type(&type);
type = duckdb_create_logical_type(DUCKDB_TYPE_BIGINT);
duckdb_bind_add_result_column(info, "forty_two", type);
duckdb_destroy_logical_type(&type);
auto bind_data = (my_bind_connection_id_data *)malloc(sizeof(my_bind_connection_id_data));
auto param = duckdb_bind_get_parameter(info, 0);
auto rows_requested = duckdb_get_int64(param);
duckdb_destroy_value(¶m);
duckdb_client_context context;
duckdb_table_function_get_client_context(info, &context);
auto connection_id = duckdb_client_context_get_connection_id(context);
duckdb_destroy_client_context(&context);
bind_data->rows_requested = rows_requested;
bind_data->connection_id = connection_id;
duckdb_bind_set_bind_data(info, bind_data, free);
}
void my_init_connection_id(duckdb_init_info info) {
REQUIRE(duckdb_init_get_bind_data(info) != nullptr);
REQUIRE(duckdb_init_get_bind_data(nullptr) == nullptr);
auto init_data = (my_init_data_struct *)malloc(sizeof(my_init_data_struct));
init_data->pos = 0;
duckdb_init_set_init_data(info, init_data, free);
}
void my_function_connection_id(duckdb_function_info info, duckdb_data_chunk output) {
auto bind_data = (my_bind_connection_id_data *)duckdb_function_get_bind_data(info);
auto init_data = (my_init_data_struct *)duckdb_function_get_init_data(info);
auto ptr = (int64_t *)duckdb_vector_get_data(duckdb_data_chunk_get_vector(output, 0));
auto ptr2 = (int64_t *)duckdb_vector_get_data(duckdb_data_chunk_get_vector(output, 1));
idx_t i;
for (i = 0; i < STANDARD_VECTOR_SIZE; i++) {
if (NumericCast<idx_t>(init_data->pos) >= bind_data->rows_requested) {
break;
}
ptr[i] = bind_data->connection_id;
ptr2[i] = 42;
init_data->pos++;
}
duckdb_data_chunk_set_size(output, i);
}
TEST_CASE("Table function client context return") {
CAPITester tester;
duckdb::unique_ptr<CAPIResult> result;
REQUIRE(tester.OpenDatabase(nullptr));
capi_register_table_function(tester.connection, "my_connection_id_function", my_bind_connection_id,
my_init_connection_id, my_function_connection_id);
duckdb_client_context context;
duckdb_connection_get_client_context(tester.connection, &context);
auto first_conn_id = duckdb_client_context_get_connection_id(context);
duckdb_destroy_client_context(&context);
result = tester.Query("SELECT * FROM my_connection_id_function(3)");
REQUIRE_NO_FAIL(*result);
REQUIRE(result->Fetch<int64_t>(0, 0) == NumericCast<int64_t>(first_conn_id));
REQUIRE(result->Fetch<int64_t>(0, 1) == NumericCast<int64_t>(first_conn_id));
REQUIRE(result->Fetch<int64_t>(0, 2) == NumericCast<int64_t>(first_conn_id));
REQUIRE(result->Fetch<int64_t>(1, 0) == 42);
REQUIRE(result->Fetch<int64_t>(1, 1) == 42);
REQUIRE(result->Fetch<int64_t>(1, 2) == 42);
}
|
