Module datafusion_expr::expr_fn

Functions for creating logical expressions

Structs

• SimpleAggregateUDF
  Implements AggregateUDFImpl for functions that have a single signature and return type.
• SimpleScalarUDF
  Implements ScalarUDFImpl for functions that have a single signature and return type.
• SimpleWindowUDF
  Implements WindowUDFImpl for functions that have a single signature and return type.

Functions

• acosh
  inverse hyperbolic cosine
• and
  Return a new expression with a logical AND
• approx_distinct
  Returns the approximate number of distinct input values. This function provides an approximation of count(DISTINCT x). Zero is returned if all input values are null. This function should produce a standard error of 0.81%, which is the standard deviation of the (approximately normal) error distribution over all possible sets. It does not guarantee an upper bound on the error for any specific input set.
• approx_median
  Calculate an approximation of the median for expr.
• approx_percentile_cont
  Calculate an approximation of the specified percentile for expr.
• approx_percentile_cont_with_weight
  Calculate an approximation of the specified percentile for expr and weight_expr.
• array_agg
  Create an expression to represent the array_agg() aggregate function
• asinh
  inverse hyperbolic sine
• atan
  inverse tangent
• atan2
  inverse tangent of a division given in the argument
• atanh
  inverse hyperbolic tangent
• avg
  Create an expression to represent the avg() aggregate function
• binary_expr
  Return a new expression left <op> right
• bitwise_and
  Return a new expression with bitwise AND
• bitwise_or
  Return a new expression with bitwise OR
• bitwise_shift_left
  Return a new expression with bitwise SHIFT LEFT
• bitwise_shift_right
  Return a new expression with bitwise SHIFT RIGHT
• bitwise_xor
  Return a new expression with bitwise XOR
• call_fn
  Calls a named built in function
• case
  Create a CASE WHEN statement with literal WHEN expressions for comparison to the base expression.
• cast
  Create a cast expression
• cbrt
  cube root of a number
• ceil
  nearest integer greater than or equal to argument
• coalesce
  returns coalesce(args...), which evaluates to the value of the first Expr which is not NULL
• col
  Create a column expression based on a qualified or unqualified column name. Will normalize unquoted identifiers according to SQL rules (identifiers will become lowercase).
• concat
  Concatenates the text representations of all the arguments. NULL arguments are ignored.
• concat_expr
  concatenates several strings
• concat_ws
  Concatenates all but the first argument, with separators. The first argument is used as the separator. NULL arguments in values are ignored.
• concat_ws_expr
  concatenates several strings, placing a seperator between each one
• cos
  cosine
• cosh
  hyperbolic cosine
• cot
  cotangent
• count
  Create an expression to represent the count() aggregate function
• count_distinct
  Create an expression to represent the count(distinct) aggregate function
• create_udaf
  Creates a new UDAF with a specific signature, state type and return type. The signature and state type must match the Accumulator's implementation.
• create_udf
  Convenience method to create a new user defined scalar function (UDF) with a specific signature and specific return type.
• create_udwf
  Creates a new UDWF with a specific signature, state type and return type.
• cube
  Create a grouping set for all combination of exprs
• degrees
  converts radians to degrees
• ends_with
  whether the string ends with the suffix
• exists
  Create an EXISTS subquery expression
• exp
  exponential
• factorial
  factorial
• find_in_set
  Returns a value in the range of 1 to N if the string str is in the string list strlist consisting of N substrings
• floor
  nearest integer less than or equal to argument
• gcd
  greatest common divisor
• grouping_set
  Create a grouping set
• ident
  Create an unqualified column expression from the provided name, without normalizing the column.
• in_list
  Create an in_list expression
• in_subquery
  Create an IN subquery expression
• initcap
  converts the first letter of each word in string in uppercase and the remaining characters in lowercase
• is_false
  Create is false expression
• is_not_false
  Create is not false expression
• is_not_true
  Create is not true expression
• is_not_unknown
  Create is not unknown expression
• is_null
  Create is null expression
• is_true
  Create is true expression
• is_unknown
  Create is unknown expression
• iszero
  returns true if a given number is +0.0 or -0.0 otherwise returns false
• lcm
  least common multiple
• left
  returns the first n characters in the string
• ln
  natural logarithm (base e) of number
• log
  logarithm of a x for a particular base
• log2
  base 2 logarithm of number
• log10
  base 10 logarithm of number
• lpad
  fill up a string to the length by prepending the characters
• max
  Create an expression to represent the max() aggregate function
• median
  Calculate the median for expr.
• min
  Create an expression to represent the min() aggregate function
• nanvl
  returns x if x is not NaN otherwise returns y
• not
  Return a new expression with a logical NOT
• not_exists
  Create a NOT EXISTS subquery expression
• not_in_subquery
  Create a NOT IN subquery expression
• or
  Return a new expression with a logical OR
• out_ref_col
  Create an out reference column which hold a reference that has been resolved to a field outside of the current plan.
• pi
  Returns an approximate value of π
• placeholder
  Create placeholder value that will be filled in (such as $1)
• power
  base raised to the power of exponent
• radians
  converts degrees to radians
• random
  Returns a random value in the range 0.0 <= x < 1.0
• reverse
  reverses the string
• right
  returns the last n characters in the string
• rollup
  Create a grouping set for rollup
• round
  round to nearest integer
• rpad
  fill up a string to the length by appending the characters
• scalar_subquery
  Create a scalar subquery expression
• signum
  sign of the argument (-1, 0, +1)
• sin
  sine
• sinh
  hyperbolic sine
• sqrt
  square root of a number
• stddev
  Create an expression to represent the stddev() aggregate function
• strpos
  finds the position from where the substring matches the string
• substr
  substring from the position to the end
• substr_index
  Returns the substring from str before count occurrences of the delimiter
• substring
  substring from the position with length characters
• sum
  Create an expression to represent the sum() aggregate function
• translate
  replaces the characters in from with the counterpart in to
• trunc
  truncate toward zero, with optional precision
• try_cast
  Create a try cast expression
• when
  Create a CASE WHEN statement with boolean WHEN expressions and no base expression.
• wildcard
  Create an ‘*’ Expr::Wildcard expression that matches all columns