duckdb::ArrowConverter Struct Reference

Static Public Member Functions
static DUCKDB_API void	ToArrowSchema (ArrowSchema *out_schema, const vector< LogicalType > &types, const vector< string > &names, ClientProperties &options)
static DUCKDB_API void	ToArrowArray (DataChunk &input, ArrowArray *out_array, ClientProperties options, const unordered_map< idx_t, const shared_ptr< ArrowTypeExtensionData > > &extension_type_cast)

Member Function Documentation

ToArrowSchema()

void duckdb::ArrowConverter::ToArrowSchema ( ArrowSchema *  out_schema, const vector< LogicalType > &  types, const vector< string > &  names, ClientProperties &  options  )

static

                                                                                           {
    D_ASSERT(out_schema);
    D_ASSERT(types.size() == names.size());
    const idx_t column_count = types.size();
    // Allocate as unique_ptr first to clean-up properly on error
    auto root_holder = make_uniq<DuckDBArrowSchemaHolder>();
 
    // Allocate the children
    root_holder->children.resize(column_count);
    root_holder->children_ptrs.resize(column_count, nullptr);
    for (size_t i = 0; i < column_count; ++i) {
        root_holder->children_ptrs[i] = &root_holder->children[i];
    }
    out_schema->children = root_holder->children_ptrs.data();
    out_schema->n_children = NumericCast<int64_t>(column_count);
 
    // Store the schema
    out_schema->format = "+s"; // struct apparently
    out_schema->flags = 0;
    out_schema->metadata = nullptr;
    out_schema->name = "duckdb_query_result";
    out_schema->dictionary = nullptr;
 
    // Configure all child schemas
    for (idx_t col_idx = 0; col_idx < column_count; col_idx++) {
        root_holder->owned_column_names.push_back(AddName(names[col_idx]));
        auto &child = root_holder->children[col_idx];
        InitializeChild(child, *root_holder, names[col_idx]);
        SetArrowFormat(*root_holder, child, types[col_idx], options, *options.client_context);
    }
 
    // Release ownership to caller
    out_schema->private_data = root_holder.release();
    out_schema->release = ReleaseDuckDBArrowSchema;
}

ToArrowArray()

void duckdb::ArrowConverter::ToArrowArray ( DataChunk &  input, ArrowArray *  out_array, ClientProperties  options, const unordered_map< idx_t, const shared_ptr< ArrowTypeExtensionData > > &  extension_type_cast  )

static

                                                                                               {
    ArrowAppender appender(input.GetTypes(), input.size(), std::move(options), extension_type_cast);
    appender.Append(input, 0, input.size(), input.size());
    *out_array = appender.Finalize();
}

---

The documentation for this struct was generated from the following files:

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp