datafusion.functions.functions

datafusion.functions.functions.abs(num)

$FUNC

datafusion.functions.functions.acos(num)

$FUNC

datafusion.functions.functions.acosh(num)

$FUNC

datafusion.functions.functions.alias(expr, name)

Creates a new Alias Expr

datafusion.functions.functions.approx_distinct(*args, distinct=False)
datafusion.functions.functions.approx_median(*args, distinct=False)
datafusion.functions.functions.approx_percentile_cont(*args, distinct=False)
datafusion.functions.functions.approx_percentile_cont_with_weight(*args, distinct=False)
datafusion.functions.functions.array(*exprs)
datafusion.functions.functions.array_agg(*args, distinct=False)
datafusion.functions.functions.array_append(array, element)

$FUNC

datafusion.functions.functions.array_cat(*exprs)
datafusion.functions.functions.array_concat(*exprs)
datafusion.functions.functions.array_dims(array)

$FUNC

datafusion.functions.functions.array_distinct(array)

$FUNC

datafusion.functions.functions.array_element(array, element)

$FUNC

datafusion.functions.functions.array_except(first_array, second_array)

$FUNC

datafusion.functions.functions.array_extract(array, element)

array_element

datafusion.functions.functions.array_has(first_array, second_array)

$FUNC

datafusion.functions.functions.array_has_all(first_array, second_array)

$FUNC

datafusion.functions.functions.array_has_any(first_array, second_array)

$FUNC

datafusion.functions.functions.array_indexof(array, element, index=1)
datafusion.functions.functions.array_intersect(first_array, second_array)

$FUNC

datafusion.functions.functions.array_join(array, delimiter)

array_to_string

datafusion.functions.functions.array_length(array)

$FUNC

datafusion.functions.functions.array_ndims(array)

$FUNC

datafusion.functions.functions.array_pop_back(array)

$FUNC

datafusion.functions.functions.array_pop_front(array)

$FUNC

datafusion.functions.functions.array_position(array, element, index=1)
datafusion.functions.functions.array_positions(array, element)
datafusion.functions.functions.array_prepend(element, array)

$FUNC

datafusion.functions.functions.array_push_back(array, element)

array_append

datafusion.functions.functions.array_push_front(element, array)

array_prepend

datafusion.functions.functions.array_remove(array, element)

$FUNC

datafusion.functions.functions.array_remove_all(array, element)

$FUNC

datafusion.functions.functions.array_remove_n(array, element, max)

$FUNC

datafusion.functions.functions.array_repeat(element, count)

$FUNC

datafusion.functions.functions.array_replace()

$FUNC

datafusion.functions.functions.array_replace_all()

$FUNC

datafusion.functions.functions.array_replace_n()

$FUNC

datafusion.functions.functions.array_resize(array, size, value)

$FUNC

datafusion.functions.functions.array_slice(array, begin, end, stride=1)
datafusion.functions.functions.array_to_string(array, delimiter)

$FUNC

datafusion.functions.functions.array_union(array1, array2)

$FUNC

datafusion.functions.functions.arrow_typeof(arg_1)

$FUNC

datafusion.functions.functions.ascii(arg1)

Returns the numeric code of the first character of the argument. In UTF8 encoding, returns the Unicode code point of the character. In other multibyte encodings, the argument must be an ASCII character.

datafusion.functions.functions.asin(num)

$FUNC

datafusion.functions.functions.asinh(num)

$FUNC

datafusion.functions.functions.atan(num)

$FUNC

datafusion.functions.functions.atan2(y, x)

$FUNC

datafusion.functions.functions.atanh(num)

$FUNC

datafusion.functions.functions.avg(*args, distinct=False)
datafusion.functions.functions.bit_and(*args, distinct=False)
datafusion.functions.functions.bit_length(arg)

Returns number of bits in the string (8 times the octet_length).

