Computation on data: Apache Arrow GLib Reference Manual

Computation on data

Functions

GArrowExecuteContext *	garrow_execute_context_new ()
GArrowFunction *	garrow_function_find ()
GArrowDatum *	garrow_function_execute ()
GArrowCastOptions *	garrow_cast_options_new ()
GArrowScalarAggregateOptions *	garrow_scalar_aggregate_options_new ()
GArrowFilterOptions *	garrow_filter_options_new ()
GArrowTakeOptions *	garrow_take_options_new ()
GArrowArraySortOptions *	garrow_array_sort_options_new ()
gboolean	garrow_array_sort_options_equal ()
GArrowSortKey *	garrow_sort_key_new ()
gboolean	garrow_sort_key_equal ()
GArrowSortOptions *	garrow_sort_options_new ()
gboolean	garrow_sort_options_equal ()
GList *	garrow_sort_options_get_sort_keys ()
void	garrow_sort_options_set_sort_keys ()
void	garrow_sort_options_add_sort_key ()
GArrowArray *	garrow_array_cast ()
GArrowArray *	garrow_array_unique ()
GArrowDictionaryArray *	garrow_array_dictionary_encode ()
gint64	garrow_array_count ()
GArrowStructArray *	garrow_array_count_values ()
GArrowBooleanArray *	garrow_boolean_array_invert ()
GArrowBooleanArray *	garrow_boolean_array_and ()
GArrowBooleanArray *	garrow_boolean_array_or ()
GArrowBooleanArray *	garrow_boolean_array_xor ()
gdouble	garrow_numeric_array_mean ()
gint64	garrow_int8_array_sum ()
guint64	garrow_uint8_array_sum ()
gint64	garrow_int16_array_sum ()
guint64	garrow_uint16_array_sum ()
gint64	garrow_int32_array_sum ()
guint64	garrow_uint32_array_sum ()
gint64	garrow_int64_array_sum ()
guint64	garrow_uint64_array_sum ()
gdouble	garrow_float_array_sum ()
gdouble	garrow_double_array_sum ()
GArrowArray *	garrow_array_take ()
GArrowChunkedArray *	garrow_array_take_chunked_array ()
GArrowTable *	garrow_table_take ()
GArrowTable *	garrow_table_take_chunked_array ()
GArrowChunkedArray *	garrow_chunked_array_take ()
GArrowChunkedArray *	garrow_chunked_array_take_chunked_array ()
GArrowRecordBatch *	garrow_record_batch_take ()
GArrowArray *	garrow_array_filter ()
GArrowBooleanArray *	garrow_array_is_in ()
GArrowBooleanArray *	garrow_array_is_in_chunked_array ()
GArrowUInt64Array *	garrow_array_sort_indices ()
GArrowUInt64Array *	garrow_array_sort_to_indices ()
GArrowUInt64Array *	garrow_chunked_array_sort_indices ()
GArrowUInt64Array *	garrow_record_batch_sort_indices ()
GArrowUInt64Array *	garrow_table_sort_indices ()
GArrowTable *	garrow_table_filter ()
GArrowTable *	garrow_table_filter_chunked_array ()
GArrowChunkedArray *	garrow_chunked_array_filter ()
GArrowChunkedArray *	garrow_chunked_array_filter_chunked_array ()
GArrowRecordBatch *	garrow_record_batch_filter ()

Properties

GArrowSortOrder	order	Read / Write
gboolean	allow-decimal-truncate	Read / Write
gboolean	allow-float-truncate	Read / Write
gboolean	allow-int-overflow	Read / Write
gboolean	allow-invalid-utf8	Read / Write
gboolean	allow-time-overflow	Read / Write
gboolean	allow-time-truncate	Read / Write
GArrowDataType *	to-data-type	Read / Write
GArrowFilterNullSelectionBehavior	null-selection-behavior	Read / Write
gpointer	function	Write / Construct Only
guint	min-count	Read / Write
gboolean	skip-nulls	Read / Write
gchar *	name	Read / Write
GArrowSortOrder	order	Read / Write

Types and Values

