Computation on data: Apache Arrow GLib Reference Manual

Computation on data

Functions

GArrowExecuteContext *	garrow_execute_context_new ()
gboolean	garrow_function_options_equal ()
gchar *	garrow_function_options_to_string ()
gchar *	garrow_function_doc_get_summary ()
gchar *	garrow_function_doc_get_description ()
gchar **	garrow_function_doc_get_arg_names ()
gchar *	garrow_function_doc_get_options_class_name ()
GArrowFunction *	garrow_function_find ()
GList *	garrow_function_all ()
GArrowDatum *	garrow_function_execute ()
const gchar *	garrow_function_get_name ()
GArrowFunctionDoc *	garrow_function_get_doc ()
GArrowFunctionOptions *	garrow_function_get_default_options ()
GType	garrow_function_get_options_type ()
gboolean	garrow_function_equal ()
gchar *	garrow_function_to_string ()
GArrowSourceNodeOptions *	garrow_source_node_options_new_record_batch_reader ()
GArrowSourceNodeOptions *	garrow_source_node_options_new_record_batch ()
GArrowSourceNodeOptions *	garrow_source_node_options_new_table ()
GArrowAggregation *	garrow_aggregation_new ()
GArrowAggregateNodeOptions *	garrow_aggregate_node_options_new ()
GArrowSinkNodeOptions *	garrow_sink_node_options_new ()
GArrowRecordBatchReader *	garrow_sink_node_options_get_reader ()
GArrowHashJoinNodeOptions *	garrow_hash_join_node_options_new ()
gboolean	garrow_hash_join_node_options_set_left_outputs ()
gboolean	garrow_hash_join_node_options_set_right_outputs ()
const gchar *	garrow_execute_node_get_kind_name ()
GArrowSchema *	garrow_execute_node_get_output_schema ()
GArrowExecutePlan *	garrow_execute_plan_new ()
GArrowExecuteNode *	garrow_execute_plan_build_node ()
GArrowExecuteNode *	garrow_execute_plan_build_source_node ()
GArrowExecuteNode *	garrow_execute_plan_build_aggregate_node ()
GArrowExecuteNode *	garrow_execute_plan_build_sink_node ()
GArrowExecuteNode *	garrow_execute_plan_build_hash_join_node ()
gboolean	garrow_execute_plan_validate ()
gboolean	garrow_execute_plan_start ()
void	garrow_execute_plan_stop ()
void	garrow_execute_plan_wait ()
GArrowCastOptions *	garrow_cast_options_new ()
GArrowScalarAggregateOptions *	garrow_scalar_aggregate_options_new ()
GArrowCountOptions *	garrow_count_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 ()
GArrowSetLookupOptions *	garrow_set_lookup_options_new ()
GArrowVarianceOptions *	garrow_variance_options_new ()
GArrowRoundOptions *	garrow_round_options_new ()
GArrowRoundToMultipleOptions *	garrow_round_to_multiple_options_new ()
GArrowUTF8NormalizeOptions *	garrow_utf8_normalize_options_new ()
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

gchar *	function	Read / Write / Construct Only
gchar *	input	Read / Write / Construct Only
GArrowFunctionOptions *	options	Read / Write / Construct Only
gchar *	output	Read / Write / Construct Only
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
GArrowCountMode	mode	Read / Write
gpointer	node	Write / Construct Only
gpointer	options	Write / Construct Only
gpointer	plan	Write / Construct Only
GArrowFilterNullSelectionBehavior	null-selection-behavior	Read / Write
gpointer	function	Write / Construct Only
gpointer	doc	Write / Construct Only
GArrowRoundMode	mode	Read / Write
gint64	n-digits	Read / Write
GArrowRoundMode	mode	Read / Write
GArrowScalar *	multiple	Read / Write
guint	min-count	Read / Write
gboolean	skip-nulls	Read / Write
gboolean	skip-nulls	Read / Write
GArrowDatum *	value-set	Read / Write
GArrowSortOrder	order	Read / Write / Construct Only
gchar *	target	Read
GArrowRecordBatchReader *	reader	Write / Construct Only
GArrowRecordBatch *	record-batch	Write / Construct Only
GArrowUTF8NormalizeForm	form	Read / Write
gint	ddof	Read / Write
guint	min-count	Read / Write
gboolean	skip-nulls	Read / Write

Types and Values

