chunked-array: Apache Arrow GLib Reference Manual

chunked-array

chunked-array — Chunked array class

Functions

GArrowChunkedArray *	garrow_chunked_array_new ()
GArrowChunkedArray *	garrow_chunked_array_new_empty ()
gboolean	garrow_chunked_array_equal ()
GArrowDataType *	garrow_chunked_array_get_value_data_type ()
GArrowType	garrow_chunked_array_get_value_type ()
guint64	garrow_chunked_array_get_length ()
guint64	garrow_chunked_array_get_n_rows ()
guint64	garrow_chunked_array_get_n_nulls ()
guint	garrow_chunked_array_get_n_chunks ()
GArrowArray *	garrow_chunked_array_get_chunk ()
GList *	garrow_chunked_array_get_chunks ()
GArrowChunkedArray *	garrow_chunked_array_slice ()
gchar *	garrow_chunked_array_to_string ()
GArrowArray *	garrow_chunked_array_combine ()

Description

GArrowChunkedArray is a class for chunked array. Chunked array makes a list of GArrowArrays one logical large array.

Functions

garrow_chunked_array_new ()

GArrowChunkedArray *
garrow_chunked_array_new (GList *chunks,
                          GError **error);

Parameters

chunks	The array chunks.	[element-type GArrowArray]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowChunkedArray or NULL on error.

[nullable]

garrow_chunked_array_new_empty ()

GArrowChunkedArray *
garrow_chunked_array_new_empty (GArrowDataType *data_type,
                                GError **error);

Parameters

data_type	The GArrowDataType of this chunked array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created empty GArrowChunkedArray or NULL on error.

[nullable]

Since: 11.0.0

garrow_chunked_array_equal ()

gboolean
garrow_chunked_array_equal (GArrowChunkedArray *chunked_array,
                            GArrowChunkedArray *other_chunked_array);

Parameters

chunked_array	A GArrowChunkedArray.
other_chunked_array	A GArrowChunkedArray to be compared.

Returns

TRUE if both of them have the same data, FALSE otherwise.

Since: 0.4.0

garrow_chunked_array_get_value_data_type ()

GArrowDataType *
garrow_chunked_array_get_value_data_type
                               (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The GArrowDataType of the value of the chunked array.

[transfer full]

Since: 0.9.0

garrow_chunked_array_get_value_type ()

GArrowType
garrow_chunked_array_get_value_type (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The GArrowType of the value of the chunked array.

Since: 0.9.0

garrow_chunked_array_get_length ()

guint64
garrow_chunked_array_get_length (GArrowChunkedArray *chunked_array);

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

Use garrow_chunked_array_get_n_rows() instead.

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The total number of rows in the chunked array.

garrow_chunked_array_get_n_rows ()

guint64
garrow_chunked_array_get_n_rows (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The total number of rows in the chunked array.

Since: 0.15.0

garrow_chunked_array_get_n_nulls ()

guint64
garrow_chunked_array_get_n_nulls (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The total number of NULL in the chunked array.

garrow_chunked_array_get_n_chunks ()

guint
garrow_chunked_array_get_n_chunks (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The total number of chunks in the chunked array.

garrow_chunked_array_get_chunk ()

GArrowArray *
garrow_chunked_array_get_chunk (GArrowChunkedArray *chunked_array,
                                guint i);

Parameters

chunked_array	A GArrowChunkedArray.
i	The index of the target chunk.

Returns

The i-th chunk of the chunked array.

[transfer full]

garrow_chunked_array_get_chunks ()

GList *
garrow_chunked_array_get_chunks (GArrowChunkedArray *chunked_array);

Parameters

chunked_array

A GArrowChunkedArray.

Returns

The chunks in the chunked array.

[element-type GArrowArray][transfer full]

garrow_chunked_array_slice ()

GArrowChunkedArray *
garrow_chunked_array_slice (GArrowChunkedArray *chunked_array,
                            guint64 offset,
                            guint64 length);

Parameters

chunked_array	A GArrowChunkedArray.
offset	The offset of sub GArrowChunkedArray.
length	The length of sub GArrowChunkedArray.

Returns

The sub GArrowChunkedArray. It covers only from offset to offset + length range. The sub GArrowChunkedArray shares values with the base GArrowChunkedArray.

[transfer full]

garrow_chunked_array_to_string ()

gchar *
garrow_chunked_array_to_string (GArrowChunkedArray *chunked_array,
                                GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The formatted chunked array content or NULL on error.

It should be freed with g_free() when no longer needed.

[nullable]

Since: 0.11.0

garrow_chunked_array_combine ()

GArrowArray *
garrow_chunked_array_combine (GArrowChunkedArray *chunked_array,
                              GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The combined array that has all data in all chunks.

[nullable][transfer full]

Since: 4.0.0