#define	GARROW_TYPE_EXECUTE_CONTEXT
struct	GArrowExecuteContextClass
#define	GARROW_TYPE_FUNCTION_OPTIONS
#define	GARROW_TYPE_FUNCTION
struct	GArrowFunctionClass
#define	GARROW_TYPE_CAST_OPTIONS
struct	GArrowCastOptionsClass
#define	GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS
struct	GArrowScalarAggregateOptionsClass
enum	GArrowFilterNullSelectionBehavior
#define	GARROW_TYPE_FILTER_OPTIONS
struct	GArrowFilterOptionsClass
#define	GARROW_TYPE_TAKE_OPTIONS
struct	GArrowTakeOptionsClass
enum	GArrowSortOrder
#define	GARROW_TYPE_ARRAY_SORT_OPTIONS
struct	GArrowArraySortOptionsClass
#define	GARROW_TYPE_SORT_KEY
struct	GArrowSortKeyClass
#define	GARROW_TYPE_SORT_OPTIONS
struct	GArrowSortOptionsClass
	GArrowArraySortOptions
	GArrowCastOptions
	GArrowExecuteContext
	GArrowFilterOptions
	GArrowFunction
	GArrowFunctionOptions
	GArrowFunctionOptionsInterface
	GArrowScalarAggregateOptions
	GArrowSortKey
	GArrowSortOptions
	GArrowTakeOptions

Object Hierarchy

    GEnum
    ├── GArrowFilterNullSelectionBehavior
    ╰── GArrowSortOrder
    GInterface
    ╰── GArrowFunctionOptions
    GObject
    ├── GArrowArraySortOptions
    ├── GArrowCastOptions
    ├── GArrowExecuteContext
    ├── GArrowFilterOptions
    ├── GArrowFunction
    ├── GArrowScalarAggregateOptions
    ├── GArrowSortKey
    ├── GArrowSortOptions
    ╰── GArrowTakeOptions

Implemented Interfaces

GArrowArraySortOptions implements GArrowFunctionOptions.

GArrowCastOptions implements GArrowFunctionOptions.

GArrowFilterOptions implements GArrowFunctionOptions.

GArrowScalarAggregateOptions implements GArrowFunctionOptions.

GArrowSortOptions implements GArrowFunctionOptions.

GArrowTakeOptions implements GArrowFunctionOptions.

Known Implementations

GArrowFunctionOptions is implemented by GArrowArraySortOptions, GArrowCastOptions, GArrowFilterOptions, GArrowScalarAggregateOptions, GArrowSortOptions and GArrowTakeOptions.

Includes

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

Description

GArrowExecuteContext is a class to customize how to execute a function.

GArrowFunctionOptions is an interface for function options. All function options such as GArrowCastOptions must implement this interface.

GArrowFunction is a class to process data.

GArrowCastOptions is a class to customize the cast function and garrow_array_cast().

GArrowScalarAggregateOptions is a class to customize the scalar aggregate functions such as count function and convenient functions of them such as garrow_array_count().

GArrowFilterOptions is a class to customize the filter function and garrow_array_filter() family.

GArrowTakeOptions is a class to customize the take function and garrow_array_take() family.

GArrowArraySortOptions is a class to customize the array_sort_indices function.

GArrowSortOptions is a class to customize the sort_indices function.

There are many functions to compute data on an array.

Functions

garrow_execute_context_new ()

GArrowExecuteContext *
garrow_execute_context_new (void);

Returns

A newly created GArrowExecuteContext.

Since: 1.0.0

garrow_function_find ()

GArrowFunction *
garrow_function_find (const gchar *name);

Parameters

name

A function name to be found.

Returns

The found GArrowFunction or NULL on not found.

[transfer full]

Since: 1.0.0

garrow_function_execute ()

GArrowDatum *
garrow_function_execute (GArrowFunction *function,
                         GList *args,
                         GArrowFunctionOptions *options,
                         GArrowExecuteContext *context,
                         GError **error);

Parameters

function	A GArrowFunction.
args	A list of GArrowDatum.	[element-type GArrowDatum]
options	Options for the execution as an object that implements GArrowFunctionOptions.	[nullable]
context	A GArrowExecuteContext for the execution.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A return value of the execution as GArrowDatum on success, NULL on error.

[nullable][transfer full]

Since: 1.0.0

garrow_cast_options_new ()

GArrowCastOptions *
garrow_cast_options_new (void);

Returns

A newly created GArrowCastOptions.