#define	GARROW_TYPE_EXECUTE_CONTEXT
struct	GArrowExecuteContextClass
#define	GARROW_TYPE_FUNCTION_OPTIONS
struct	GArrowFunctionOptionsClass
#define	GARROW_TYPE_FUNCTION_DOC
struct	GArrowFunctionDocClass
#define	GARROW_TYPE_FUNCTION
struct	GArrowFunctionClass
#define	GARROW_TYPE_EXECUTE_NODE_OPTIONS
struct	GArrowExecuteNodeOptionsClass
#define	GARROW_TYPE_SOURCE_NODE_OPTIONS
struct	GArrowSourceNodeOptionsClass
#define	GARROW_TYPE_AGGREGATION
struct	GArrowAggregationClass
#define	GARROW_TYPE_AGGREGATE_NODE_OPTIONS
struct	GArrowAggregateNodeOptionsClass
#define	GARROW_TYPE_SINK_NODE_OPTIONS
struct	GArrowSinkNodeOptionsClass
enum	GArrowJoinType
#define	GARROW_TYPE_HASH_JOIN_NODE_OPTIONS
struct	GArrowHashJoinNodeOptionsClass
#define	GARROW_TYPE_EXECUTE_NODE
struct	GArrowExecuteNodeClass
#define	GARROW_TYPE_EXECUTE_PLAN
struct	GArrowExecutePlanClass
#define	GARROW_TYPE_CAST_OPTIONS
struct	GArrowCastOptionsClass
#define	GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS
struct	GArrowScalarAggregateOptionsClass
enum	GArrowCountMode
#define	GARROW_TYPE_COUNT_OPTIONS
struct	GArrowCountOptionsClass
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
#define	GARROW_TYPE_SET_LOOKUP_OPTIONS
struct	GArrowSetLookupOptionsClass
#define	GARROW_TYPE_VARIANCE_OPTIONS
struct	GArrowVarianceOptionsClass
enum	GArrowRoundMode
#define	GARROW_TYPE_ROUND_OPTIONS
struct	GArrowRoundOptionsClass
#define	GARROW_TYPE_ROUND_TO_MULTIPLE_OPTIONS
struct	GArrowRoundToMultipleOptionsClass
enum	GArrowUTF8NormalizeForm
#define	GARROW_TYPE_UTF8_NORMALIZE_OPTIONS
struct	GArrowUTF8NormalizeOptionsClass
	GArrowAggregateNodeOptions
	GArrowAggregation
	GArrowArraySortOptions
	GArrowCastOptions
	GArrowCountOptions
	GArrowExecuteContext
	GArrowExecuteNode
	GArrowExecuteNodeOptions
	GArrowExecutePlan
	GArrowFilterOptions
	GArrowFunction
	GArrowFunctionDoc
	GArrowFunctionOptions
	GArrowHashJoinNodeOptions
	GArrowRoundOptions
	GArrowRoundToMultipleOptions
	GArrowScalarAggregateOptions
	GArrowSetLookupOptions
	GArrowSinkNodeOptions
	GArrowSortKey
	GArrowSortOptions
	GArrowSourceNodeOptions
	GArrowTakeOptions
	GArrowUTF8NormalizeOptions
	GArrowVarianceOptions

Object Hierarchy

    GEnum
    ├── GArrowCountMode
    ├── GArrowFilterNullSelectionBehavior
    ├── GArrowJoinType
    ├── GArrowRoundMode
    ├── GArrowSortOrder
    ╰── GArrowUTF8NormalizeForm
    GObject
    ├── GArrowExecuteContext
    ├── GArrowExecuteNode
    ├── GArrowExecutePlan
    ├── GArrowFunction
    ├── GArrowFunctionDoc
    ├── GArrowFunctionOptions
    │   ├── GArrowArraySortOptions
    │   ├── GArrowCastOptions
    │   ├── GArrowCountOptions
    │   ├── GArrowFilterOptions
    │   ├── GArrowRoundOptions
    │   ├── GArrowRoundToMultipleOptions
    │   ├── GArrowScalarAggregateOptions
    │   ├── GArrowSetLookupOptions
    │   ├── GArrowSortOptions
    │   ├── GArrowTakeOptions
    │   ├── GArrowUTF8NormalizeOptions
    │   ├── GArrowVarianceOptions
    │   ├── GArrowArraySortOptions
    │   ├── GArrowCastOptions
    │   ├── GArrowCountOptions
    │   ╰── GArrowFilterOptions
    ├── GArrowAggregation
    ├── GArrowExecuteNodeOptions
    │   ├── GArrowAggregateNodeOptions
    │   ├── GArrowHashJoinNodeOptions
    │   ├── GArrowSinkNodeOptions
    │   ├── GArrowSourceNodeOptions
    │   ╰── GArrowAggregateNodeOptions
    ╰── GArrowSortKey

Includes

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

Description

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

GArrowFunctionOptions is a base class for all function options classes such as GArrowCastOptions.

GArrowFunctionDoc is a class for function document.

GArrowFunction is a class to process data.

GArrowExecuteNodeOptions is a base class for all execute node options classes such as GArrowSourceNodeOptions.

GArrowSourceNodeOptions is a class to customize a source node.

GArrowAggregation is a class to specify how to aggregate.

GArrowAggregateNodeOptions is a class to customize an aggregate node.

GArrowSinkNodeOptions is a class to customize a sink node.

GArrowHashJoinNodeOptions is a class to customize a hash join node.

GArrowExecuteNode is a class to execute an operation.

GArrowExecutePlan is a class to execute operations.

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

GArrowCountOptions is a class to customize the count function and garrow_array_count() family.

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.

GArrowSetLookupOptions is a class to customize the is_in function and index_in function.

