GArrowStructArrayBuilder

GArrowStructArrayBuilder — Struct array builder class

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowArrayBuilder
        ╰── GArrowStructArrayBuilder

Includes

#include <arrow-glib/arrow-glib.h>

Description

GArrowStructArrayBuilder is the class to create a new GArrowStructArray.

Functions

garrow_struct_array_builder_new ()

GArrowStructArrayBuilder *
garrow_struct_array_builder_new (GArrowStructDataType *data_type,
                                 GList *field_builders);

Parameters

data_type

GArrowStructDataType for the struct.

 

field_builders

GArrowArrayBuilders for fields.

[element-type GArrowArray]

Returns

A newly created GArrowStructArrayBuilder.


garrow_struct_array_builder_append ()

gboolean
garrow_struct_array_builder_append (GArrowStructArrayBuilder *builder,
                                    GError **error);

Parameters

builder

A GArrowStructArrayBuilder.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.

It appends a new struct element. To append a new struct element, you need to call this function then append struct element field values to all field_builders. field_values are the GArrowArrayBuilder specified to constructor. You can get field_builder by garrow_struct_array_builder_get_field_builder() or garrow_struct_array_builder_get_field_builders().

1
// TODO


garrow_struct_array_builder_append_null ()

gboolean
garrow_struct_array_builder_append_null
                               (GArrowStructArrayBuilder *builder,
                                GError **error);

Parameters

builder

A GArrowStructArrayBuilder.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.

It appends a new NULL element.


garrow_struct_array_builder_get_field_builder ()

GArrowArrayBuilder *
garrow_struct_array_builder_get_field_builder
                               (GArrowStructArrayBuilder *builder,
                                gint i);

Parameters

builder

A GArrowStructArrayBuilder.

 

i

The index of the field in the struct.

 

Returns

The GArrowArrayBuilder for the i-th field.

[transfer full]


garrow_struct_array_builder_get_field_builders ()

GList *
garrow_struct_array_builder_get_field_builders
                               (GArrowStructArrayBuilder *builder);

Parameters

builder

A GArrowStructArrayBuilder.

 

Returns

The GArrowArrayBuilder for all fields.

[element-type GArrowArray][transfer full]

Types and Values

struct GArrowStructArrayBuilder

struct GArrowStructArrayBuilder;

It wraps arrow::StructBuilder.