Array Functions

Array functions manipulate arrays or return information about arrays.

CARDINALITY

cardinality(array)

The number of members in the array. The null value will return 0.

ARRAY_POSITION

array_position(array, value)

Return a 0-based index of the first occurrence of val if it is found within an array. If val does not exist within the array, it returns -1. When array is nil, -1 is returned.

ARRAY_POSITIONS

array_positions(array, value)

Returns an array containing the 0-based indexes of all occurrences of value. If the value is not found, an empty array is returned. When array is nil, nil is returned.

ELEMENT_AT

element_at(array, index)

Returns element of the array at index val. If val < 0, this function accesses elements from the last to the first. When array is nil, nil is returned.

ARRAY_CONTAINS

array_contains(array, value)

Returns true if array contains the element. When array is nil, nil is returned.

ARRAY_CREATE

array_create(value1, ......)

Construct an array from literals.

ARRAY_REMOVE

array_remove(array, value)

Returns the array with all occurrences of value removed. When array is nil, nil is returned.

ARRAY_LAST_POSITION

array_last_position(array, val)

Return a 0-based index of the last occurrence of val if it is found within the array. If val does not exist within the array, it returns -1. When array is nil, -1 is returned.

ARRAY_CONTAINS_ANY

array_contains_any(array1, array2)

Returns true if array1 and array2 have any elements in common. When array1 is nil, false is returned.

ARRAY_INTERSECT

array_intersect(array1, array2)

Returns an intersection of the two arrays, with all duplicates removed. When array is nil, nil is returned.

ARRAY_UNION

array_union(array1, array2)

Returns a union of the two arrays, with all duplicates removed.

ARRAY_MAX

array_max(array)

Returns an element which is greater than or equal to all other elements of the array. The null element will be ignored. When array is nil, nil is returned.

ARRAY_AVG

array_avg(array)

Returns the average of the numeric elements in the array. Null elements are ignored. The result is a floating-point number. When array is nil or contains no valid numeric elements, nil is returned.

ARRAY_MIN

array_min(array)

Returns an element which is less than or equal to all other elements of the array. The null element will be ignored. When array is nil, nil is returned.

ARRAY_EXCEPT

array_except(array1, array2)

Returns an array of elements that are in array1 but not in array2, without duplicates. When array1 is nil, nil is returned.

REPEAT

repeat(string, count)

Constructs an array of val repeated count times.

SEQUENCE

sequence(start, stop, step)

Returns an array of integers from start to stop, incrementing by step.

ARRAY_CARDINALITY

array_cardinality(array)

Return the number of elements in the array. The null value will be ignored. When array is nil, 0 is returned.

ARRAY_FLATTEN

array_flatten(array)

Return a flattened array, i.e., expand the array elements in the array.

For example, if the input is [[1, 4], [2, 3]], then the output is [1, 4, 2, 3]. When array is nil, nil is returned.

ARRAY_DISTINCT

array_distinct(array)

Return a distinct array, i.e., remove the duplicate elements in the array. When array is nil, nil is returned.

ARRAY_MAP

array_map(function_name, array)

Return a new array by applying a function to each element of the array. When array is nil, nil is returned.

ARRAY_JOIN

array_join(array, delimiter, null_replacement)

Return a string that concatenates all elements of the array and uses the delimiter and an optional string to replace null values.

For example, if the input is [1, 2, 3], delimiter is set to comma, then the output is "1,2,3". When array is nil, nil is returned.

ARRAY_SHUFFLE

array_shuffle(array)

Return a shuffled array, i.e., randomly shuffle the elements in the array. When array is nil, nil is returned.

ARRAY_CONCAT

array_concat(array1, array2, ...)

Returns the concatenation of the input arrays, this function does not modify the existing arrays, but returns new one. Any array that is nil is treated as an empty array.

ARRAY_SORT

array_sort(array)

Returns a sorted copy of the input array. When array is nil, nil is returned.

array_sort([3, 2, "b", "a"])

Result:

[2, 3, "a", "b"]

KVPAIR_ARRAY_TO_OBJ

kvpair_array_to_obj(array)

Return a new object converted from an array of key-value pairs.

kvpair_array_to_obj([{"key":"key1", "value":1},{"key":"key2", "value":2}])

Result:

{"key1":1, "key2":2}