GArrowVarianceOptions is a class to customize the stddev function and variance function.

GArrowRoundOptions is a class to customize the round function.

GArrowRoundToMultipleOptions is a class to customize the round_to_multiple function.

GArrowUTF8NormalizeOptions is a class to customize the utf8_normalize 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_options_equal ()

gboolean
garrow_function_options_equal (GArrowFunctionOptions *options,
                               GArrowFunctionOptions *other_options);

Parameters

options	A GArrowFunctionOptions.
other_options	A GArrowFunctionOptions to be compared.	[nullable]

Returns

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

Since: 7.0.0

garrow_function_options_to_string ()

gchar *
garrow_function_options_to_string (GArrowFunctionOptions *options);

Parameters

options

A GArrowFunctionOptions.

Returns

The formatted options.

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

Since: 7.0.0

garrow_function_doc_get_summary ()

gchar *
garrow_function_doc_get_summary (GArrowFunctionDoc *doc);

Parameters

doc

A GArrowFunctionDoc.

Returns

A one-line summary of the function, using a verb.

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

Since: 6.0.0

garrow_function_doc_get_description ()

gchar *
garrow_function_doc_get_description (GArrowFunctionDoc *doc);

Parameters

doc

A GArrowFunctionDoc.

Returns

A detailed description of the function, meant to follow the summary.

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

Since: 6.0.0

garrow_function_doc_get_arg_names ()

gchar **
garrow_function_doc_get_arg_names (GArrowFunctionDoc *doc);

Parameters

doc

A GArrowFunctionDoc.

Returns

Symbolic names (identifiers) for the function arguments.

It's a NULL-terminated string array. It must be freed with g_strfreev() when no longer needed.

[array zero-terminated=1][element-type utf8][transfer full]

Since: 6.0.0

garrow_function_doc_get_options_class_name ()

gchar *
garrow_function_doc_get_options_class_name
                               (GArrowFunctionDoc *doc);

Parameters

doc

A GArrowFunctionDoc.

Returns

Name of the options class, if any.

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

Since: 6.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_all ()

GList *
garrow_function_all (void);

Returns

The all available functions.

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

[element-type GArrowFunction][transfer full]

Since: 7.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_function_get_name ()

const gchar *
garrow_function_get_name (GArrowFunction *function);

Parameters

function

A GArrowFunction.

Returns

The function name.

Since: 7.0.0

garrow_function_get_doc ()

GArrowFunctionDoc *
garrow_function_get_doc (GArrowFunction *function);

Parameters

function

A GArrowFunction.

Returns

The function documentation.

[transfer full]

Since: 6.0.0

garrow_function_get_default_options ()

GArrowFunctionOptions *
garrow_function_get_default_options (GArrowFunction *function);

Parameters

function

A GArrowFunction.

Returns

The default options of this function if exists, NULL otherwise.

[transfer full][nullable]

Since: 7.0.0

garrow_function_get_options_type ()

GType
garrow_function_get_options_type (GArrowFunction *function);

Parameters

function

A GArrowFunction.

Returns

G_TYPE_NONE if this function doesn't have options, the GType of options of this function if it exists and Apache Arrow GLib bindings of it also exist, G_TYPE_INVALID if options of this function exists but Apache Arrow GLib bindings of it don't exist.

Since: 7.0.0

garrow_function_equal ()

gboolean
garrow_function_equal (GArrowFunction *function,
                       GArrowFunction *other_function);

Parameters

function	A GArrowFunction.
other_function	A GArrowFunction to be compared.

Returns

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

Since: 7.0.0

garrow_function_to_string ()

gchar *
garrow_function_to_string (GArrowFunction *function);

Parameters

function

A GArrowFunction.

Returns

The formatted function.

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

Since: 7.0.0

garrow_source_node_options_new_record_batch_reader ()

GArrowSourceNodeOptions *
garrow_source_node_options_new_record_batch_reader
                               (GArrowRecordBatchReader *reader);

Parameters

reader

A GArrowRecordBatchReader.

Returns

A newly created GArrowSourceNodeOptions.

Since: 6.0.0

garrow_source_node_options_new_record_batch ()

GArrowSourceNodeOptions *
garrow_source_node_options_new_record_batch
                               (GArrowRecordBatch *record_batch);

Parameters

record_batch

A GArrowRecordBatch.

Returns

A newly created GArrowSourceNodeOptions.

Since: 6.0.0

garrow_source_node_options_new_table ()

GArrowSourceNodeOptions *
garrow_source_node_options_new_table (GArrowTable *table);

Parameters

table

A GArrowTable.

Returns

A newly created GArrowSourceNodeOptions.

Since: 6.0.0

garrow_aggregation_new ()

GArrowAggregation *
garrow_aggregation_new (const gchar *function,
                        GArrowFunctionOptions *options,
                        const gchar *input,
                        const gchar *output);

Parameters

function	A name of aggregate function.
options	A GArrowFunctionOptions of aggregate function.	[nullable]
input	An input field name of aggregate function.
output	An output field name of aggregate function.

Returns

A newly created GArrowAggregation.