datafusion.functions.functions.bit_or(*args, distinct=False)
datafusion.functions.functions.bit_xor(*args, distinct=False)
datafusion.functions.functions.bool_and(*args, distinct=False)
datafusion.functions.functions.bool_or(*args, distinct=False)
datafusion.functions.functions.btrim(*args)

Removes the longest string containing only characters in characters (a space by default) from the start and end of string.

datafusion.functions.functions.case(expr)

Create a CASE WHEN statement with literal WHEN expressions for comparison to the base expression.

datafusion.functions.functions.cbrt(num)

$FUNC

datafusion.functions.functions.ceil(num)

$FUNC

datafusion.functions.functions.char_length(string)

$FUNC

datafusion.functions.functions.character_length(string)

Returns number of characters in the string.

datafusion.functions.functions.chr(arg)

Returns the character with the given code.

datafusion.functions.functions.coalesce(*args)
datafusion.functions.functions.col(name)

Create a column reference Expr

datafusion.functions.functions.concat(*args)

Concatenates the text representations of all the arguments. NULL arguments are ignored.

datafusion.functions.functions.concat_ws(sep, *args)

Concatenates all but the first argument, with separators. The first argument is used as the separator string, and should not be NULL. Other NULL arguments are ignored.

datafusion.functions.functions.corr(*args, distinct=False)
datafusion.functions.functions.cos(num)

$FUNC

datafusion.functions.functions.cosh(num)

$FUNC

datafusion.functions.functions.count(*args, distinct=False)
datafusion.functions.functions.count_star()

Create a COUNT(1) aggregate expression

datafusion.functions.functions.covar(y, x, distinct=False, filter=None, order_by=None)
datafusion.functions.functions.covar_pop(*args, distinct=False)
datafusion.functions.functions.covar_samp(y, x, distinct=False, filter=None, order_by=None)
datafusion.functions.functions.current_date()
datafusion.functions.functions.current_time()
datafusion.functions.functions.date_bin(stride, source, origin)

$FUNC

datafusion.functions.functions.date_part(part, date)

$FUNC

datafusion.functions.functions.date_trunc(part, date)

$FUNC

datafusion.functions.functions.datepart(part, date)

date_part

datafusion.functions.functions.datetrunc(part, date)

date_trunc

datafusion.functions.functions.decode(input, encoding)

$FUNC

datafusion.functions.functions.degrees(num)

$FUNC

datafusion.functions.functions.digest(value, method)

Computes a binary hash of the given data. type is the algorithm to use. Standard algorithms are md5, sha224, sha256, sha384, sha512, blake2s, blake2b, and blake3.

datafusion.functions.functions.encode(input, encoding)

$FUNC

datafusion.functions.functions.ends_with(string, suffix)

Returns true if string ends with suffix.

datafusion.functions.functions.exp(num)

$FUNC

datafusion.functions.functions.factorial(num)

$FUNC

datafusion.functions.functions.first_value(*args, distinct=False)
datafusion.functions.functions.flatten(array)

$FUNC

datafusion.functions.functions.floor(num)

$FUNC

datafusion.functions.functions.from_unixtime(unixtime)

$FUNC

datafusion.functions.functions.gcd(x, y)

$FUNC

datafusion.functions.functions.grouping(*args, distinct=False)
datafusion.functions.functions.in_list(expr, value, negated)
datafusion.functions.functions.initcap(string)

Converts the first letter of each word to upper case and the rest to lower case. Words are sequences of alphanumeric characters separated by non-alphanumeric characters.

datafusion.functions.functions.isnan(num)

$FUNC

datafusion.functions.functions.iszero(num)

$FUNC

datafusion.functions.functions.last_value(*args, distinct=False)
datafusion.functions.functions.lcm(x, y)

$FUNC

datafusion.functions.functions.left(string, n)

Returns first n characters in the string, or when n is negative, returns all but last |n| characters.

datafusion.functions.functions.length(string)

$FUNC