Since: 0.7.0

garrow_scalar_aggregate_options_new ()

GArrowScalarAggregateOptions *
garrow_scalar_aggregate_options_new (void);

Returns

A newly created GArrowScalarAggregateOptions.

Since: 5.0.0

garrow_filter_options_new ()

GArrowFilterOptions *
garrow_filter_options_new (void);

Returns

A newly created GArrowFilterOptions.

Since: 0.17.0

garrow_take_options_new ()

GArrowTakeOptions *
garrow_take_options_new (void);

Returns

A newly created GArrowTakeOptions.

Since: 0.14.0

garrow_array_sort_options_new ()

GArrowArraySortOptions *
garrow_array_sort_options_new (GArrowSortOrder order);

Parameters

order

How to order by values.

Returns

A newly created GArrowArraySortOptions.

Since: 3.0.0

garrow_array_sort_options_equal ()

gboolean
garrow_array_sort_options_equal (GArrowArraySortOptions *options,
                                 GArrowArraySortOptions *other_options);

Parameters

options	A GArrowArraySortOptions.
other_options	A GArrowArraySortOptions to be compared.

Returns

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

Since: 3.0.0

garrow_sort_key_new ()

GArrowSortKey *
garrow_sort_key_new (const gchar *name,
                     GArrowSortOrder order);

Parameters

name	A column name to be used.
order	How to order by this sort key.

Returns

A newly created GArrowSortKey.

Since: 3.0.0

garrow_sort_key_equal ()

gboolean
garrow_sort_key_equal (GArrowSortKey *sort_key,
                       GArrowSortKey *other_sort_key);

Parameters

sort_key	A GArrowSortKey.
other_sort_key	A GArrowSortKey to be compared.

Returns

TRUE if both of them have the same name and order, FALSE otherwise.

Since: 3.0.0

garrow_sort_options_new ()

GArrowSortOptions *
garrow_sort_options_new (GList *sort_keys);

Parameters

sort_keys

The sort keys to be used.

[nullable][element-type GArrowSortKey]

Returns

A newly created GArrowSortOptions.

Since: 3.0.0

garrow_sort_options_equal ()

gboolean
garrow_sort_options_equal (GArrowSortOptions *options,
                           GArrowSortOptions *other_options);

Parameters

options	A GArrowSortOptions.
other_options	A GArrowSortOptions to be compared.

Returns

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

Since: 3.0.0

garrow_sort_options_get_sort_keys ()

GList *
garrow_sort_options_get_sort_keys (GArrowSortOptions *options);

Parameters

options

A GArrowSortOptions.

Returns

The sort keys to be used.

[transfer full][element-type GArrowSortKey]

Since: 3.0.0

garrow_sort_options_set_sort_keys ()

void
garrow_sort_options_set_sort_keys (GArrowSortOptions *options,
                                   GList *sort_keys);

Set sort keys to be used.

Parameters

options	A GArrowSortOptions.
sort_keys	The sort keys to be used.	[element-type GArrowSortKey]

Since: 3.0.0

garrow_sort_options_add_sort_key ()

void
garrow_sort_options_add_sort_key (GArrowSortOptions *options,
                                  GArrowSortKey *sort_key);

Add a sort key to be used.

Parameters

options	A GArrowSortOptions.
sort_key	The sort key to be added.

Since: 3.0.0

garrow_array_cast ()

GArrowArray *
garrow_array_cast (GArrowArray *array,
                   GArrowDataType *target_data_type,
                   GArrowCastOptions *options,
                   GError **error);

Parameters

array	A GArrowArray.
target_data_type	A GArrowDataType of cast target data.
options	A GArrowCastOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created casted array on success, NULL on error.

[nullable][transfer full]

Since: 0.7.0

garrow_array_unique ()

GArrowArray *
garrow_array_unique (GArrowArray *array,
                     GError **error);

Parameters

array	A GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created unique elements array on success, NULL on error.

[nullable][transfer full]

Since: 0.8.0

garrow_array_dictionary_encode ()

GArrowDictionaryArray *
garrow_array_dictionary_encode (GArrowArray *array,
                                GError **error);

Parameters

array	A GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowDictionaryArray for the array on success, NULL on error.

[nullable][transfer full]

Since: 0.8.0

garrow_array_count ()

gint64
garrow_array_count (GArrowArray *array,
                    GArrowScalarAggregateOptions *options,
                    GError **error);

Parameters

array	A GArrowArray.
options	A GArrowScalarAggregateOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The number of target values on success. If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_array_count_values ()

GArrowStructArray *
garrow_array_count_values (GArrowArray *array,
                           GError **error);

Parameters

array	A GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A GArrowStructArray of {input type "values", int64_t "counts"} on success, NULL on error.

[nullable][transfer full]

Since: 0.13.0

garrow_boolean_array_invert ()

GArrowBooleanArray *
garrow_boolean_array_invert (GArrowBooleanArray *array,
                             GError **error);

Parameters

array	A GArrowBooleanArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The element-wise inverted boolean array.

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

[transfer full]

Since: 0.13.0

garrow_boolean_array_and ()

GArrowBooleanArray *
garrow_boolean_array_and (GArrowBooleanArray *left,
                          GArrowBooleanArray *right,
                          GError **error);

Parameters

left	A left hand side GArrowBooleanArray.
right	A right hand side GArrowBooleanArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The element-wise AND operated boolean array.

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

[transfer full]

Since: 0.13.0

garrow_boolean_array_or ()

GArrowBooleanArray *
garrow_boolean_array_or (GArrowBooleanArray *left,
                         GArrowBooleanArray *right,
                         GError **error);

Parameters

left	A left hand side GArrowBooleanArray.
right	A right hand side GArrowBooleanArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The element-wise OR operated boolean array.

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

[transfer full]

Since: 0.13.0

garrow_boolean_array_xor ()

GArrowBooleanArray *
garrow_boolean_array_xor (GArrowBooleanArray *left,
                          GArrowBooleanArray *right,
                          GError **error);

Parameters

left	A left hand side GArrowBooleanArray.
right	A right hand side GArrowBooleanArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The element-wise XOR operated boolean array.

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

[transfer full]

Since: 0.13.0

garrow_numeric_array_mean ()

gdouble
garrow_numeric_array_mean (GArrowNumericArray *array,
                           GError **error);

Parameters

array	A GArrowNumericArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed mean.

Since: 0.13.0

garrow_int8_array_sum ()

gint64
garrow_int8_array_sum (GArrowInt8Array *array,
                       GError **error);

Parameters

array	A GArrowInt8Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint8_array_sum ()

guint64
garrow_uint8_array_sum (GArrowUInt8Array *array,
                        GError **error);

Parameters

array	A GArrowUInt8Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int16_array_sum ()

gint64
garrow_int16_array_sum (GArrowInt16Array *array,
                        GError **error);

Parameters

array	A GArrowInt16Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint16_array_sum ()

guint64
garrow_uint16_array_sum (GArrowUInt16Array *array,
                         GError **error);

Parameters

array	A GArrowUInt16Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int32_array_sum ()

gint64
garrow_int32_array_sum (GArrowInt32Array *array,
                        GError **error);

Parameters

array	A GArrowInt32Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint32_array_sum ()

guint64
garrow_uint32_array_sum (GArrowUInt32Array *array,
                         GError **error);

Parameters

array	A GArrowUInt32Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_int64_array_sum ()

gint64
garrow_int64_array_sum (GArrowInt64Array *array,
                        GError **error);

Parameters

array	A GArrowInt64Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_uint64_array_sum ()

guint64
garrow_uint64_array_sum (GArrowUInt64Array *array,
                         GError **error);

Parameters

array	A GArrowUInt64Array.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_float_array_sum ()

gdouble
garrow_float_array_sum (GArrowFloatArray *array,
                        GError **error);

Parameters

array	A GArrowFloatArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_double_array_sum ()

gdouble
garrow_double_array_sum (GArrowDoubleArray *array,
                         GError **error);

Parameters

array	A GArrowDoubleArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.

Since: 0.13.0

garrow_array_take ()

GArrowArray *
garrow_array_take (GArrowArray *array,
                   GArrowArray *indices,
                   GArrowTakeOptions *options,
                   GError **error);

Parameters

array	A GArrowArray.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.14.0

garrow_array_take_chunked_array ()

GArrowChunkedArray *
garrow_array_take_chunked_array (GArrowArray *array,
                                 GArrowChunkedArray *indices,
                                 GArrowTakeOptions *options,
                                 GError **error);