Since: 6.0.0

garrow_aggregate_node_options_new ()

GArrowAggregateNodeOptions *
garrow_aggregate_node_options_new (GList *aggregations,
                                   const gchar **keys,
                                   gsize n_keys,
                                   GError **error);

Parameters

aggregations	A list of GArrowAggregation.	[element-type GArrowAggregation]
keys	Group keys.	[nullable][array length=n_keys]
n_keys	The number of `keys` .
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowAggregateNodeOptions on success, NULL otherwise.

[nullable]

Since: 6.0.0

garrow_sink_node_options_new ()

GArrowSinkNodeOptions *
garrow_sink_node_options_new (void);

Returns

A newly created GArrowSinkNodeOptions.

Since: 6.0.0

garrow_sink_node_options_get_reader ()

GArrowRecordBatchReader *
garrow_sink_node_options_get_reader (GArrowSinkNodeOptions *options,
                                     GArrowSchema *schema);

Parameters

options	A GArrowSinkNodeOptions.
schema	A GArrowSchema.

Returns

A GArrowRecordBatchReader to read generated record batches.

[transfer full]

Since: 6.0.0

garrow_hash_join_node_options_new ()

GArrowHashJoinNodeOptions *
garrow_hash_join_node_options_new (GArrowJoinType type,
                                   const gchar **left_keys,
                                   gsize n_left_keys,
                                   const gchar **right_keys,
                                   gsize n_right_keys,
                                   GError **error);

Parameters

type	A GArrowJoinType to be used.
left_keys	Left join keys.	[array length=n_left_keys]
n_left_keys	The number of `left_keys` .
right_keys	Right join keys.	[array length=n_right_keys]
n_right_keys	The number of `right_keys` .
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GArrowHashJoinNodeOptions on success, NULL otherwise.

[nullable]

Since: 7.0.0

garrow_hash_join_node_options_set_left_outputs ()

gboolean
garrow_hash_join_node_options_set_left_outputs
                               (GArrowHashJoinNodeOptions *options,
                                const gchar **outputs,
                                gsize n_outputs,
                                GError **error);

Parameters

options	A GArrowHashJoinNodeOptions.
outputs	Output fields.	[array length=n_outputs]
n_outputs	The number of `outputs` .
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 7.0.0

garrow_hash_join_node_options_set_right_outputs ()

gboolean
garrow_hash_join_node_options_set_right_outputs
                               (GArrowHashJoinNodeOptions *options,
                                const gchar **outputs,
                                gsize n_outputs,
                                GError **error);

Parameters

options	A GArrowHashJoinNodeOptions.
outputs	Output fields.	[array length=n_outputs]
n_outputs	The number of `outputs` .
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 7.0.0

garrow_execute_node_get_kind_name ()

const gchar *
garrow_execute_node_get_kind_name (GArrowExecuteNode *node);

Parameters

node

A GArrowExecuteNode.

Returns

The kind name of the node.

Since: 6.0.0

garrow_execute_node_get_output_schema ()

GArrowSchema *
garrow_execute_node_get_output_schema (GArrowExecuteNode *node);

Parameters

node

A GArrowExecuteNode.

Returns

The output schema of the node.

[transfer full]

Since: 6.0.0

garrow_execute_plan_new ()

GArrowExecutePlan *
garrow_execute_plan_new (GError **error);

Parameters

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowExecutePlan on success, NULL on error.

[nullable]

Since: 6.0.0

garrow_execute_plan_build_node ()

GArrowExecuteNode *
garrow_execute_plan_build_node (GArrowExecutePlan *plan,
                                const gchar *factory_name,
                                GList *inputs,
                                GArrowExecuteNodeOptions *options,
                                GError **error);

Parameters

plan	A GArrowExecutePlan.
factory_name	A factory name to build a GArrowExecuteNode.
inputs	An inputs to execute new node.	[element-type GArrowExecuteNode]
options	A GArrowExecuteNodeOptions for new node.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly built and added GArrowExecuteNode on success, NULL on error.

[transfer full]

Since: 6.0.0

garrow_execute_plan_build_source_node ()

GArrowExecuteNode *
garrow_execute_plan_build_source_node (GArrowExecutePlan *plan,
                                       GArrowSourceNodeOptions *options,
                                       GError **error);

This is a shortcut of garrow_execute_plan_build_node() for source node.

Parameters

plan	A GArrowExecutePlan.
options	A GArrowSourceNodeOptions.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly built and added GArrowExecuteNode for source on success, NULL on error.

[transfer full]

Since: 6.0.0

garrow_execute_plan_build_aggregate_node ()

GArrowExecuteNode *
garrow_execute_plan_build_aggregate_node
                               (GArrowExecutePlan *plan,
                                GArrowExecuteNode *input,
                                GArrowAggregateNodeOptions *options,
                                GError **error);

This is a shortcut of garrow_execute_plan_build_node() for aggregate node.

Parameters

plan	A GArrowExecutePlan.
input	A GArrowExecuteNode.
options	A GArrowAggregateNodeOptions.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly built and added GArrowExecuteNode for aggregation on success, NULL on error.