datafusion.functions.functions.list_append(array, element)

array_append

datafusion.functions.functions.list_dims(array)

array_dims

datafusion.functions.functions.list_distinct(array)

array_distinct

datafusion.functions.functions.list_element(array, element)

array_element

datafusion.functions.functions.list_except(first_array, second_array)

array_except

datafusion.functions.functions.list_extract(array, element)

array_element

datafusion.functions.functions.list_indexof(array, element, index=1)
datafusion.functions.functions.list_intersect(first_array, second_array)

array_intersect

datafusion.functions.functions.list_join(array, delimiter)

array_to_string

datafusion.functions.functions.list_length(array)

array_length

datafusion.functions.functions.list_ndims(array)

array_ndims

datafusion.functions.functions.list_position(array, element, index=1)
datafusion.functions.functions.list_positions(array, element)

array_positions

datafusion.functions.functions.list_prepend(element, array)

array_prepend

datafusion.functions.functions.list_push_back(array, element)

array_append

datafusion.functions.functions.list_push_front(element, array)

array_prepend

datafusion.functions.functions.list_remove(array, element)

array_remove

datafusion.functions.functions.list_remove_all(array, element)

array_remove_all

datafusion.functions.functions.list_remove_n(array, element, max)

array_remove_n

datafusion.functions.functions.list_replace()

array_replace

datafusion.functions.functions.list_replace_all()

array_replace_all

datafusion.functions.functions.list_replace_n()

array_replace_n

datafusion.functions.functions.list_resize(array, size, value)

array_resize

datafusion.functions.functions.list_slice(array, begin, end, stride=1)
datafusion.functions.functions.list_to_string(array, delimiter)

array_to_string

datafusion.functions.functions.list_union(array1, array2)

array_union

datafusion.functions.functions.ln(num)

$FUNC

datafusion.functions.functions.log(base, num)

$FUNC

datafusion.functions.functions.log10(num)

$FUNC

datafusion.functions.functions.log2(num)

$FUNC

datafusion.functions.functions.lower(arg1)

Converts the string to all lower case

datafusion.functions.functions.lpad(*args)

Extends the string to length length by prepending the characters fill (a space by default). If the string is already longer than length then it is truncated (on the right).

datafusion.functions.functions.ltrim(*args)

Removes the longest string containing only characters in characters (a space by default) from the start of string.

datafusion.functions.functions.make_array(*exprs)
datafusion.functions.functions.max(*args, distinct=False)
datafusion.functions.functions.md5(input_arg)

Computes the MD5 hash of the argument, with the result written in hexadecimal.

datafusion.functions.functions.mean(*args, distinct=False)
datafusion.functions.functions.median(*args, distinct=False)
datafusion.functions.functions.min(*args, distinct=False)
datafusion.functions.functions.named_struct(*args)
datafusion.functions.functions.nanvl(x, y)

Returns x if x is not NaN otherwise returns y.

datafusion.functions.functions.now()
datafusion.functions.functions.nullif(arg_1, arg_2)

$FUNC

datafusion.functions.functions.octet_length(*args)

Returns number of bytes in the string. Since this version of the function accepts type character directly, it will not strip trailing spaces.

datafusion.functions.functions.order_by(expr, asc=None, nulls_first=None)

Creates a new Sort Expr

datafusion.functions.functions.pi()
datafusion.functions.functions.pow(base, exponent)

power

datafusion.functions.functions.power(base, exponent)

$FUNC

datafusion.functions.functions.radians(num)

$FUNC

datafusion.functions.functions.random()
datafusion.functions.functions.range(start, stop, step)

$FUNC

datafusion.functions.functions.regexp_match(input_arg1, input_arg2)

$FUNC

datafusion.functions.functions.regexp_replace(arg1, arg2, arg3, arg4)

Replaces substring(s) matching a POSIX regular expression.

