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. - 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.
Traits§
- A trait for Arrow String Arrays, currently three types are supported:
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. - Allies a binary infallable function to two
PrimitiveArray
s, producing a newPrimitiveArray
- Applies a binary and infallible function to values in two arrays, replacing the values in the first array in place.
- 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.
- 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. - Try to cast
array
toto_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.
- doyDeprecatedExtracts the day of year of a given temporal primitive array as an array of integers.
- doy_dynDeprecatedExtracts the day of year of a given temporal array as an array of integers.
- Perform SQL
ENDSWITH(left, right)
- Returns a filtered RecordBatch where the corresponding elements of
predicate
are true. - 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
- Interleave rows by index from multiple
RecordBatch
instances and return a newRecordBatch
. - 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
- 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 binary view 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.
- Returns the maximum value in the string view 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 binary view 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.
- Returns the minimum value in the string view 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. - 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. - Returns a new array with the same values and the validity bit to false where the corresponding element of
right
is 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 - Return BooleanArray indicating which strings in an array match an array of regular expressions.
- Return BooleanArray indicating which strings in an array match a single regular expression.
- regexp_is_match_utf8DeprecatedPerform SQL
array ~ regex_array
operation onStringArray
/LargeStringArray
. Ifregex_array
element has an empty value, the corresponding result value is always true. - regexp_is_match_utf8_scalarDeprecated
- 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.
- For each ArrayRef in the
Vec<ArrayRef>
, take elements by index and create a newVec<ArrayRef>
from those indices. - Take rows by index from
RecordBatch
and returns a newRecordBatch
from those indexes. - Applies the provided fallible binary operation across
a
andb
. - Applies the provided fallible binary operation across
a
andb
by mutating the mutablePrimitiveArray
a
with the results. - try_unary_dynDeprecatedApplies a fallible unary function to an array with primitive values.
- unary_dynDeprecatedApplies an infallible unary function to an array with primitive values.
- Returns the value of the target field when selected, or NULL otherwise.
- 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.
- 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