[transfer full]

Since: 6.0.0

garrow_execute_plan_build_sink_node ()

GArrowExecuteNode *
garrow_execute_plan_build_sink_node (GArrowExecutePlan *plan,
                                     GArrowExecuteNode *input,
                                     GArrowSinkNodeOptions *options,
                                     GError **error);

This is a shortcut of garrow_execute_plan_build_node() for sink node.

Parameters

plan	A GArrowExecutePlan.
input	A GArrowExecuteNode.
options	A GArrowSinkNodeOptions.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly built and added GArrowExecuteNode for sink on success, NULL on error.

[transfer full]

Since: 6.0.0

garrow_execute_plan_build_hash_join_node ()

GArrowExecuteNode *
garrow_execute_plan_build_hash_join_node
                               (GArrowExecutePlan *plan,
                                GArrowExecuteNode *left,
                                GArrowExecuteNode *right,
                                GArrowHashJoinNodeOptions *options,
                                GError **error);

This is a shortcut of garrow_execute_plan_build_node() for hash join node.

Parameters

plan	A GArrowExecutePlan.
left	A left GArrowExecuteNode.
right	A right GArrowExecuteNode.
options	A GArrowHashJoinNodeOptions.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly built and added GArrowExecuteNode for hash join on success, NULL on error.

[transfer full]

Since: 7.0.0

garrow_execute_plan_validate ()

gboolean
garrow_execute_plan_validate (GArrowExecutePlan *plan,
                              GError **error);

Parameters

plan	A GArrowExecutePlan.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

garrow_execute_plan_start ()

gboolean
garrow_execute_plan_start (GArrowExecutePlan *plan,
                           GError **error);

Starts this plan.

Parameters

plan	A GArrowExecutePlan.
error	Return location for a GError or `NULL`.	[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

garrow_execute_plan_stop ()

void
garrow_execute_plan_stop (GArrowExecutePlan *plan);

Stops this plan.

Parameters

plan

A GArrowExecutePlan.

Since: 6.0.0

garrow_execute_plan_wait ()

void
garrow_execute_plan_wait (GArrowExecutePlan *plan);

Waits for finishing this plan.

Parameters

plan

A GArrowExecutePlan.

Since: 6.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_count_options_new ()

GArrowCountOptions *
garrow_count_options_new (void);

Returns

A newly created GArrowCountOptions.

Since: 6.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 *target,
                     GArrowSortOrder order,
                     GError **error);

Parameters

target	A name or dot path for sort target.
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_set_lookup_options_new ()

GArrowSetLookupOptions *
garrow_set_lookup_options_new (GArrowDatum *value_set);

Parameters

value_set

A GArrowArrayDatum or GArrowChunkedArrayDatum to be looked up.

[nullable]

Returns

A newly created GArrowSetLookupOptions.

Since: 6.0.0

garrow_variance_options_new ()

GArrowVarianceOptions *
garrow_variance_options_new (void);

Returns

A newly created GArrowVarianceOptions.

Since: 6.0.0

garrow_round_options_new ()

GArrowRoundOptions *
garrow_round_options_new (void);

Returns

A newly created GArrowRoundOptions.

Since: 7.0.0

garrow_round_to_multiple_options_new ()

GArrowRoundToMultipleOptions *
garrow_round_to_multiple_options_new (void);

Returns

A newly created GArrowRoundToMultipleOptions.

Since: 7.0.0

garrow_utf8_normalize_options_new ()

GArrowUTF8NormalizeOptions *
garrow_utf8_normalize_options_new (void);

Returns

A newly created GArrowUTF8NormalizeOptions.

Since: 8.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,
                    GArrowCountOptions *options,
                    GError **error);

Parameters

array	A GArrowArray.
options	A GArrowCountOptions.	[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())

struct GArrowFunctionOptionsClass

struct GArrowFunctionOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_FUNCTION_DOC

#define GARROW_TYPE_FUNCTION_DOC (garrow_function_doc_get_type())

struct GArrowFunctionDocClass

struct GArrowFunctionDocClass {
  GObjectClass parent_class;
};

GARROW_TYPE_FUNCTION

#define GARROW_TYPE_FUNCTION (garrow_function_get_type())

struct GArrowFunctionClass

struct GArrowFunctionClass {
  GObjectClass parent_class;
};

GARROW_TYPE_EXECUTE_NODE_OPTIONS

#define GARROW_TYPE_EXECUTE_NODE_OPTIONS (garrow_execute_node_options_get_type())

struct GArrowExecuteNodeOptionsClass

struct GArrowExecuteNodeOptionsClass {
  GObjectClass parent_class;
};

GARROW_TYPE_SOURCE_NODE_OPTIONS

#define GARROW_TYPE_SOURCE_NODE_OPTIONS (garrow_source_node_options_get_type())

struct GArrowSourceNodeOptionsClass

struct GArrowSourceNodeOptionsClass {
  GArrowExecuteNodeOptionsClass parent_class;
};

