Enum deltalake::datafusion::logical_expr::BuiltinScalarFunction

pub enum BuiltinScalarFunction {
    Atan,
    Atan2,
    Acosh,
    Asinh,
    Atanh,
    Cbrt,
    Ceil,
    Coalesce,
    Cos,
    Cosh,
    Degrees,
    Exp,
    Factorial,
    Floor,
    Gcd,
    Lcm,
    Iszero,
    Ln,
    Log,
    Log10,
    Log2,
    Nanvl,
    Pi,
    Power,
    Radians,
    Round,
    Signum,
    Sin,
    Sinh,
    Sqrt,
    Trunc,
    Cot,
    Concat,
    ConcatWithSeparator,
    EndsWith,
    InitCap,
    Left,
    Lpad,
    Random,
    Reverse,
    Right,
    Rpad,
    Strpos,
    Substr,
    Translate,
    SubstrIndex,
    FindInSet,
}

Enum of all built-in scalar functions

Variants

Atan

atan

Atan2

atan2

Acosh

acosh

Asinh

asinh

Atanh

atanh

Cbrt

cbrt

Ceil

ceil

Coalesce

coalesce

Cos

cos

Cosh

cos

Degrees

degrees

Exp

exp

Factorial

factorial

Floor

floor

Gcd

gcd, Greatest common divisor

Lcm

lcm, Least common multiple

Iszero

iszero

Ln

ln, Natural logarithm

Log

log, same as log10

Log10

log10

Log2

log2

Nanvl

nanvl

Pi

pi

Power

power

Radians

radians

Round

round

Signum

signum

Sin

sin

Sinh

sinh

Sqrt

sqrt

Trunc

trunc

Cot

cot

Concat

concat

ConcatWithSeparator

concat_ws

EndsWith

ends_with

InitCap

initcap

Left

left

Lpad

lpad

Random

random

Reverse

reverse

Right

right

Rpad

rpad

Strpos

strpos

Substr

substr

Translate

translate

SubstrIndex

substr_index

FindInSet

find_in_set

Implementations

impl BuiltinScalarFunction

pub fn supports_zero_argument(&self) -> bool

👎Deprecated since 32.0.0: please use TypeSignature::supports_zero_argument instead

an allowlist of functions to take zero arguments, so that they will get special treatment while executing.

pub fn name(&self) -> &str

Returns the name of this function

pub fn volatility(&self) -> Volatility

Returns the Volatility of the builtin function.

pub fn return_type( self, input_expr_types: &[DataType] ) -> Result<DataType, DataFusionError>

Returns the output DataType of this function

This method should be invoked only after input_expr_types have been validated against the function’s TypeSignature using type_coercion::functions::data_types().

This method will:

1. Perform additional checks on input_expr_types that are beyond the scope of TypeSignature validation.
2. Deduce the output DataType based on the provided input_expr_types.

pub fn signature(&self) -> Signature

Return the argument Signature supported by this function

pub fn monotonicity(&self) -> Option<Vec<Option<bool>>>

This function specifies monotonicity behaviors for built-in scalar functions. The list can be extended, only mathematical and datetime functions are considered for the initial implementation of this feature.

pub fn aliases(&self) -> &'static [&'static str]

Returns all names that can be used to call this function

Trait Implementations

impl Clone for BuiltinScalarFunction

fn clone(&self) -> BuiltinScalarFunction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BuiltinScalarFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for BuiltinScalarFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<&ScalarFunction> for BuiltinScalarFunction

fn from(f: &ScalarFunction) -> BuiltinScalarFunction

Converts to this type from the input type.

impl FromStr for BuiltinScalarFunction

type Err = DataFusionError

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<BuiltinScalarFunction, DataFusionError>

Parses a string s to return a value of this type.

impl Hash for BuiltinScalarFunction

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl IntoEnumIterator for BuiltinScalarFunction

type Iterator = BuiltinScalarFunctionIter

fn iter() -> BuiltinScalarFunctionIter

impl PartialEq for BuiltinScalarFunction

fn eq(&self, other: &BuiltinScalarFunction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BuiltinScalarFunction

impl Eq for BuiltinScalarFunction

impl StructuralPartialEq for BuiltinScalarFunction