Expand description
Computation kernels on Arrow Arrays
Modules§
- Computation kernels on Arrow Arrays
Structs§
- CastOptions provides a way to override the default cast behaviors
- A builder to construct
FilterPredicate
- A filtering predicate that can be applied to an
Array
- A lexicographical comparator that wraps given array data (columns) and can lexicographically compare data at given two indices. The lifetime is the same at the data wrapped.
- A computed set of partitions, see
partition
- An iterator of
(usize, usize)
each representing an interval[start, end)
whose slots of a bitmap Buffer are true. Each interval corresponds to a contiguous region of memory to be “taken” from an array to be filtered. - One column to be used in lexicographical sort
- Options that define the sort order of a given column
- Options that define how
take
should behave
Enums§
- Valid parts to extract from date/time/timestamp arrays.
Functions§
- Performs
AND
operation on two arrays. If either left or right value is null then the result is also null. - Logical ‘and’ boolean values with Kleene logic
- Performs
AND_NOT
operation on two arrays. If either left or right value is null then the result is also null. - Given two arrays of length
len
, callsop(a[i], b[i])
fori
in0..len
, collecting the results in aPrimitiveArray
. If any index is null in eithera
orb
, the corresponding index in the result will also be null - Given two arrays of length
len
, callsop(a[i], b[i])
fori
in0..len
, mutating the mutablePrimitiveArray
a
. If any index is null in eithera
orb
, the corresponding index in the result will also be null. - Returns the bitwise and of all non-null input values.
- Returns the bitwise or of all non-null input values.
- Returns the bitwise xor of all non-null input values.
- Returns true if all non-null input values are true, otherwise false.
- Returns true if any non-null input value is true, otherwise false.
- build_filterDeprecatedReturns a prepared function optimized to filter multiple arrays. Creating this function requires time, but using it is faster than filter when the same filter needs to be applied to multiple arrays (e.g. a multi-column
RecordBatch
). WARNING: the nulls offilter
are ignored and the value on its slot is considered. Therefore, it is considered undefined behavior to passfilter
with null values. - Return true if a value of type
from_type
can be cast into a value ofto_type
. - Cast
array
to the provided data type and return a new Array with typeto_type
, if possible. - Cast
array
to the provided data type and return a new Array with typeto_type
, if possible. - Concatenates
batches
together into a singleRecordBatch
. - Perform SQL
CONTAINS(left, right)
- Given an array, return a new array with the extracted
DatePart
as signed 32-bit integer values. - dayDeprecatedExtracts the day of a given temporal primitive array as an array of integers
- day_dynDeprecatedExtracts the day of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - doyDeprecatedExtracts the day of year of a given temporal primitive array as an array of integers The day of year that ranges from 1 to 366
- doy_dynDeprecatedExtracts the day of year of a given temporal array as an array of integers The day of year that ranges from 1 to 366. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Perform SQL
ENDSWITH(left, right)
- eqDeprecatedPerform
left == right
operation on twoPrimitiveArray
s. - eq_binaryDeprecated
- eq_binary_scalarDeprecated
- eq_boolDeprecatedPerform
left == right
operation onBooleanArray
- eq_bool_scalarDeprecatedPerform
left == right
operation onBooleanArray
and a scalar - eq_dynDeprecatedPerform
left == right
operation on two (dynamic)Array
s. - eq_dyn_binary_scalarDeprecatedPerform
left == right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - eq_dyn_bool_scalarDeprecatedPerform
left == right
operation on an array and a numeric scalar value. - eq_dyn_scalarDeprecatedPerform
left == right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - eq_dyn_utf8_scalarDeprecatedPerform
left == right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - eq_scalarDeprecatedPerform
left == right
operation on aPrimitiveArray
and a scalar value. - eq_utf8Deprecated
- eq_utf8_scalarDeprecated
- Filters an Array, returning elements matching the filter (i.e. where the values are true).
- Returns a new RecordBatch with arrays containing only values matching the filter.
- gtDeprecatedPerform
left > right
operation on twoPrimitiveArray
s. Non-null values are greater than null values. - gt_binaryDeprecated
- gt_binary_scalarDeprecated
- gt_boolDeprecatedPerform
left > right
operation onBooleanArray
- gt_bool_scalarDeprecatedPerform
left > right
operation onBooleanArray
and a scalar - gt_dynDeprecatedPerform
left > right
operation on two (dynamic)Array
s. - gt_dyn_binary_scalarDeprecatedPerform
left > right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - gt_dyn_bool_scalarDeprecatedPerform
left > right
operation on an array and a numeric scalar value. Supports BooleanArrays. - gt_dyn_scalarDeprecatedPerform
left > right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - gt_dyn_utf8_scalarDeprecatedPerform
left > right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - gt_eqDeprecatedPerform
left >= right
operation on twoPrimitiveArray
s. Non-null values are greater than null values. - gt_eq_binaryDeprecated
- gt_eq_binary_scalarDeprecated
- gt_eq_boolDeprecatedPerform
left >= right
operation onBooleanArray
- gt_eq_bool_scalarDeprecatedPerform
left >= right
operation onBooleanArray
and a scalar - gt_eq_dynDeprecatedPerform
left >= right
operation on two (dynamic)Array
s. - gt_eq_dyn_binary_scalarDeprecatedPerform
left >= right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - gt_eq_dyn_bool_scalarDeprecatedPerform
left >= right
operation on an array and a numeric scalar value. Supports BooleanArrays. - gt_eq_dyn_scalarDeprecatedPerform
left >= right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - gt_eq_dyn_utf8_scalarDeprecatedPerform
left >= right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - gt_eq_scalarDeprecatedPerform
left >= right
operation on aPrimitiveArray
and a scalar value. Non-null values are greater than null values. - gt_eq_utf8Deprecated
- gt_eq_utf8_scalarDeprecated
- gt_scalarDeprecatedPerform
left > right
operation on aPrimitiveArray
and a scalar value. Non-null values are greater than null values. - gt_utf8Deprecated
- gt_utf8_scalarDeprecated
- hourDeprecatedExtracts the hours of a given temporal primitive array as an array of integers within the range of [0, 23].
- hour_dynDeprecatedExtracts the hours of a given array as an array of integers within the range of [0, 23]. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Perform SQL
left ILIKE right
- Checks if a
GenericListArray
contains a value in thePrimitiveArray
- Checks if a
GenericListArray
contains a value in theGenericStringArray
- Returns a non-null BooleanArray with whether each value of the array is not null.
- Returns a non-null BooleanArray with whether each value of the array is null.
- lexicographical_partition_rangesDeprecatedUse
partition
instead. Given a list of already sorted columns, find partition ranges that would partition lexicographically equal values across columns. - Sort a list of
ArrayRef
usingSortOptions
provided for each array. - Sort elements lexicographically from a list of
ArrayRef
into an unsigned integer (UInt32Array
) of indices. - Perform SQL
left LIKE right
- ltDeprecatedPerform
left < right
operation on twoPrimitiveArray
s. Null values are less than non-null values. - lt_binaryDeprecated
- lt_binary_scalarDeprecated
- lt_boolDeprecatedPerform
left < right
operation onBooleanArray
- lt_bool_scalarDeprecatedPerform
left < right
operation onBooleanArray
and a scalar - lt_dynDeprecatedPerform
left < right
operation on two (dynamic)Array
s. - lt_dyn_binary_scalarDeprecatedPerform
left < right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - lt_dyn_bool_scalarDeprecatedPerform
left < right
operation on an array and a numeric scalar value. Supports BooleanArrays. - lt_dyn_scalarDeprecatedPerform
left < right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - lt_dyn_utf8_scalarDeprecatedPerform
left < right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - lt_eqDeprecatedPerform
left <= right
operation on twoPrimitiveArray
s. Null values are less than non-null values. - lt_eq_binaryDeprecated
- lt_eq_binary_scalarDeprecated
- lt_eq_boolDeprecatedPerform
left <= right
operation onBooleanArray
- lt_eq_bool_scalarDeprecatedPerform
left <= right
operation onBooleanArray
and a scalar - lt_eq_dynDeprecatedPerform
left <= right
operation on two (dynamic)Array
s. - lt_eq_dyn_binary_scalarDeprecatedPerform
left <= right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - lt_eq_dyn_bool_scalarDeprecatedPerform
left <= right
operation on an array and a numeric scalar value. Supports BooleanArrays. - lt_eq_dyn_scalarDeprecatedPerform
left <= right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - lt_eq_dyn_utf8_scalarDeprecatedPerform
left <= right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - lt_eq_scalarDeprecatedPerform
left <= right
operation on aPrimitiveArray
and a scalar value. Null values are less than non-null values. - lt_eq_utf8Deprecated
- lt_eq_utf8_scalarDeprecated
- lt_scalarDeprecatedPerform
left < right
operation on aPrimitiveArray
and a scalar value. Null values are less than non-null values. - lt_utf8Deprecated
- lt_utf8_scalarDeprecated
- Returns the maximum value in the array, according to the natural order. For floating point arrays any NaN values are considered to be greater than any other non-null value
- Returns the max of values in the array of
ArrowNumericType
type, or dictionary array with value ofArrowNumericType
type. - Returns the maximum value in the binary array, according to the natural order.
- Returns the maximum value in the boolean array
- Returns the maximum value in the string array, according to the natural order.
- microsecondDeprecatedExtracts the microseconds of a given temporal primitive array as an array of integers
- microsecond_dynDeprecatedExtracts the microseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - millisecondDeprecatedExtracts the milliseconds of a given temporal primitive array as an array of integers
- millisecond_dynDeprecatedExtracts the milliseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Returns the minimum value in the array, according to the natural order. For floating point arrays any NaN values are considered to be greater than any other non-null value
- Returns the min of values in the array of
ArrowNumericType
type, or dictionary array with value ofArrowNumericType
type. - Returns the minimum value in the binary array, according to the natural order.
- Returns the minimum value in the boolean array.
- Returns the minimum value in the string array, according to the natural order.
- minuteDeprecatedExtracts the minutes of a given temporal primitive array as an array of integers
- minute_dynDeprecatedExtracts the minutes of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - monthDeprecatedExtracts the month of a given temporal primitive array as an array of integers within the range of [1, 12].
- month_dynDeprecatedExtracts the month of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Perform
left * right
operation on two decimal arrays. If either left or right value is null then the result is also null. - Perform
left * right
operation on two decimal arrays. If either left or right value is null then the result is also null. - Perform
left * right
operation on two decimal arrays. If either left or right value is null then the result is also null. - nanosecondDeprecatedExtracts the nanoseconds of a given temporal primitive array as an array of integers
- nanosecond_dynDeprecatedExtracts the nanoseconds of a given temporal primitive array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - neqDeprecatedPerform
left != right
operation on twoPrimitiveArray
s. - neq_binaryDeprecated
- neq_binary_scalarDeprecated
- neq_boolDeprecatedPerform
left != right
operation onBooleanArray
- neq_bool_scalarDeprecatedPerform
left != right
operation onBooleanArray
and a scalar - neq_dynDeprecatedPerform
left != right
operation on two (dynamic)Array
s. - neq_dyn_binary_scalarDeprecatedPerform
left != right
operation on an array and a numeric scalar value. Supports BinaryArray and LargeBinaryArray - neq_dyn_bool_scalarDeprecatedPerform
left != right
operation on an array and a numeric scalar value. Supports BooleanArrays. - neq_dyn_scalarDeprecatedPerform
left != right
operation on an array and a numeric scalar value. Supports PrimitiveArrays, and DictionaryArrays that have primitive values. - neq_dyn_utf8_scalarDeprecatedPerform
left != right
operation on an array and a numeric scalar value. Supports StringArrays, and DictionaryArrays that have string values - neq_scalarDeprecatedPerform
left != right
operation on aPrimitiveArray
and a scalar value. - neq_utf8Deprecated
- neq_utf8_scalarDeprecated
- Perform SQL
left NOT ILIKE right
- Perform SQL
left NOT LIKE right
- Performs unary
NOT
operation on an arrays. If value is null then the result is also null. - Copies original array, setting validity bit to false if a secondary comparison boolean array is set to true
- num_days_from_mondayDeprecatedExtracts the day of week of a given temporal primitive array as an array of integers.
- num_days_from_monday_dynDeprecatedExtracts the day of week of a given temporal array as an array of integers.
- num_days_from_sundayDeprecatedExtracts the day of week of a given temporal primitive array as an array of integers, starting at Sunday.
- num_days_from_sunday_dynDeprecatedExtracts the day of week of a given temporal array as an array of integers, starting at Sunday.
- Performs
OR
operation on two arrays. If either left or right value is null then the result is also null. - Logical ‘or’ boolean values with Kleene logic
- It’s unstable_sort, may not preserve the order of equal elements
- Given a list of lexicographically sorted columns, computes the
Partitions
, where a partition consists of the set of consecutive rows with equal values - Remove null values by do a bitmask AND operation with null bits and the boolean bits.
- quarterDeprecatedExtracts the quarter of a given temporal primitive array as an array of integers within the range of [1, 4].
- quarter_dynDeprecatedExtracts the quarter of a given temporal array as an array of integersa within the range of [1, 4]. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Assigns a rank to each value in
array
based on its position in the sorted order - Perform SQL
array ~ regex_array
operation onStringArray
/LargeStringArray
. Ifregex_array
element has an empty value, the corresponding result value is always true. - Extract all groups matched by a regular expression for a given String array.
- secondDeprecatedExtracts the seconds of a given temporal primitive array as an array of integers
- second_dynDeprecatedExtracts the seconds of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - Shifts array by defined number of items (to left or right) A positive value for
offset
shifts the array to the right a negative value shifts the array to the left. - Sort the
ArrayRef
usingSortOptions
. - Sort the
ArrayRef
partially. - Sort elements from
ArrayRef
into an unsigned integer (UInt32Array
) of indices. Floats are sorted using IEEE 754 totalOrder.limit
is an option for partial_sort. - Perform SQL
STARTSWITH(left, right)
- Returns the sum of values in the primitive array.
- Returns the sum of values in the array.
- Returns the sum of values in the array.
- Returns the sum of values in the primitive array.
- Take rows by index from
RecordBatch
and returns a newRecordBatch
from those indexes. - Applies the provided fallible binary operation across
a
andb
, returning any error, and collecting the results into aPrimitiveArray
. If any index is null in eithera
orb
, the corresponding index in the result will also be null - Applies the provided fallible binary operation across
a
andb
by mutating the mutablePrimitiveArray
a
with the results, returning any error. If any index is null in eithera
orb
, the corresponding index in the result will also be null - try_unary_dynDeprecatedApplies a fallible unary function to an array with primitive values.
- unary_cmpDeprecatedApplies an unary and infallible comparison function to a primitive array.
- unary_dynDeprecatedApplies an infallible unary function to an array with primitive values.
- using_chrono_tz_and_utc_naive_date_timeDeprecatedParse the given string into a string representing fixed-offset that is correct as of the given UTC NaiveDateTime. Note that the offset is function of time and can vary depending on whether daylight savings is in effect or not. e.g. Australia/Sydney is +10:00 or +11:00 depending on DST.
- weekDeprecatedExtracts the week of a given temporal primitive array as an array of integers
- week_dynDeprecatedExtracts the week of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned. - yearDeprecatedExtracts the years of a given temporal primitive array as an array of integers
- year_dynDeprecatedExtracts the years of a given temporal array as an array of integers. If the given array isn’t temporal primitive or dictionary array, an
Err
will be returned.
Type Aliases§
- FilterDeprecatedFunction that can filter arbitrary arrays