GARROW_TYPE_AGGREGATION

#define GARROW_TYPE_AGGREGATION (garrow_aggregation_get_type())

struct GArrowAggregationClass

struct GArrowAggregationClass {
  GObjectClass parent_class;
};

GARROW_TYPE_AGGREGATE_NODE_OPTIONS

#define             GARROW_TYPE_AGGREGATE_NODE_OPTIONS

struct GArrowAggregateNodeOptionsClass

struct GArrowAggregateNodeOptionsClass {
  GArrowExecuteNodeOptionsClass parent_class;
};

GARROW_TYPE_SINK_NODE_OPTIONS

#define GARROW_TYPE_SINK_NODE_OPTIONS (garrow_sink_node_options_get_type())

struct GArrowSinkNodeOptionsClass

struct GArrowSinkNodeOptionsClass {
  GArrowExecuteNodeOptionsClass parent_class;
};

enum GArrowJoinType

They correspond to the values of arrow::compute::JoinType.

Members

GARROW_JOIN_TYPE_LEFT_SEMI
GARROW_JOIN_TYPE_RIGHT_SEMI
GARROW_JOIN_TYPE_LEFT_ANTI
GARROW_JOIN_TYPE_RIGHT_ANTI
GARROW_JOIN_TYPE_INNER
GARROW_JOIN_TYPE_LEFT_OUTER
GARROW_JOIN_TYPE_RIGHT_OUTER
GARROW_JOIN_TYPE_FULL_OUTER

Since: 7.0.0

GARROW_TYPE_HASH_JOIN_NODE_OPTIONS

#define             GARROW_TYPE_HASH_JOIN_NODE_OPTIONS

struct GArrowHashJoinNodeOptionsClass

struct GArrowHashJoinNodeOptionsClass {
  GArrowExecuteNodeOptionsClass parent_class;
};

GARROW_TYPE_EXECUTE_NODE

#define GARROW_TYPE_EXECUTE_NODE (garrow_execute_node_get_type())

struct GArrowExecuteNodeClass

struct GArrowExecuteNodeClass {
  GObjectClass parent_class;
};

GARROW_TYPE_EXECUTE_PLAN

#define GARROW_TYPE_EXECUTE_PLAN (garrow_execute_plan_get_type())

struct GArrowExecutePlanClass

struct GArrowExecutePlanClass {
  GObjectClass parent_class;
};

GARROW_TYPE_CAST_OPTIONS

#define GARROW_TYPE_CAST_OPTIONS (garrow_cast_options_get_type())

struct GArrowCastOptionsClass

struct GArrowCastOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS

#define             GARROW_TYPE_SCALAR_AGGREGATE_OPTIONS

struct GArrowScalarAggregateOptionsClass

struct GArrowScalarAggregateOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

enum GArrowCountMode

They correspond to the values of arrow::compute::CountOptions::CountMode.

Members

GARROW_COUNT_MODE_ONLY_VALID	Only non-null values will be counted.
GARROW_COUNT_MODE_ONLY_NULL	Only null values will be counted.
GARROW_COUNT_MODE_ALL	All will be counted.

GARROW_TYPE_COUNT_OPTIONS

#define GARROW_TYPE_COUNT_OPTIONS (garrow_count_options_get_type())

struct GArrowCountOptionsClass

