GArrowListArrayBuilder

GArrowListArrayBuilder — List array builder class

Functions

Types and Values

Object Hierarchy

    GObject
    ╰── GArrowArrayBuilder
        ╰── GArrowListArrayBuilder

Includes

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

Description

GArrowListArrayBuilder is the class to create a new GArrowListArray.

Functions

garrow_list_array_builder_new ()

GArrowListArrayBuilder *
garrow_list_array_builder_new (GArrowArrayBuilder *value_builder);

Parameters

value_builder

A GArrowArrayBuilder for value array.

 

Returns

A newly created GArrowListArrayBuilder.


garrow_list_array_builder_append ()

gboolean
garrow_list_array_builder_append (GArrowListArrayBuilder *builder,
                                  GError **error);

Parameters

builder

A GArrowListArrayBuilder.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE if there was an error.

It appends a new list element. To append a new list element, you need to call this function then append list element values to value_builder. value_builder is the GArrowArrayBuilder specified to constructor. You can get value_builder by garrow_list_array_builder_get_value_builder().

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
GArrowInt8ArrayBuilder *value_builder;
GArrowListArrayBuilder *builder;
value_builder = garrow_int8_array_builder_new();
builder = garrow_list_array_builder_new(value_builder, NULL);
// Start 0th list element: [1, 0, -1]
garrow_list_array_builder_append(builder, NULL);
garrow_int8_array_builder_append(value_builder, 1);
garrow_int8_array_builder_append(value_builder, 0);
garrow_int8_array_builder_append(value_builder, -1);
// Start 1st list element: [-29, 29]
garrow_list_array_builder_append(builder, NULL);
garrow_int8_array_builder_append(value_builder, -29);
garrow_int8_array_builder_append(value_builder, 29);
{
// [[1, 0, -1], [-29, 29]]
GArrowArray *array = garrow_array_builder_finish(builder);
// Now, builder is needless.
g_object_unref(builder);
g_object_unref(value_builder);
// Use array...
g_object_unref(array);
}


garrow_list_array_builder_append_null ()

gboolean
garrow_list_array_builder_append_null (GArrowListArrayBuilder *builder,
                                       GError **error);

Parameters

builder

A GArrowListArrayBuilder.

 

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_list_array_builder_get_value_builder ()

GArrowArrayBuilder *
garrow_list_array_builder_get_value_builder
                               (GArrowListArrayBuilder *builder);

Parameters

builder

A GArrowListArrayBuilder.

 

Returns

The GArrowArrayBuilder for values.

[transfer full]

Types and Values

struct GArrowListArrayBuilder

struct GArrowListArrayBuilder;

It wraps arrow::ListBuilder.