Top |
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 |
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 |
GArrowQuantileInterpolation | interpolation | Read / Write |
guint | min-count | Read / Write |
gboolean | skip-nulls | Read / Write |
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 |
GEnum ├── GArrowCountMode ├── GArrowFilterNullSelectionBehavior ├── GArrowJoinType ├── GArrowQuantileInterpolation ├── GArrowRoundMode ├── GArrowSortOrder ╰── GArrowUTF8NormalizeForm GObject ├── GArrowExecuteContext ├── GArrowExecuteNode ├── GArrowExecutePlan ├── GArrowFunction ├── GArrowFunctionDoc ├── GArrowFunctionOptions │ ├── GArrowArraySortOptions │ ├── GArrowCountOptions │ ├── GArrowFilterOptions │ ├── GArrowQuantileOptions │ ├── GArrowRoundOptions │ ├── GArrowRoundToMultipleOptions │ ├── GArrowScalarAggregateOptions │ ├── GArrowSetLookupOptions │ ├── GArrowSortOptions │ ├── GArrowTakeOptions │ ├── GArrowUTF8NormalizeOptions │ ╰── GArrowVarianceOptions ├── GArrowAggregation ├── GArrowExecuteNodeOptions │ ├── GArrowAggregateNodeOptions │ ├── GArrowHashJoinNodeOptions │ ├── GArrowSinkNodeOptions │ ├── GArrowSourceNodeOptions │ ╰── GArrowAggregateNodeOptions ╰── GArrowSortKey
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.
GArrowExecuteContext *
garrow_execute_context_new (void
);
Since: 1.0.0
gboolean garrow_function_options_equal (GArrowFunctionOptions *options
,GArrowFunctionOptions *other_options
);
options |
A GArrowFunctionOptions. |
|
other_options |
A GArrowFunctionOptions to be compared. |
[nullable] |
Since: 7.0.0
gchar *
garrow_function_options_to_string (GArrowFunctionOptions *options
);
Since: 7.0.0
gchar *
garrow_function_doc_get_summary (GArrowFunctionDoc *doc
);
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
gchar *
garrow_function_doc_get_description (GArrowFunctionDoc *doc
);
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
gchar **
garrow_function_doc_get_arg_names (GArrowFunctionDoc *doc
);
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
gchar *
garrow_function_doc_get_options_class_name
(GArrowFunctionDoc *doc
);
Since: 6.0.0
GList *
garrow_function_all (void
);
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
GArrowDatum * garrow_function_execute (GArrowFunction *function
,GList *args
,GArrowFunctionOptions *options
,GArrowExecuteContext *context
,GError **error
);
function |
||
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 |
[nullable] |
A return value of the execution as GArrowDatum on success, NULL
on error.
[nullable][transfer full]
Since: 1.0.0
const gchar *
garrow_function_get_name (GArrowFunction *function
);
Since: 7.0.0
GArrowFunctionDoc *
garrow_function_get_doc (GArrowFunction *function
);
Since: 6.0.0
GArrowFunctionOptions *
garrow_function_get_default_options (GArrowFunction *function
);
Since: 7.0.0
GType
garrow_function_get_options_type (GArrowFunction *function
);
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
gboolean garrow_function_equal (GArrowFunction *function
,GArrowFunction *other_function
);
Since: 7.0.0
gchar *
garrow_function_to_string (GArrowFunction *function
);
Since: 7.0.0
GArrowSourceNodeOptions *
garrow_source_node_options_new_record_batch_reader
(GArrowRecordBatchReader *reader
);
Since: 6.0.0
GArrowSourceNodeOptions *
garrow_source_node_options_new_record_batch
(GArrowRecordBatch *record_batch
);
Since: 6.0.0
GArrowSourceNodeOptions *
garrow_source_node_options_new_table (GArrowTable *table
);
Since: 6.0.0
GArrowAggregation * garrow_aggregation_new (const gchar *function
,GArrowFunctionOptions *options
,const gchar *input
,const gchar *output
);
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. |
Since: 6.0.0
GArrowAggregateNodeOptions * garrow_aggregate_node_options_new (GList *aggregations
,const gchar **keys
,gsize n_keys
,GError **error
);
aggregations |
A list of GArrowAggregation. |
[element-type GArrowAggregation] |
keys |
Group keys. |
[nullable][array length=n_keys] |
n_keys |
The number of |
|
error |
[nullable] |
Since: 6.0.0
GArrowSinkNodeOptions *
garrow_sink_node_options_new (void
);
Since: 6.0.0
GArrowRecordBatchReader * garrow_sink_node_options_get_reader (GArrowSinkNodeOptions *options
,GArrowSchema *schema
);
Since: 6.0.0
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
);
type |
A GArrowJoinType to be used. |
|
left_keys |
Left join keys. |
[array length=n_left_keys] |
n_left_keys |
The number of |
|
right_keys |
Right join keys. |
[array length=n_right_keys] |
n_right_keys |
The number of |
|
error |
[nullable] |
Since: 7.0.0
gboolean garrow_hash_join_node_options_set_left_outputs (GArrowHashJoinNodeOptions *options
,const gchar **outputs
,gsize n_outputs
,GError **error
);
options |
||
outputs |
Output fields. |
[array length=n_outputs] |
n_outputs |
The number of |
|
error |
[nullable] |
Since: 7.0.0
gboolean garrow_hash_join_node_options_set_right_outputs (GArrowHashJoinNodeOptions *options
,const gchar **outputs
,gsize n_outputs
,GError **error
);
options |
||
outputs |
Output fields. |
[array length=n_outputs] |
n_outputs |
The number of |
|
error |
[nullable] |
Since: 7.0.0
const gchar *
garrow_execute_node_get_kind_name (GArrowExecuteNode *node
);
Since: 6.0.0
GArrowSchema *
garrow_execute_node_get_output_schema (GArrowExecuteNode *node
);
Since: 6.0.0
GArrowExecutePlan *
garrow_execute_plan_new (GError **error
);
Since: 6.0.0
GArrowExecuteNode * garrow_execute_plan_build_node (GArrowExecutePlan *plan
,const gchar *factory_name
,GList *inputs
,GArrowExecuteNodeOptions *options
,GError **error
);
plan |
||
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 |
[nullable] |
Since: 6.0.0
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.
A newly built and added GArrowExecuteNode
for source on success, NULL
on error.
[transfer full]
Since: 6.0.0
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.
A newly built and added GArrowExecuteNode
for aggregation on success, NULL
on error.
[transfer full]
Since: 6.0.0
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.
A newly built and added GArrowExecuteNode
for sink on success, NULL
on error.
[transfer full]
Since: 6.0.0
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.
plan |
||
left |
A left GArrowExecuteNode. |
|
right |
A right GArrowExecuteNode. |
|
options |
||
error |
[nullable] |
A newly built and added GArrowExecuteNode
for hash join on success, NULL
on error.
[transfer full]
Since: 7.0.0
gboolean garrow_execute_plan_validate (GArrowExecutePlan *plan
,GError **error
);
Since: 6.0.0
gboolean garrow_execute_plan_start (GArrowExecutePlan *plan
,GError **error
);
Starts this plan.
Since: 6.0.0
void
garrow_execute_plan_stop (GArrowExecutePlan *plan
);
Stops this plan.
Since: 6.0.0
void
garrow_execute_plan_wait (GArrowExecutePlan *plan
);
Waits for finishing this plan.
Since: 6.0.0
GArrowScalarAggregateOptions *
garrow_scalar_aggregate_options_new (void
);
Since: 5.0.0
GArrowArraySortOptions *
garrow_array_sort_options_new (GArrowSortOrder order
);
Since: 3.0.0
gboolean garrow_array_sort_options_equal (GArrowArraySortOptions *options
,GArrowArraySortOptions *other_options
);
Since: 3.0.0
GArrowSortKey * garrow_sort_key_new (const gchar *target
,GArrowSortOrder order
,GError **error
);
Since: 3.0.0
gboolean garrow_sort_key_equal (GArrowSortKey *sort_key
,GArrowSortKey *other_sort_key
);
Since: 3.0.0
GArrowSortOptions *
garrow_sort_options_new (GList *sort_keys
);
Since: 3.0.0
gboolean garrow_sort_options_equal (GArrowSortOptions *options
,GArrowSortOptions *other_options
);
Since: 3.0.0
GList *
garrow_sort_options_get_sort_keys (GArrowSortOptions *options
);
Since: 3.0.0
void garrow_sort_options_set_sort_keys (GArrowSortOptions *options
,GList *sort_keys
);
Set sort keys to be used.
Since: 3.0.0
void garrow_sort_options_add_sort_key (GArrowSortOptions *options
,GArrowSortKey *sort_key
);
Add a sort key to be used.
Since: 3.0.0
GArrowSetLookupOptions *
garrow_set_lookup_options_new (GArrowDatum *value_set
);
Since: 6.0.0
GArrowVarianceOptions *
garrow_variance_options_new (void
);
Since: 6.0.0
GArrowRoundToMultipleOptions *
garrow_round_to_multiple_options_new (void
);
Since: 7.0.0
GArrowUTF8NormalizeOptions *
garrow_utf8_normalize_options_new (void
);
Since: 8.0.0
GArrowQuantileOptions *
garrow_quantile_options_new (void
);
Since: 9.0.0
const gdouble * garrow_quantile_options_get_qs (GArrowQuantileOptions *options
,gsize *n
);
Since: 9.0.0
void garrow_quantile_options_set_q (GArrowQuantileOptions *options
,gdouble q
);
Since: 9.0.0
void garrow_quantile_options_set_qs (GArrowQuantileOptions *options
,const gdouble *qs
,gsize n
);
Since: 9.0.0
GArrowArray * garrow_array_cast (GArrowArray *array
,GArrowDataType *target_data_type
,GArrowCastOptions *options
,GError **error
);
array |
A GArrowArray. |
|
target_data_type |
A GArrowDataType of cast target data. |
|
options |
A GArrowCastOptions. |
[nullable] |
error |
[nullable] |
Since: 0.7.0
GArrowArray * garrow_array_unique (GArrowArray *array
,GError **error
);
Since: 0.8.0
GArrowDictionaryArray * garrow_array_dictionary_encode (GArrowArray *array
,GError **error
);
A newly created GArrowDictionaryArray for the array
on success,
NULL
on error.
[nullable][transfer full]
Since: 0.8.0
gint64 garrow_array_count (GArrowArray *array
,GArrowCountOptions *options
,GError **error
);
The number of target values on success. If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
GArrowStructArray * garrow_array_count_values (GArrowArray *array
,GError **error
);
A GArrowStructArray of {input type "values", int64_t "counts"}
on success, NULL
on error.
[nullable][transfer full]
Since: 0.13.0
GArrowBooleanArray * garrow_boolean_array_invert (GArrowBooleanArray *array
,GError **error
);
The element-wise inverted boolean array.
It should be freed with g_object_unref()
when no longer needed.
[transfer full]
Since: 0.13.0
GArrowBooleanArray * garrow_boolean_array_and (GArrowBooleanArray *left
,GArrowBooleanArray *right
,GError **error
);
left |
A left hand side GArrowBooleanArray. |
|
right |
A right hand side GArrowBooleanArray. |
|
error |
[nullable] |
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
GArrowBooleanArray * garrow_boolean_array_or (GArrowBooleanArray *left
,GArrowBooleanArray *right
,GError **error
);
left |
A left hand side GArrowBooleanArray. |
|
right |
A right hand side GArrowBooleanArray. |
|
error |
[nullable] |
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
GArrowBooleanArray * garrow_boolean_array_xor (GArrowBooleanArray *left
,GArrowBooleanArray *right
,GError **error
);
left |
A left hand side GArrowBooleanArray. |
|
right |
A right hand side GArrowBooleanArray. |
|
error |
[nullable] |
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
gdouble garrow_numeric_array_mean (GArrowNumericArray *array
,GError **error
);
Since: 0.13.0
gint64 garrow_int8_array_sum (GArrowInt8Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
guint64 garrow_uint8_array_sum (GArrowUInt8Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
gint64 garrow_int16_array_sum (GArrowInt16Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
guint64 garrow_uint16_array_sum (GArrowUInt16Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
gint64 garrow_int32_array_sum (GArrowInt32Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
guint64 garrow_uint32_array_sum (GArrowUInt32Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
gint64 garrow_int64_array_sum (GArrowInt64Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
guint64 garrow_uint64_array_sum (GArrowUInt64Array *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
gdouble garrow_float_array_sum (GArrowFloatArray *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
gdouble garrow_double_array_sum (GArrowDoubleArray *array
,GError **error
);
The value of the computed sum on success, If an error is occurred, the returned value is untrustful value.
Since: 0.13.0
GArrowArray * garrow_array_take (GArrowArray *array
,GArrowArray *indices
,GArrowTakeOptions *options
,GError **error
);
array |
A GArrowArray. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowArray taken from
an array of values at indices in input array or NULL
on error.
[nullable][transfer full]
Since: 0.14.0
GArrowChunkedArray * garrow_array_take_chunked_array (GArrowArray *array
,GArrowChunkedArray *indices
,GArrowTakeOptions *options
,GError **error
);
array |
A GArrowArray. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowChunkedArray taken from
an array of values at indices in chunked array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowTable * garrow_table_take (GArrowTable *table
,GArrowArray *indices
,GArrowTakeOptions *options
,GError **error
);
table |
A GArrowTable. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowTable taken from
an array of values at indices in input array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowTable * garrow_table_take_chunked_array (GArrowTable *table
,GArrowChunkedArray *indices
,GArrowTakeOptions *options
,GError **error
);
table |
A GArrowTable. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowTable taken from
an array of values at indices in chunked array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowChunkedArray * garrow_chunked_array_take (GArrowChunkedArray *chunked_array
,GArrowArray *indices
,GArrowTakeOptions *options
,GError **error
);
chunked_array |
A GArrowChunkedArray. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowChunkedArray taken from
an array of values at indices in input array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowChunkedArray * garrow_chunked_array_take_chunked_array (GArrowChunkedArray *chunked_array
,GArrowChunkedArray *indices
,GArrowTakeOptions *options
,GError **error
);
chunked_array |
A GArrowChunkedArray. |
|
indices |
The indices of values to take. |
|
options |
[nullable] | |
error |
[nullable] |
The GArrowChunkedArray taken from
an array of values at indices in chunked array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowRecordBatch * garrow_record_batch_take (GArrowRecordBatch *record_batch
,GArrowArray *indices
,GArrowTakeOptions *options
,GError **error
);
The GArrowChunkedArray taken from
an array of values at indices in input array or NULL
on error.
[nullable][transfer full]
Since: 0.16.0
GArrowArray * garrow_array_filter (GArrowArray *array
,GArrowBooleanArray *filter
,GArrowFilterOptions *options
,GError **error
);
array |
A GArrowArray. |
|
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
GArrowBooleanArray * garrow_array_is_in (GArrowArray *left
,GArrowArray *right
,GError **error
);
The GArrowBooleanArray showing whether each element in the left array is contained in right array.
[nullable][transfer full]
Since: 0.15.0
GArrowBooleanArray * garrow_array_is_in_chunked_array (GArrowArray *left
,GArrowChunkedArray *right
,GError **error
);
The GArrowBooleanArray showing whether each element in the left array is contained in right chunked array.
[nullable][transfer full]
Since: 0.15.0
GArrowUInt64Array * garrow_array_sort_indices (GArrowArray *array
,GArrowSortOrder order
,GError **error
);
The indices that would sort
an array in the specified order on success, NULL
on error.
[nullable][transfer full]
Since: 3.0.0
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.
The indices that would sort
an array in ascending order on success, NULL
on error.
[nullable][transfer full]
Since: 0.15.0
GArrowUInt64Array * garrow_chunked_array_sort_indices (GArrowChunkedArray *chunked_array
,GArrowSortOrder order
,GError **error
);
The indices that would sort
a chunked array in the specified order on success, NULL
on error.
[nullable][transfer full]
Since: 3.0.0
GArrowUInt64Array * garrow_record_batch_sort_indices (GArrowRecordBatch *record_batch
,GArrowSortOptions *options
,GError **error
);
The indices that would sort
a record batch with the specified options on success, NULL
on error.
[nullable][transfer full]
Since: 3.0.0
GArrowUInt64Array * garrow_table_sort_indices (GArrowTable *table
,GArrowSortOptions *options
,GError **error
);
The indices that would sort
a table with the specified options on success, NULL
on error.
[nullable][transfer full]
Since: 3.0.0
GArrowTable * garrow_table_filter (GArrowTable *table
,GArrowBooleanArray *filter
,GArrowFilterOptions *options
,GError **error
);
table |
A GArrowTable. |
|
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
GArrowTable * garrow_table_filter_chunked_array (GArrowTable *table
,GArrowChunkedArray *filter
,GArrowFilterOptions *options
,GError **error
);
table |
A GArrowTable. |
|
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
GArrowChunkedArray * garrow_chunked_array_filter (GArrowChunkedArray *chunked_array
,GArrowBooleanArray *filter
,GArrowFilterOptions *options
,GError **error
);
chunked_array |
A GArrowChunkedArray. |
|
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
GArrowChunkedArray * garrow_chunked_array_filter_chunked_array (GArrowChunkedArray *chunked_array
,GArrowChunkedArray *filter
,GArrowFilterOptions *options
,GError **error
);
chunked_array |
A GArrowChunkedArray. |
|
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
GArrowRecordBatch * garrow_record_batch_filter (GArrowRecordBatch *record_batch
,GArrowBooleanArray *filter
,GArrowFilterOptions *options
,GError **error
);
record_batch |
||
filter |
The values indicates which values should be filtered out. |
|
options |
[nullable] | |
error |
[nullable] |
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
#define GARROW_TYPE_EXECUTE_NODE_OPTIONS (garrow_execute_node_options_get_type())
struct GArrowExecuteNodeOptionsClass { GObjectClass parent_class; };
#define GARROW_TYPE_SOURCE_NODE_OPTIONS (garrow_source_node_options_get_type())
struct GArrowSourceNodeOptionsClass { GArrowExecuteNodeOptionsClass parent_class; };
struct GArrowAggregateNodeOptionsClass { GArrowExecuteNodeOptionsClass parent_class; };
#define GARROW_TYPE_SINK_NODE_OPTIONS (garrow_sink_node_options_get_type())
struct GArrowSinkNodeOptionsClass { GArrowExecuteNodeOptionsClass parent_class; };
struct GArrowHashJoinNodeOptionsClass { GArrowExecuteNodeOptionsClass parent_class; };
struct GArrowScalarAggregateOptionsClass { GArrowFunctionOptionsClass parent_class; };
struct GArrowCountOptionsClass { GArrowFunctionOptionsClass parent_class; };
They are corresponding to
arrow::compute::FilterOptions::NullSelectionBehavior
values.
struct GArrowFilterOptionsClass { GArrowFunctionOptionsClass parent_class; };
struct GArrowTakeOptionsClass { GArrowFunctionOptionsClass parent_class; };
They are corresponding to arrow::compute::SortOrder
values.
Since: 3.0.0
#define GARROW_TYPE_ARRAY_SORT_OPTIONS (garrow_array_sort_options_get_type())
struct GArrowArraySortOptionsClass { GArrowFunctionOptionsClass parent_class; };
struct GArrowSortOptionsClass { GArrowFunctionOptionsClass parent_class; };
#define GARROW_TYPE_SET_LOOKUP_OPTIONS (garrow_set_lookup_options_get_type())
struct GArrowSetLookupOptionsClass { GArrowFunctionOptionsClass parent_class; };
#define GARROW_TYPE_VARIANCE_OPTIONS (garrow_variance_options_get_type())
struct GArrowVarianceOptionsClass { GArrowFunctionOptionsClass parent_class; };
They correspond to the values of arrow::compute::RoundMode
.
Get the integral part without fractional digits (aka "trunc")
|
||
Since: 7.0.0
struct GArrowRoundOptionsClass { GArrowFunctionOptionsClass parent_class; };
struct GArrowRoundToMultipleOptionsClass { GArrowFunctionOptionsClass parent_class; };
They correspond to the values of arrow::compute::Utf8NormalizeOptions::Form
.
Normalization Form Canonical Composition. |
||
Normalization Form Compatibility Composition. |
||
Normalization Form Canonical Decomposition. |
||
Normalization Form Compatibility Decomposition. |
Since: 8.0.0
struct GArrowUTF8NormalizeOptionsClass { GArrowFunctionOptionsClass parent_class; };
They correspond to the values of
arrow::compute::QuantileOptions::Interpolation
.
Since: 9.0.0
struct GArrowQuantileOptionsClass { GArrowFunctionOptionsClass parent_class; };
typedef struct _GArrowRoundToMultipleOptions GArrowRoundToMultipleOptions;
typedef struct _GArrowScalarAggregateOptions GArrowScalarAggregateOptions;
“function”
property“function” gchar *
The function name to aggregate.
Owner: GArrowAggregation
Flags: Read / Write / Construct Only
Default value: NULL
Since: 6.0.0
“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
“options”
property “options” GArrowFunctionOptions *
The options of aggregate function.
Owner: GArrowAggregation
Flags: Read / Write / Construct Only
Since: 6.0.0
“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
“order”
property“order” GArrowSortOrder
How to order values.
Owner: GArrowArraySortOptions
Flags: Read / Write
Default value: GARROW_SORT_ORDER_ASCENDING
Since: 3.0.0
“mode”
property“mode” GArrowCountMode
Which values to count.
Owner: GArrowCountOptions
Flags: Read / Write
Default value: GARROW_COUNT_MODE_ONLY_VALID
“node”
property“node” gpointer
The raw arrow::compute::ExecNode *.
Owner: GArrowExecuteNode
Flags: Write / Construct Only
“options”
property“options” gpointer
The raw arrow::compute::ExecNodeOptions *.
Owner: GArrowExecuteNodeOptions
Flags: Write / Construct Only
“plan”
property“plan” gpointer
The raw std::shared_ptr<arrow::compute::ExecPlan>.
Owner: GArrowExecutePlan
Flags: Write / Construct Only
“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
“function”
property“function” gpointer
The raw std::shared<arrow::compute::Function> *.
Owner: GArrowFunction
Flags: Write / Construct Only
“doc”
property“doc” gpointer
The raw arrow::compute::FunctionDoc *.
Owner: GArrowFunctionDoc
Flags: Write / Construct Only
“interpolation”
property“interpolation” GArrowQuantileInterpolation
Interpolation method to use when quantile lies between two data points.
Owner: GArrowQuantileOptions
Flags: Read / Write
Default value: GARROW_QUANTILE_INTERPOLATION_LINEAR
Since: 9.0.0
“min-count”
property“min-count” guint
If less than this many non-null values are observed, emit null.
Owner: GArrowQuantileOptions
Flags: Read / Write
Default value: 0
Since: 9.0.0
“skip-nulls”
property“skip-nulls” gboolean
If true (the default), null values are ignored. Otherwise, if any value is null, emit null.
Owner: GArrowQuantileOptions
Flags: Read / Write
Default value: TRUE
Since: 9.0.0
“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
“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
“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
“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
“min-count”
property“min-count” guint
The minimum required number of values.
Owner: GArrowScalarAggregateOptions
Flags: Read / Write
Default value: 1
Since: 5.0.0
“skip-nulls”
property“skip-nulls” gboolean
Whether NULLs are skipped or not.
Owner: GArrowScalarAggregateOptions
Flags: Read / Write
Default value: TRUE
Since: 5.0.0
“skip-nulls”
property“skip-nulls” gboolean
Whether NULLs are skipped or not.
Owner: GArrowSetLookupOptions
Flags: Read / Write
Default value: FALSE
Since: 6.0.0
“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
“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
“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
“reader”
property“reader” GArrowRecordBatchReader *
The GArrowRecordBatchReader that produces record batches.
Owner: GArrowSourceNodeOptions
Flags: Write / Construct Only
“record-batch”
property“record-batch” GArrowRecordBatch *
The GArrowRecordBatch to be produced.
Owner: GArrowSourceNodeOptions
Flags: Write / Construct Only
“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
“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
“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