datafusion.functions.functions.regr_avgx(*args, distinct=False)
datafusion.functions.functions.regr_avgy(*args, distinct=False)
datafusion.functions.functions.regr_count(*args, distinct=False)
datafusion.functions.functions.regr_intercept(*args, distinct=False)
datafusion.functions.functions.regr_r2(*args, distinct=False)
datafusion.functions.functions.regr_slope(*args, distinct=False)
datafusion.functions.functions.regr_sxx(*args, distinct=False)
datafusion.functions.functions.regr_sxy(*args, distinct=False)
datafusion.functions.functions.regr_syy(*args, distinct=False)
datafusion.functions.functions.repeat(string, n)

Repeats string the specified number of times.

datafusion.functions.functions.replace()

Replaces all occurrences in string of substring from with substring to.

datafusion.functions.functions.reverse(string)

Reverses the order of the characters in the string.

datafusion.functions.functions.right(string, n)

Returns last n characters in the string, or when n is negative, returns all but first |n| characters.

datafusion.functions.functions.round(*args)
datafusion.functions.functions.rpad(*args)

Extends the string to length length by appending the characters fill (a space by default). If the string is already longer than length then it is truncated.

datafusion.functions.functions.rtrim(*args)

Removes the longest string containing only characters in characters (a space by default) from the end of string.

datafusion.functions.functions.sha224(input_arg1)

$FUNC

datafusion.functions.functions.sha256(input_arg1)

$FUNC

datafusion.functions.functions.sha384(input_arg1)

$FUNC

datafusion.functions.functions.sha512(input_arg1)

$FUNC

datafusion.functions.functions.signum(num)

$FUNC

datafusion.functions.functions.sin(num)

$FUNC

datafusion.functions.functions.sinh(num)

$FUNC

datafusion.functions.functions.split_part(string, delimiter, index)

Splits string at occurrences of delimiter and returns the n’th field (counting from one).

datafusion.functions.functions.sqrt(num)

$FUNC

datafusion.functions.functions.starts_with(string, prefix)

Returns true if string starts with prefix.

datafusion.functions.functions.stddev(*args, distinct=False)
datafusion.functions.functions.stddev_pop(*args, distinct=False)
datafusion.functions.functions.stddev_samp(*args, distinct=False)
datafusion.functions.functions.strpos(string, substring)

Returns starting index of specified substring within string, or zero if it’s not present. (Same as position(substring in string), but note the reversed argument order.)

datafusion.functions.functions.struct(*args)

r#struct

datafusion.functions.functions.substr(string, position)

$FUNC

datafusion.functions.functions.substring(string, position, length)

$FUNC

datafusion.functions.functions.sum(*args, distinct=False)
datafusion.functions.functions.tan(num)

$FUNC

datafusion.functions.functions.tanh(num)

$FUNC

datafusion.functions.functions.to_hex(arg1)

Converts the number to its equivalent hexadecimal representation.

datafusion.functions.functions.to_timestamp(*args)
datafusion.functions.functions.to_timestamp_micros(*args)
datafusion.functions.functions.to_timestamp_millis(*args)
datafusion.functions.functions.to_timestamp_seconds(*args)
datafusion.functions.functions.translate()

Replaces each character in string that matches a character in the from set with the corresponding character in the to set. If from is longer than to, occurrences of the extra characters in from are deleted.

datafusion.functions.functions.trim(*args)

Removes the longest string containing only characters in characters (a space by default) from the start, end, or both ends (BOTH is the default) of string.

datafusion.functions.functions.trunc(*args)
datafusion.functions.functions.upper(arg1)

Converts the string to all upper case.

datafusion.functions.functions.uuid()
datafusion.functions.functions.var(*args, distinct=False)
datafusion.functions.functions.var_pop(*args, distinct=False)
datafusion.functions.functions.var_samp(*args, distinct=False)
datafusion.functions.functions.window(name, args, partition_by=None, order_by=None, window_frame=None, ctx=None)

Creates a new Window function expression