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 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
|
#include "capi_tester.hpp"
#include "duckdb/common/arrow/arrow_appender.hpp"
#include "duckdb/common/arrow/arrow_converter.hpp"
using namespace duckdb;
using namespace std;
TEST_CASE("Test arrow in C API", "[capi][arrow]") {
CAPITester tester;
duckdb::unique_ptr<CAPIResult> result;
duckdb_prepared_statement stmt = nullptr;
duckdb_arrow arrow_result = nullptr;
// open the database in in-memory mode
REQUIRE(tester.OpenDatabase(nullptr));
SECTION("test rows changed") {
REQUIRE_NO_FAIL(tester.Query("CREATE TABLE test(a INTEGER);"));
auto state = duckdb_query_arrow(tester.connection, "INSERT INTO test VALUES (1), (2);", &arrow_result);
REQUIRE(state == DuckDBSuccess);
REQUIRE(duckdb_arrow_rows_changed(arrow_result) == 2);
duckdb_destroy_arrow(&arrow_result);
REQUIRE_NO_FAIL(tester.Query("DROP TABLE test;"));
}
SECTION("test query arrow") {
auto state = duckdb_query_arrow(tester.connection, "SELECT 42 AS VALUE, [1,2,3,4,5] AS LST;", &arrow_result);
REQUIRE(state == DuckDBSuccess);
REQUIRE(duckdb_arrow_row_count(arrow_result) == 1);
REQUIRE(duckdb_arrow_column_count(arrow_result) == 2);
REQUIRE(duckdb_arrow_rows_changed(arrow_result) == 0);
// query the arrow schema
ArrowSchema arrow_schema;
arrow_schema.Init();
auto arrow_schema_ptr = &arrow_schema;
state = duckdb_query_arrow_schema(arrow_result, reinterpret_cast<duckdb_arrow_schema *>(&arrow_schema_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(string(arrow_schema.name) == "duckdb_query_result");
if (arrow_schema.release) {
arrow_schema.release(arrow_schema_ptr);
}
// query array data
ArrowArray arrow_array;
arrow_array.Init();
auto arrow_array_ptr = &arrow_array;
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&arrow_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(arrow_array.length == 1);
REQUIRE(arrow_array.release != nullptr);
arrow_array.release(arrow_array_ptr);
duckdb_arrow_array null_array = nullptr;
state = duckdb_query_arrow_array(arrow_result, &null_array);
REQUIRE(state == DuckDBSuccess);
REQUIRE(null_array == nullptr);
// destroy the arrow result
duckdb_destroy_arrow(&arrow_result);
}
SECTION("test multiple chunks") {
// create a table that consists of multiple chunks
REQUIRE_NO_FAIL(tester.Query("CREATE TABLE test(a INTEGER);"));
REQUIRE_NO_FAIL(
tester.Query("INSERT INTO test SELECT i FROM (VALUES (1), (2), (3), (4), (5)) t(i), range(500);"));
auto state = duckdb_query_arrow(tester.connection, "SELECT CAST(a AS INTEGER) AS a FROM test ORDER BY a;",
&arrow_result);
REQUIRE(state == DuckDBSuccess);
// query the arrow schema
ArrowSchema arrow_schema;
arrow_schema.Init();
auto arrow_schema_ptr = &arrow_schema;
state = duckdb_query_arrow_schema(arrow_result, reinterpret_cast<duckdb_arrow_schema *>(&arrow_schema_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(arrow_schema.release != nullptr);
arrow_schema.release(arrow_schema_ptr);
int total_count = 0;
while (true) {
// query array data
ArrowArray arrow_array;
arrow_array.Init();
auto arrow_array_ptr = &arrow_array;
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&arrow_array_ptr));
REQUIRE(state == DuckDBSuccess);
if (arrow_array.length == 0) {
// nothing to release
REQUIRE(total_count == 2500);
break;
}
REQUIRE(arrow_array.length > 0);
total_count += arrow_array.length;
REQUIRE(arrow_array.release != nullptr);
arrow_array.release(arrow_array_ptr);
}
// destroy the arrow result
duckdb_destroy_arrow(&arrow_result);
REQUIRE_NO_FAIL(tester.Query("DROP TABLE test;"));
}
SECTION("test prepare query arrow") {
auto state = duckdb_prepare(tester.connection, "SELECT CAST($1 AS BIGINT)", &stmt);
REQUIRE(state == DuckDBSuccess);
REQUIRE(stmt != nullptr);
REQUIRE(duckdb_bind_int64(stmt, 1, 42) == DuckDBSuccess);
// prepare and execute the arrow schema
ArrowSchema prepared_schema;
prepared_schema.Init();
auto prepared_schema_ptr = &prepared_schema;
state = duckdb_prepared_arrow_schema(stmt, reinterpret_cast<duckdb_arrow_schema *>(&prepared_schema_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(string(prepared_schema.format) == "+s");
REQUIRE(duckdb_execute_prepared_arrow(stmt, nullptr) == DuckDBError);
REQUIRE(duckdb_execute_prepared_arrow(stmt, &arrow_result) == DuckDBSuccess);
REQUIRE(prepared_schema.release != nullptr);
prepared_schema.release(prepared_schema_ptr);
// query the arrow schema
ArrowSchema arrow_schema;
arrow_schema.Init();
auto arrow_schema_ptr = &arrow_schema;
state = duckdb_query_arrow_schema(arrow_result, reinterpret_cast<duckdb_arrow_schema *>(&arrow_schema_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(string(arrow_schema.format) == "+s");
REQUIRE(arrow_schema.release != nullptr);
arrow_schema.release(arrow_schema_ptr);
ArrowArray arrow_array;
arrow_array.Init();
auto arrow_array_ptr = &arrow_array;
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&arrow_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(arrow_array.length == 1);
REQUIRE(arrow_array.release);
arrow_array.release(arrow_array_ptr);
duckdb_destroy_arrow(&arrow_result);
duckdb_destroy_prepare(&stmt);
}
SECTION("test scan") {
const auto logical_types = duckdb::vector<LogicalType> {LogicalType(LogicalTypeId::INTEGER)};
const auto column_names = duckdb::vector<string> {"value"};
// arrow schema, release after use
ArrowSchema arrow_schema;
arrow_schema.Init();
auto arrow_schema_ptr = &arrow_schema;
ClientProperties options = (reinterpret_cast<Connection *>(tester.connection)->context->GetClientProperties());
duckdb::ArrowConverter::ToArrowSchema(arrow_schema_ptr, logical_types, column_names, options);
ArrowArray arrow_array;
arrow_array.Init();
auto arrow_array_ptr = &arrow_array;
SECTION("empty array") {
// Create an empty view with a `value` column.
string view_name = "foo_empty_table";
// arrow array scan, destroy out_stream after use
ArrowArrayStream *arrow_array_stream;
auto out_stream = reinterpret_cast<duckdb_arrow_stream *>(&arrow_array_stream);
auto state = duckdb_arrow_array_scan(tester.connection, view_name.c_str(),
reinterpret_cast<duckdb_arrow_schema>(arrow_schema_ptr),
reinterpret_cast<duckdb_arrow_array>(arrow_array_ptr), out_stream);
REQUIRE(state == DuckDBSuccess);
// get the created view from the DB
auto get_query = "SELECT * FROM " + view_name + ";";
state = duckdb_prepare(tester.connection, get_query.c_str(), &stmt);
REQUIRE(state == DuckDBSuccess);
REQUIRE(stmt != nullptr);
state = duckdb_execute_prepared_arrow(stmt, &arrow_result);
REQUIRE(state == DuckDBSuccess);
// recover the arrow array from the arrow result
ArrowArray out_array;
out_array.Init();
auto out_array_ptr = &out_array;
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&out_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(out_array.length == 0);
REQUIRE(out_array.release == nullptr);
duckdb_destroy_arrow_stream(out_stream);
REQUIRE(arrow_array.release == nullptr);
}
SECTION("big array") {
// Create a view with a `value` column containing 4096 values.
int num_buffers = 2, size = STANDARD_VECTOR_SIZE * num_buffers;
unordered_map<idx_t, const duckdb::shared_ptr<ArrowTypeExtensionData>> extension_type_cast;
ArrowAppender appender(logical_types, size, options, extension_type_cast);
Allocator allocator;
auto data_chunks = std::vector<DataChunk>(num_buffers);
for (int i = 0; i < num_buffers; i++) {
auto data_chunk = &data_chunks[i];
data_chunk->Initialize(allocator, logical_types, STANDARD_VECTOR_SIZE);
data_chunk->SetCardinality(STANDARD_VECTOR_SIZE);
for (idx_t row = 0; row < STANDARD_VECTOR_SIZE; row++) {
data_chunk->SetValue(0, row, duckdb::Value(i));
}
appender.Append(*data_chunk, 0, data_chunk->size(), data_chunk->size());
}
*arrow_array_ptr = appender.Finalize();
// Create the view.
string view_name = "foo_table";
// arrow array scan, destroy out_stream after use
ArrowArrayStream *arrow_array_stream;
auto out_stream = reinterpret_cast<duckdb_arrow_stream *>(&arrow_array_stream);
auto state = duckdb_arrow_array_scan(tester.connection, view_name.c_str(),
reinterpret_cast<duckdb_arrow_schema>(arrow_schema_ptr),
reinterpret_cast<duckdb_arrow_array>(arrow_array_ptr), out_stream);
REQUIRE(state == DuckDBSuccess);
// Get the created view from the DB.
auto get_query = "SELECT * FROM " + view_name + ";";
state = duckdb_prepare(tester.connection, get_query.c_str(), &stmt);
REQUIRE(state == DuckDBSuccess);
REQUIRE(stmt != nullptr);
state = duckdb_execute_prepared_arrow(stmt, &arrow_result);
REQUIRE(state == DuckDBSuccess);
// Recover the arrow array from the arrow result.
ArrowArray out_array;
out_array.Init();
auto out_array_ptr = &out_array;
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&out_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(out_array.length == STANDARD_VECTOR_SIZE);
REQUIRE(out_array.release != nullptr);
out_array.release(out_array_ptr);
out_array.Init();
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&out_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(out_array.length == STANDARD_VECTOR_SIZE);
REQUIRE(out_array.release != nullptr);
out_array.release(out_array_ptr);
out_array.Init();
state = duckdb_query_arrow_array(arrow_result, reinterpret_cast<duckdb_arrow_array *>(&out_array_ptr));
REQUIRE(state == DuckDBSuccess);
REQUIRE(out_array.length == 0);
REQUIRE(out_array.release == nullptr);
duckdb_destroy_arrow_stream(out_stream);
REQUIRE(arrow_array.release != nullptr);
}
SECTION("null schema") {
// Creating a view with a null schema should fail gracefully.
string view_name = "foo_empty_table_null_schema";
// arrow array scan, destroy out_stream after use
ArrowArrayStream *arrow_array_stream;
auto out_stream = reinterpret_cast<duckdb_arrow_stream *>(&arrow_array_stream);
auto state = duckdb_arrow_array_scan(tester.connection, view_name.c_str(), nullptr,
reinterpret_cast<duckdb_arrow_array>(arrow_array_ptr), out_stream);
REQUIRE(state == DuckDBError);
duckdb_destroy_arrow_stream(out_stream);
}
if (arrow_schema.release) {
arrow_schema.release(arrow_schema_ptr);
}
if (arrow_array.release) {
arrow_array.release(arrow_array_ptr);
}
duckdb_destroy_arrow(&arrow_result);
duckdb_destroy_prepare(&stmt);
}
// FIXME: needs test for scanning a fixed size list
// this likely requires nanoarrow to create the array to scan
}
TEST_CASE("Test C-API Arrow conversion functions", "[capi][arrow]") {
CAPITester tester;
REQUIRE(tester.OpenDatabase(nullptr));
SECTION("roundtrip: duckdb table -> arrow -> duckdb chunk, validate correctness") {
// 1. Create and populate table
REQUIRE_NO_FAIL(tester.Query("CREATE TABLE big_table(i INTEGER);"));
REQUIRE_NO_FAIL(tester.Query("INSERT INTO big_table SELECT i FROM range(10000) tbl(i);"));
// 2. Query the table and fetch all results as data chunks
duckdb_result result;
REQUIRE(duckdb_query(tester.connection, "SELECT i FROM big_table ORDER BY i", &result) == DuckDBSuccess);
idx_t chunk_count = duckdb_result_chunk_count(result);
idx_t total_rows = 0;
std::vector<ArrowArray> arrow_arrays;
std::vector<duckdb_data_chunk> duckdb_chunks;
std::vector<int32_t> all_duckdb_values;
std::vector<int32_t> all_arrow_values;
// 3. For each chunk, convert to Arrow Array and collect values
for (idx_t chunk_idx = 0; chunk_idx < chunk_count; chunk_idx++) {
duckdb_data_chunk chunk = duckdb_result_get_chunk(result, chunk_idx);
duckdb_chunks.push_back(chunk); // for later roundtrip
idx_t chunk_size = duckdb_data_chunk_get_size(chunk);
total_rows += chunk_size;
auto vec = duckdb_data_chunk_get_vector(chunk, 0);
auto data = static_cast<int32_t *>(duckdb_vector_get_data(vec));
for (idx_t i = 0; i < chunk_size; i++) {
all_duckdb_values.push_back(data[i]);
}
ArrowArray duckdb_arrow_array;
duckdb_arrow_options arrow_options;
duckdb_connection_get_arrow_options(tester.connection, &arrow_options);
duckdb_error_data err = duckdb_data_chunk_to_arrow(arrow_options, chunk, &duckdb_arrow_array);
duckdb_destroy_arrow_options(&arrow_options);
REQUIRE(err == nullptr);
arrow_arrays.push_back(duckdb_arrow_array);
}
REQUIRE(total_rows == 10000);
REQUIRE(all_duckdb_values.size() == 10000);
// 4. Prepare Arrow schema for roundtrip
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_INTEGER);
duckdb_logical_type types[1] = {type};
const char *names[1] = {strdup("i")};
ArrowSchemaWrapper arrow_schema_wrapper;
duckdb_arrow_options arrow_options;
duckdb_connection_get_arrow_options(tester.connection, &arrow_options);
duckdb_error_data err =
duckdb_to_arrow_schema(arrow_options, types, names, 1, &arrow_schema_wrapper.arrow_schema);
duckdb_destroy_arrow_options(&arrow_options);
REQUIRE(err == nullptr);
duckdb_arrow_converted_schema converted_schema = nullptr;
// Convert schema (simulate real use)
err = duckdb_schema_from_arrow(tester.connection, &arrow_schema_wrapper.arrow_schema, &converted_schema);
REQUIRE(err == nullptr);
// 5. For each Arrow array, convert back to DuckDB chunk and validate
for (size_t idx = 0, offset = 0; idx < arrow_arrays.size(); idx++) {
ArrowArray *duckdb_arrow_array = &arrow_arrays[idx];
// Prepare output chunk
duckdb_data_chunk out_chunk;
// Convert Arrow array to DuckDB chunk
err = duckdb_data_chunk_from_arrow(tester.connection, duckdb_arrow_array, converted_schema, &out_chunk);
REQUIRE(err == nullptr);
idx_t chunk_size = duckdb_data_chunk_get_size(out_chunk);
auto vec = duckdb_data_chunk_get_vector(out_chunk, 0);
auto data = static_cast<int32_t *>(duckdb_vector_get_data(vec));
for (idx_t i = 0; i < chunk_size; i++, offset++) {
REQUIRE(data[i] == all_duckdb_values[offset]);
all_arrow_values.push_back(data[i]);
}
duckdb_destroy_data_chunk(&out_chunk);
}
REQUIRE(all_arrow_values.size() == 10000);
REQUIRE(all_arrow_values == all_duckdb_values);
// 6. Cleanup
free((void *)names[0]);
duckdb_destroy_arrow_converted_schema(&converted_schema);
for (auto arrow_array : arrow_arrays) {
if (arrow_array.release) {
arrow_array.release(&arrow_array);
}
}
for (auto chunk : duckdb_chunks) {
duckdb_destroy_data_chunk(&chunk);
}
duckdb_destroy_logical_type(&type);
duckdb_destroy_result(&result);
}
SECTION("C-API Arrow Tess Null pointer inputs") {
duckdb_error_data err;
duckdb_logical_type type = duckdb_create_logical_type(DUCKDB_TYPE_INTEGER);
const char *names[1] = {strdup("i")};
// Test duckdb_to_arrow_schema
ArrowSchema duckdb_arrow_schema;
err = duckdb_to_arrow_schema(nullptr, &type, names, 1, &duckdb_arrow_schema);
duckdb_arrow_options arrow_options;
duckdb_connection_get_arrow_options(tester.connection, &arrow_options);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_to_arrow_schema(arrow_options, nullptr, names, 1, &duckdb_arrow_schema);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_to_arrow_schema(arrow_options, &type, nullptr, 1, &duckdb_arrow_schema);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
// Zero columns
err = duckdb_to_arrow_schema(arrow_options, &type, names, 0, &duckdb_arrow_schema);
REQUIRE(err == nullptr); // zero columns is allowed, but produces an empty schema
if (duckdb_arrow_schema.release) {
duckdb_arrow_schema.release(&duckdb_arrow_schema);
}
duckdb_destroy_logical_type(&type);
// Test duckdb_data_chunk_to_arrow
ArrowArray duckdb_arrow_array;
duckdb_destroy_error_data(&err);
err = duckdb_data_chunk_to_arrow(arrow_options, nullptr, &duckdb_arrow_array);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_data_chunk_to_arrow(nullptr, nullptr, &duckdb_arrow_array);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
// Test duckdb_schema_from_arrow
ArrowSchema schema;
duckdb_arrow_converted_schema converted_schema = nullptr;
err = duckdb_schema_from_arrow(nullptr, &schema, &converted_schema);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_schema_from_arrow(tester.connection, &schema, nullptr);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
// Test duckdb_data_chunk_from_arrow
ArrowArray arr;
duckdb_data_chunk out_chunk = nullptr;
err = duckdb_data_chunk_from_arrow(nullptr, &arr, converted_schema, &out_chunk);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_data_chunk_from_arrow(tester.connection, &arr, nullptr, &out_chunk);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
err = duckdb_data_chunk_from_arrow(tester.connection, &arr, converted_schema, nullptr);
REQUIRE(err != nullptr);
duckdb_destroy_error_data(&err);
duckdb_destroy_arrow_options(&arrow_options);
free((void *)names[0]);
}
}
|