struct GArrowCountOptionsClass {
  GArrowFunctionOptionsClass 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 {
  GArrowFunctionOptionsClass parent_class;
};

GARROW_TYPE_TAKE_OPTIONS

#define GARROW_TYPE_TAKE_OPTIONS (garrow_take_options_get_type())

struct GArrowTakeOptionsClass

struct GArrowTakeOptionsClass {
  GArrowFunctionOptionsClass 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 {
  GArrowFunctionOptionsClass 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 {
  GArrowFunctionOptionsClass parent_class;
};

GARROW_TYPE_SET_LOOKUP_OPTIONS

#define GARROW_TYPE_SET_LOOKUP_OPTIONS (garrow_set_lookup_options_get_type())

struct GArrowSetLookupOptionsClass

struct GArrowSetLookupOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

GARROW_TYPE_VARIANCE_OPTIONS

#define GARROW_TYPE_VARIANCE_OPTIONS (garrow_variance_options_get_type())

struct GArrowVarianceOptionsClass

struct GArrowVarianceOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

enum GArrowRoundMode

They correspond to the values of arrow::compute::RoundMode.

Members

GARROW_ROUND_DOWN
GARROW_ROUND_UP
GARROW_ROUND_TOWARDS_ZERO	Get the integral part without fractional digits (aka "trunc") `GARROW_ROUND_TOWARDS_INFINITY` , Round negative values with `GARROW_ROUND_MODE_DOWN` rule and positive values with UP rule (aka "away from zero") `GARROW_ROUND_HALF_DOWN` , Round ties with `GARROW_ROUND_MODE_DOWN` rule (also called "round half towards negative infinity") `GARROW_ROUND_HALF_UP` , Round ties with `GARROW_ROUND_MODE_UP` rule (also called "round half towards positive infinity") `GARROW_ROUND_HALF_TOWARDS_ZERO` , Round ties with GARROW_ROUND_MODE_TOWARDS_ZERO rule (also called "round half away from infinity") `GARROW_ROUND_HALF_TOWARDS_INFINITY` , Round ties with GARROW_ROUND_MODE_TOWARDS_INFINITY rule (also called "round half away from zero") `GARROW_ROUND_HALF_TO_EVEN` , Round ties to nearest even integer `GARROW_ROUND_HALF_TO_ODD` , Round ties to nearest odd integer
GARROW_ROUND_TOWARDS_INFINITY
GARROW_ROUND_HALF_DOWN
GARROW_ROUND_HALF_UP
GARROW_ROUND_HALF_TOWARDS_ZERO
GARROW_ROUND_HALF_TOWARDS_INFINITY
GARROW_ROUND_HALF_TO_EVEN
GARROW_ROUND_HALF_TO_ODD

Since: 7.0.0

GARROW_TYPE_ROUND_OPTIONS

#define GARROW_TYPE_ROUND_OPTIONS (garrow_round_options_get_type())

struct GArrowRoundOptionsClass

struct GArrowRoundOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

GARROW_TYPE_ROUND_TO_MULTIPLE_OPTIONS

#define             GARROW_TYPE_ROUND_TO_MULTIPLE_OPTIONS

struct GArrowRoundToMultipleOptionsClass

struct GArrowRoundToMultipleOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

enum GArrowUTF8NormalizeForm

They correspond to the values of arrow::compute::Utf8NormalizeOptions::Form.

Members

GARROW_UTF8_NORMALIZE_FORM_NFC	Normalization Form Canonical Composition.
GARROW_UTF8_NORMALIZE_FORM_NFKC	Normalization Form Compatibility Composition.
GARROW_UTF8_NORMALIZE_FORM_NFD	Normalization Form Canonical Decomposition.
GARROW_UTF8_NORMALIZE_FORM_NFKD	Normalization Form Compatibility Decomposition.

Since: 8.0.0

GARROW_TYPE_UTF8_NORMALIZE_OPTIONS

#define             GARROW_TYPE_UTF8_NORMALIZE_OPTIONS

struct GArrowUTF8NormalizeOptionsClass

struct GArrowUTF8NormalizeOptionsClass {
  GArrowFunctionOptionsClass parent_class;
};

GArrowAggregateNodeOptions

typedef struct _GArrowAggregateNodeOptions GArrowAggregateNodeOptions;

GArrowAggregation

typedef struct _GArrowAggregation GArrowAggregation;

GArrowArraySortOptions

typedef struct _GArrowArraySortOptions GArrowArraySortOptions;

GArrowCastOptions

typedef struct _GArrowCastOptions GArrowCastOptions;

GArrowCountOptions

typedef struct _GArrowCountOptions GArrowCountOptions;

GArrowExecuteContext

typedef struct _GArrowExecuteContext GArrowExecuteContext;

GArrowExecuteNode

typedef struct _GArrowExecuteNode GArrowExecuteNode;

GArrowExecuteNodeOptions

typedef struct _GArrowExecuteNodeOptions GArrowExecuteNodeOptions;

GArrowExecutePlan

typedef struct _GArrowExecutePlan GArrowExecutePlan;

GArrowFilterOptions

typedef struct _GArrowFilterOptions GArrowFilterOptions;

GArrowFunction

typedef struct _GArrowFunction GArrowFunction;

GArrowFunctionDoc

typedef struct _GArrowFunctionDoc GArrowFunctionDoc;

GArrowFunctionOptions

typedef struct _GArrowFunctionOptions GArrowFunctionOptions;

GArrowHashJoinNodeOptions

typedef struct _GArrowHashJoinNodeOptions GArrowHashJoinNodeOptions;

GArrowRoundOptions

typedef struct _GArrowRoundOptions GArrowRoundOptions;

GArrowRoundToMultipleOptions

typedef struct _GArrowRoundToMultipleOptions GArrowRoundToMultipleOptions;

GArrowScalarAggregateOptions

typedef struct _GArrowScalarAggregateOptions GArrowScalarAggregateOptions;

GArrowSetLookupOptions

typedef struct _GArrowSetLookupOptions GArrowSetLookupOptions;

GArrowSinkNodeOptions

typedef struct _GArrowSinkNodeOptions GArrowSinkNodeOptions;

GArrowSortKey

typedef struct _GArrowSortKey GArrowSortKey;

GArrowSortOptions

typedef struct _GArrowSortOptions GArrowSortOptions;

GArrowSourceNodeOptions

typedef struct _GArrowSourceNodeOptions GArrowSourceNodeOptions;

GArrowTakeOptions

typedef struct _GArrowTakeOptions GArrowTakeOptions;

GArrowUTF8NormalizeOptions

typedef struct _GArrowUTF8NormalizeOptions GArrowUTF8NormalizeOptions;

GArrowVarianceOptions

typedef struct _GArrowVarianceOptions GArrowVarianceOptions;

Property Details

The `“function”` property

  “function”                 gchar *

The function name to aggregate.

Owner: GArrowAggregation

Flags: Read / Write / Construct Only

Default value: NULL

Since: 6.0.0

The `“input”` property

  “input”                    gchar *

The input field name of aggregate function.

Owner: GArrowAggregation

Flags: Read / Write / Construct Only

Default value: NULL

Since: 6.0.0

The `“options”` property

  “options”                  GArrowFunctionOptions *

The options of aggregate function.

Owner: GArrowAggregation

Flags: Read / Write / Construct Only

Since: 6.0.0

The `“output”` property

  “output”                   gchar *

The output field name of aggregate function.

Owner: GArrowAggregation

Flags: Read / Write / Construct Only

Default value: NULL

Since: 6.0.0

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 `“mode”` property

  “mode”                     GArrowCountMode

Which values to count.

Owner: GArrowCountOptions

Flags: Read / Write

Default value: GARROW_COUNT_MODE_ONLY_VALID

The `“node”` property

  “node”                     gpointer

The raw arrow::compute::ExecNode *.

Owner: GArrowExecuteNode

Flags: Write / Construct Only

The `“options”` property

  “options”                  gpointer

The raw arrow::compute::ExecNodeOptions *.

Owner: GArrowExecuteNodeOptions

Flags: Write / Construct Only

The `“plan”` property

  “plan”                     gpointer

The raw std::shared_ptr<arrow::compute::ExecPlan>.

Owner: GArrowExecutePlan

Flags: Write / Construct Only

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 `“doc”` property

  “doc”                      gpointer

The raw arrow::compute::FunctionDoc *.

Owner: GArrowFunctionDoc

Flags: Write / Construct Only

The `“mode”` property

  “mode”                     GArrowRoundMode

The rounding and tie-breaking mode.

Owner: GArrowRoundOptions

Flags: Read / Write

Default value: GARROW_ROUND_HALF_TO_EVEN

Since: 7.0.0

The `“n-digits”` property

  “n-digits”                 gint64

The rounding precision (number of digits to round to).

Owner: GArrowRoundOptions

Flags: Read / Write

Default value: 0

Since: 7.0.0

The `“mode”` property

  “mode”                     GArrowRoundMode

The rounding and tie-breaking mode.

Owner: GArrowRoundToMultipleOptions

Flags: Read / Write

Default value: GARROW_ROUND_HALF_TO_EVEN

Since: 7.0.0

The `“multiple”` property

  “multiple”                 GArrowScalar *

The rounding scale (multiple to round to).

Should be a scalar of a type compatible with the argument to be rounded. For example, rounding a decimal value means a decimal multiple is required. Rounding a floating point or integer value means a floating point scalar is required.

Owner: GArrowRoundToMultipleOptions

Flags: Read / Write

Since: 7.0.0

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 `“skip-nulls”` property

  “skip-nulls”               gboolean

Whether NULLs are skipped or not.

Owner: GArrowSetLookupOptions

Flags: Read / Write

Default value: FALSE

Since: 6.0.0

The `“value-set”` property

  “value-set”                GArrowDatum *

The set of values to look up input values into.

Owner: GArrowSetLookupOptions

Flags: Read / Write

Since: 6.0.0

The `“order”` property

  “order”                    GArrowSortOrder

How to order values.

Owner: GArrowSortKey

Flags: Read / Write / Construct Only

Default value: GARROW_SORT_ORDER_ASCENDING

Since: 3.0.0

The `“target”` property

  “target”                   gchar *

A name or dot path for the sort target.

dot_path = '.' name | '[' digit+ ']' | dot_path+

Owner: GArrowSortKey

Flags: Read

Default value: NULL

Since: 7.0.0

The `“reader”` property

  “reader”                   GArrowRecordBatchReader *

The GArrowRecordBatchReader that produces record batches.

Owner: GArrowSourceNodeOptions

Flags: Write / Construct Only

The `“record-batch”` property

  “record-batch”             GArrowRecordBatch *

The GArrowRecordBatch to be produced.

Owner: GArrowSourceNodeOptions

Flags: Write / Construct Only

The `“form”` property

  “form”                     GArrowUTF8NormalizeForm

The Unicode normalization form to apply.

Owner: GArrowUTF8NormalizeOptions

Flags: Read / Write

Default value: GARROW_UTF8_NORMALIZE_FORM_NFC

Since: 8.0.0

The `“ddof”` property

  “ddof”                     gint

The Delta Degrees of Freedom (ddof) to be used.

Owner: GArrowVarianceOptions

Flags: Read / Write

Default value: 0

Since: 6.0.0

The `“min-count”` property

  “min-count”                guint

If less than this many non-null values are observed, emit null.

Owner: GArrowVarianceOptions

Flags: Read / Write

Default value: 0

Since: 6.0.0

The `“skip-nulls”` property

  “skip-nulls”               gboolean

Whether NULLs are skipped or not.

Owner: GArrowVarianceOptions

Flags: Read / Write

Default value: TRUE

Since: 6.0.0