Skip to content

functions_comparison.yaml

This document file is generated for functions_comparison.yaml. The extension URN is extension:io.substrait:functions_comparison.

Scalar Functions

not_equal

Implementations: not_equal(x, y): -> return_type 0. not_equal(any1, any1): -> boolean

*Whether two values are not_equal. not_equal(x, y) := (x != y) If either/both of x and y are null, null is returned. *

equal

Implementations: equal(x, y): -> return_type 0. equal(any1, any1): -> boolean

*Whether two values are equal. equal(x, y) := (x == y) If either/both of x and y are null, null is returned. *

is_not_distinct_from

Implementations: is_not_distinct_from(x, y): -> return_type 0. is_not_distinct_from(any1, any1): -> boolean

*Whether two values are equal. This function treats null values as comparable, so is_not_distinct_from(null, null) == True This is in contrast to equal, in which null values do not compare. *

is_distinct_from

Implementations: is_distinct_from(x, y): -> return_type 0. is_distinct_from(any1, any1): -> boolean

*Whether two values are not equal. This function treats null values as comparable, so is_distinct_from(null, null) == False This is in contrast to equal, in which null values do not compare. *

lt

Implementations: lt(x, y): -> return_type 0. lt(any1, any1): -> boolean

*Less than. lt(x, y) := (x < y) If either/both of x and y are null, null is returned. *

gt

Implementations: gt(x, y): -> return_type 0. gt(any1, any1): -> boolean

*Greater than. gt(x, y) := (x > y) If either/both of x and y are null, null is returned. *

lte

Implementations: lte(x, y): -> return_type 0. lte(any1, any1): -> boolean

*Less than or equal to. lte(x, y) := (x <= y) If either/both of x and y are null, null is returned. *

gte

Implementations: gte(x, y): -> return_type 0. gte(any1, any1): -> boolean

*Greater than or equal to. gte(x, y) := (x >= y) If either/both of x and y are null, null is returned. *

between

Implementations: between(expression, low, high): -> return_type

  • expression: The expression to test for in the range defined by `low` and `high`.
  • low: The value to check if greater than or equal to.
  • high: The value to check if less than or equal to.
    1. between(any1, any1, any1): -> boolean

    Whether the expression is greater than or equal to low and less than or equal to high. expression BETWEEN low AND high If low, high, or expression are null, null is returned.

    is_true

    Implementations: is_true(x): -> return_type 0. is_true(boolean?): -> BOOLEAN

    Whether a value is true.

    is_not_true

    Implementations: is_not_true(x): -> return_type 0. is_not_true(boolean?): -> BOOLEAN

    Whether a value is not true.

    is_false

    Implementations: is_false(x): -> return_type 0. is_false(boolean?): -> BOOLEAN

    Whether a value is false.

    is_not_false

    Implementations: is_not_false(x): -> return_type 0. is_not_false(boolean?): -> BOOLEAN

    Whether a value is not false.

    is_null

    Implementations: is_null(x): -> return_type 0. is_null(any1): -> boolean

    Whether a value is null. NaN is not null.

    is_not_null

    Implementations: is_not_null(x): -> return_type 0. is_not_null(any1): -> boolean

    Whether a value is not null. NaN is not null.

    is_nan

    Implementations: is_nan(x): -> return_type 0. is_nan(fp32): -> boolean 1. is_nan(fp64): -> boolean

    *Whether a value is not a number. If x is null, null is returned. *

    is_finite

    Implementations: is_finite(x): -> return_type 0. is_finite(fp32): -> boolean 1. is_finite(fp64): -> boolean

    *Whether a value is finite (neither infinite nor NaN). If x is null, null is returned. *

    is_infinite

    Implementations: is_infinite(x): -> return_type 0. is_infinite(fp32): -> boolean 1. is_infinite(fp64): -> boolean

    *Whether a value is infinite. If x is null, null is returned. *

    nullif

    Implementations: nullif(x, y): -> return_type 0. nullif(any1, any1): -> any1

    If two values are equal, return null. Otherwise, return the first value.

    coalesce

    Implementations: 0. coalesce(any1, any1): -> any1

    Evaluate arguments from left to right and return the first argument that is not null. Once a non-null argument is found, the remaining arguments are not evaluated. If all arguments are null, return null.

    least

    Implementations: 0. least(any1, any1): -> any1

    Evaluates each argument and returns the smallest one. The function will return null if any argument evaluates to null.

    least_skip_null

    Implementations: 0. least_skip_null(any1, any1): -> any1

    Evaluates each argument and returns the smallest one. The function will return null only if all arguments evaluate to null.

    greatest

    Implementations: 0. greatest(any1, any1): -> any1

    Evaluates each argument and returns the largest one. The function will return null if any argument evaluates to null.

    greatest_skip_null

    Implementations: 0. greatest_skip_null(any1, any1): -> any1

    Evaluates each argument and returns the largest one. The function will return null only if all arguments evaluate to null.