Parameters

array	A GArrowArray.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_table_take ()

GArrowTable *
garrow_table_take (GArrowTable *table,
                   GArrowArray *indices,
                   GArrowTakeOptions *options,
                   GError **error);

Parameters

table	A GArrowTable.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowTable taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_table_take_chunked_array ()

GArrowTable *
garrow_table_take_chunked_array (GArrowTable *table,
                                 GArrowChunkedArray *indices,
                                 GArrowTakeOptions *options,
                                 GError **error);

Parameters

table	A GArrowTable.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowTable taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_chunked_array_take ()

GArrowChunkedArray *
garrow_chunked_array_take (GArrowChunkedArray *chunked_array,
                           GArrowArray *indices,
                           GArrowTakeOptions *options,
                           GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_chunked_array_take_chunked_array ()

GArrowChunkedArray *
garrow_chunked_array_take_chunked_array
                               (GArrowChunkedArray *chunked_array,
                                GArrowChunkedArray *indices,
                                GArrowTakeOptions *options,
                                GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in chunked array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_record_batch_take ()

GArrowRecordBatch *
garrow_record_batch_take (GArrowRecordBatch *record_batch,
                          GArrowArray *indices,
                          GArrowTakeOptions *options,
                          GError **error);

Parameters

record_batch	A GArrowRecordBatch.
indices	The indices of values to take.
options	A GArrowTakeOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray taken from an array of values at indices in input array or NULL on error.

[nullable][transfer full]

Since: 0.16.0

garrow_array_filter ()

GArrowArray *
garrow_array_filter (GArrowArray *array,
                     GArrowBooleanArray *filter,
                     GArrowFilterOptions *options,
                     GError **error);

Parameters

array	A GArrowArray.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowArray filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_array_is_in ()

GArrowBooleanArray *
garrow_array_is_in (GArrowArray *left,
                    GArrowArray *right,
                    GError **error);

Parameters

left	A left hand side GArrowArray.
right	A right hand side GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowBooleanArray showing whether each element in the left array is contained in right array.

[nullable][transfer full]

Since: 0.15.0

garrow_array_is_in_chunked_array ()

GArrowBooleanArray *
garrow_array_is_in_chunked_array (GArrowArray *left,
                                  GArrowChunkedArray *right,
                                  GError **error);

Parameters

left	A left hand side GArrowArray.
right	A right hand side GArrowChunkedArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowBooleanArray showing whether each element in the left array is contained in right chunked array.

[nullable][transfer full]

Since: 0.15.0

garrow_array_sort_indices ()

GArrowUInt64Array *
garrow_array_sort_indices (GArrowArray *array,
                           GArrowSortOrder order,
                           GError **error);

Parameters

array	A GArrowArray.
order	The order for sort.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The indices that would sort an array in the specified order on success, NULL on error.

[nullable][transfer full]

Since: 3.0.0

garrow_array_sort_to_indices ()

GArrowUInt64Array *
garrow_array_sort_to_indices (GArrowArray *array,
                              GError **error);

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

Use garrow_array_sort_indices() instead.

Parameters

array	A GArrowArray.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The indices that would sort an array in ascending order on success, NULL on error.

[nullable][transfer full]

Since: 0.15.0

garrow_chunked_array_sort_indices ()

GArrowUInt64Array *
garrow_chunked_array_sort_indices (GArrowChunkedArray *chunked_array,
                                   GArrowSortOrder order,
                                   GError **error);

Parameters

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

Returns

The indices that would sort a chunked array in the specified order on success, NULL on error.

[nullable][transfer full]

Since: 3.0.0

garrow_record_batch_sort_indices ()

GArrowUInt64Array *
garrow_record_batch_sort_indices (GArrowRecordBatch *record_batch,
                                  GArrowSortOptions *options,
                                  GError **error);

Parameters

record_batch	A GArrowRecordBatch.
options	The options to be used.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The indices that would sort a record batch with the specified options on success, NULL on error.

[nullable][transfer full]

Since: 3.0.0

garrow_table_sort_indices ()

GArrowUInt64Array *
garrow_table_sort_indices (GArrowTable *table,
                           GArrowSortOptions *options,
                           GError **error);

Parameters

table	A GArrowTable.
options	The options to be used.
error	Return location for a GError or `NULL`.	[nullable]

Returns

The indices that would sort a table with the specified options on success, NULL on error.

[nullable][transfer full]

Since: 3.0.0

garrow_table_filter ()

GArrowTable *
garrow_table_filter (GArrowTable *table,
                     GArrowBooleanArray *filter,
                     GArrowFilterOptions *options,
                     GError **error);

Parameters

table	A GArrowTable.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowTable filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_table_filter_chunked_array ()

GArrowTable *
garrow_table_filter_chunked_array (GArrowTable *table,
                                   GArrowChunkedArray *filter,
                                   GArrowFilterOptions *options,
                                   GError **error);

Parameters

table	A GArrowTable.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowTable filterd with a chunked array filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_chunked_array_filter ()

GArrowChunkedArray *
garrow_chunked_array_filter (GArrowChunkedArray *chunked_array,
                             GArrowBooleanArray *filter,
                             GArrowFilterOptions *options,
                             GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_chunked_array_filter_chunked_array ()

GArrowChunkedArray *
garrow_chunked_array_filter_chunked_array
                               (GArrowChunkedArray *chunked_array,
                                GArrowChunkedArray *filter,
                                GArrowFilterOptions *options,
                                GError **error);

Parameters

chunked_array	A GArrowChunkedArray.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowChunkedArray filterd with a chunked array filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

garrow_record_batch_filter ()

GArrowRecordBatch *
garrow_record_batch_filter (GArrowRecordBatch *record_batch,
                            GArrowBooleanArray *filter,
                            GArrowFilterOptions *options,
                            GError **error);

Parameters

record_batch	A GArrowRecordBatch.
filter	The values indicates which values should be filtered out.
options	A GArrowFilterOptions.	[nullable]
error	Return location for a GError or `NULL`.	[nullable]

Returns

The GArrowRecordBatch filterd with a boolean selection filter. Nulls in the filter will result in nulls in the output.

[nullable][transfer full]

Since: 0.15.0

Types and Values

GARROW_TYPE_EXECUTE_CONTEXT

#define GARROW_TYPE_EXECUTE_CONTEXT (garrow_execute_context_get_type())

struct GArrowExecuteContextClass

struct GArrowExecuteContextClass {
  GObjectClass parent_class;
};

GARROW_TYPE_FUNCTION_OPTIONS

#define GARROW_TYPE_FUNCTION_OPTIONS (garrow_function_options_get_type())

GARROW_TYPE_FUNCTION

#define GARROW_TYPE_FUNCTION (garrow_function_get_type())

struct GArrowFunctionClass

struct GArrowFunctionClass {
  GObjectClass parent_class;
};

GARROW_TYPE_CAST_OPTIONS

#define GARROW_TYPE_CAST_OPTIONS (garrow_cast_options_get_type())

struct GArrowCastOptionsClass

struct GArrowCastOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS

#define GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS (garrow_scalar_aggregate_options_get_type())

struct GArrowScalarAggregateOptionsClass

struct GArrowScalarAggregateOptionsClass {
  GObjectClass parent_class;
};

enum GArrowFilterNullSelectionBehavior

They are corresponding to arrow::compute::FilterOptions::NullSelectionBehavior values.

Members

GARROW_FILTER_NULL_SELECTION_DROP	Filtered value will be removed in the output.
GARROW_FILTER_NULL_SELECTION_EMIT_NULL	Filtered value will be null in the output.

GARROW_TYPE_FILTER_OPTIONS

#define GARROW_TYPE_FILTER_OPTIONS (garrow_filter_options_get_type())

struct GArrowFilterOptionsClass

struct GArrowFilterOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_TAKE_OPTIONS

#define GARROW_TYPE_TAKE_OPTIONS (garrow_take_options_get_type())

struct GArrowTakeOptionsClass

struct GArrowTakeOptionsClass {
  GObjectClass parent_class;
};

enum GArrowSortOrder

They are corresponding to arrow::compute::SortOrder values.

Members

GARROW_SORT_ORDER_ASCENDING	Sort in ascending order.
GARROW_SORT_ORDER_DESCENDING	Sort in descending order.

Since: 3.0.0

GARROW_TYPE_ARRAY_SORT_OPTIONS

#define GARROW_TYPE_ARRAY_SORT_OPTIONS (garrow_array_sort_options_get_type())

struct GArrowArraySortOptionsClass

struct GArrowArraySortOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_SORT_KEY

#define GARROW_TYPE_SORT_KEY (garrow_sort_key_get_type())

struct GArrowSortKeyClass

struct GArrowSortKeyClass {
  GObjectClass parent_class;
};

GARROW_TYPE_SORT_OPTIONS

#define GARROW_TYPE_SORT_OPTIONS (garrow_sort_options_get_type())

struct GArrowSortOptionsClass

struct GArrowSortOptionsClass {
  GObjectClass parent_class;
};

GArrowArraySortOptions

typedef struct _GArrowArraySortOptions GArrowArraySortOptions;

GArrowCastOptions

typedef struct _GArrowCastOptions GArrowCastOptions;

GArrowExecuteContext

typedef struct _GArrowExecuteContext GArrowExecuteContext;

GArrowFilterOptions

typedef struct _GArrowFilterOptions GArrowFilterOptions;

GArrowFunction

typedef struct _GArrowFunction GArrowFunction;

GArrowFunctionOptions

typedef struct _GArrowFunctionOptions GArrowFunctionOptions;

GArrowFunctionOptionsInterface

typedef struct _GArrowFunctionOptionsInterface GArrowFunctionOptionsInterface;

GArrowScalarAggregateOptions

typedef struct _GArrowScalarAggregateOptions GArrowScalarAggregateOptions;

GArrowSortKey

typedef struct _GArrowSortKey GArrowSortKey;

GArrowSortOptions

typedef struct _GArrowSortOptions GArrowSortOptions;

GArrowTakeOptions

typedef struct _GArrowTakeOptions GArrowTakeOptions;

Property Details

The `“order”` property

  “order”                    GArrowSortOrder

How to order values.

Owner: GArrowArraySortOptions

Flags: Read / Write

Default value: GARROW_SORT_ORDER_ASCENDING

Since: 3.0.0

The `“allow-decimal-truncate”` property

  “allow-decimal-truncate”   gboolean

Whether truncating decimal value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0

The `“allow-float-truncate”` property

  “allow-float-truncate”     gboolean

Whether truncating float value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.12.0

The `“allow-int-overflow”` property

  “allow-int-overflow”       gboolean

Whether integer overflow is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.7.0

The `“allow-invalid-utf8”` property

  “allow-invalid-utf8”       gboolean

Whether invalid UTF-8 string value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.13.0

The `“allow-time-overflow”` property

  “allow-time-overflow”      gboolean

Whether time overflow is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0

The `“allow-time-truncate”` property

  “allow-time-truncate”      gboolean

Whether truncating time value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.8.0

The `“to-data-type”` property

  “to-data-type”             GArrowDataType *

The GArrowDataType being casted to.

Owner: GArrowCastOptions

Flags: Read / Write

Since: 1.0.0

The `“null-selection-behavior”` property

  “null-selection-behavior”  GArrowFilterNullSelectionBehavior

How to handle filtered values.

Owner: GArrowFilterOptions

Flags: Read / Write

Default value: GARROW_FILTER_NULL_SELECTION_DROP

Since: 0.17.0

The `“function”` property

  “function”                 gpointer

The raw std::shared<arrow::compute::Function> *.

Owner: GArrowFunction

Flags: Write / Construct Only

The `“min-count”` property

  “min-count”                guint

The minimum required number of values.

Owner: GArrowScalarAggregateOptions

Flags: Read / Write

Default value: 1

Since: 5.0.0

The `“skip-nulls”` property

  “skip-nulls”               gboolean

Whether NULLs are skipped or not.

Owner: GArrowScalarAggregateOptions

Flags: Read / Write

Default value: TRUE

Since: 5.0.0

The `“name”` property

  “name”                     gchar *

The column name to be used.

Owner: GArrowSortKey

Flags: Read / Write

Default value: NULL

Since: 3.0.0

The `“order”` property

  “order”                    GArrowSortOrder

How to order values.

Owner: GArrowSortKey

Flags: Read / Write

Default value: GARROW_SORT_ORDER_ASCENDING

Since: 3.0.0