Table builder classes: Apache Arrow GLib Reference Manual

Table builder classes

Functions

GArrowRecordBatchBuilder *	garrow_record_batch_builder_new ()
gint64	garrow_record_batch_builder_get_initial_capacity ()
void	garrow_record_batch_builder_set_initial_capacity ()
GArrowSchema *	garrow_record_batch_builder_get_schema ()
gint	garrow_record_batch_builder_get_n_fields ()
gint	garrow_record_batch_builder_get_n_columns ()
GArrowArrayBuilder *	garrow_record_batch_builder_get_field ()
GArrowArrayBuilder *	garrow_record_batch_builder_get_column_builder ()
GArrowRecordBatch *	garrow_record_batch_builder_flush ()

Properties

gpointer

record-batch-builder

Write / Construct Only

Types and Values

#define	GARROW_TYPE_RECORD_BATCH_BUILDER
struct	GArrowRecordBatchBuilderClass
	GArrowRecordBatchBuilder

Object Hierarchy

    GObject
    ╰── GArrowRecordBatchBuilder

Includes

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

Description

GArrowRecordBatchBuilder is a class to create new GArrowRecordBatch.

Functions

garrow_record_batch_builder_new ()

GArrowRecordBatchBuilder *
garrow_record_batch_builder_new (GArrowSchema *schema,
                                 GError **error);

Parameters

schema	A GArrowSchema.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowRecordBatchBuilder on success, NULL on error.

Since: 0.8.0

garrow_record_batch_builder_get_initial_capacity ()

gint64
garrow_record_batch_builder_get_initial_capacity
                               (GArrowRecordBatchBuilder *builder);

Parameters

builder

A GArrowRecordBatchBuilder.

Returns

The initial capacity for array builders.

Since: 0.8.0

garrow_record_batch_builder_set_initial_capacity ()

void
garrow_record_batch_builder_set_initial_capacity
                               (GArrowRecordBatchBuilder *builder,
                                gint64 capacity);

Parameters

builder	A GArrowRecordBatchBuilder.
capacity	The new initial capacity for array builders.

Since: 0.8.0

garrow_record_batch_builder_get_schema ()

GArrowSchema *
garrow_record_batch_builder_get_schema
                               (GArrowRecordBatchBuilder *builder);

Parameters

builder

A GArrowRecordBatchBuilder.

Returns

The GArrowSchema of the record batch builder.

[transfer full]

Since: 0.8.0

garrow_record_batch_builder_get_n_fields ()

gint
garrow_record_batch_builder_get_n_fields
                               (GArrowRecordBatchBuilder *builder);

garrow_record_batch_builder_get_n_fields has been deprecated since version 0.13.0 and should not be used in newly-written code.

Use garrow_record_batch_builder_get_n_columns() instead.

Parameters

builder

A GArrowRecordBatchBuilder.

Returns

The number of fields.

Since: 0.8.0

garrow_record_batch_builder_get_n_columns ()

gint
garrow_record_batch_builder_get_n_columns
                               (GArrowRecordBatchBuilder *builder);

Parameters

builder

A GArrowRecordBatchBuilder.

Returns

The number of columns.

Since: 0.13.0

garrow_record_batch_builder_get_field ()

GArrowArrayBuilder *
garrow_record_batch_builder_get_field (GArrowRecordBatchBuilder *builder,
                                       gint i);

garrow_record_batch_builder_get_field has been deprecated since version 0.13.0 and should not be used in newly-written code.

Use garrow_record_batch_builder_get_column_builder() instead.

Parameters

builder	A GArrowRecordBatchBuilder.
i	The field index. If it's negative, index is counted backward from the end of the fields. `-1` means the last field.

Returns

The GArrowArrayBuilder for the i-th field on success, NULL on out of index.

[transfer none][nullable]

Since: 0.8.0

garrow_record_batch_builder_get_column_builder ()

GArrowArrayBuilder *
garrow_record_batch_builder_get_column_builder
                               (GArrowRecordBatchBuilder *builder,
                                gint i);

Parameters

builder	A GArrowRecordBatchBuilder.
i	The column index. If it's negative, index is counted backward from the end of the columns. `-1` means the last column.

Returns

The GArrowArrayBuilder for the i-th column on success, NULL on out of index.

[transfer none][nullable]

Since: 0.13.0

garrow_record_batch_builder_flush ()

GArrowRecordBatch *
garrow_record_batch_builder_flush (GArrowRecordBatchBuilder *builder,
                                   GError **error);

Parameters

builder	A GArrowRecordBatchBuilder.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The built GArrowRecordBatch on success, NULL on error.

[transfer full]

Since: 0.8.0

Types and Values

GARROW_TYPE_RECORD_BATCH_BUILDER

#define GARROW_TYPE_RECORD_BATCH_BUILDER (garrow_record_batch_builder_get_type())

struct GArrowRecordBatchBuilderClass

struct GArrowRecordBatchBuilderClass {
  GObjectClass parent_class;
};

GArrowRecordBatchBuilder

typedef struct _GArrowRecordBatchBuilder GArrowRecordBatchBuilder;

Property Details

The `“record-batch-builder”` property

  “record-batch-builder”     gpointer

The raw arrow::RecordBatchBuilder *.

Flags: Write / Construct Only