Enum deltalake::datafusion::logical_expr::BuiltinScalarFunction

pub enum BuiltinScalarFunction {
    Abs,
    Acos,
    Asin,
    Atan,
    Atan2,
    Acosh,
    Asinh,
    Atanh,
    Cbrt,
    Ceil,
    Coalesce,
    Cos,
    Cosh,
    Decode,
    Degrees,
    Digest,
    Encode,
    Exp,
    Factorial,
    Floor,
    Gcd,
    Lcm,
    Isnan,
    Iszero,
    Ln,
    Log,
    Log10,
    Log2,
    Nanvl,
    Pi,
    Power,
    Radians,
    Round,
    Signum,
    Sin,
    Sinh,
    Sqrt,
    Tan,
    Tanh,
    Trunc,
    Cot,
    ArrayAppend,
    ArraySort,
    ArrayConcat,
    ArrayHas,
    ArrayHasAll,
    ArrayHasAny,
    ArrayPopFront,
    ArrayPopBack,
    ArrayDims,
    ArrayDistinct,
    ArrayElement,
    ArrayEmpty,
    ArrayLength,
    ArrayNdims,
    ArrayPosition,
    ArrayPositions,
    ArrayPrepend,
    ArrayRemove,
    ArrayRemoveN,
    ArrayRemoveAll,
    ArrayRepeat,
    ArrayReplace,
    ArrayReplaceN,
    ArrayReplaceAll,
    ArraySlice,
    ArrayToString,
    ArrayIntersect,
    ArrayUnion,
    ArrayExcept,
    Cardinality,
    ArrayResize,
    MakeArray,
    Flatten,
    Range,
    Struct,
    Ascii,
    BitLength,
    Btrim,
    CharacterLength,
    Chr,
    Concat,
    ConcatWithSeparator,
    DatePart,
    DateTrunc,
    DateBin,
    InitCap,
    Left,
    Lpad,
    Lower,
    Ltrim,
    MD5,
    NullIf,
    OctetLength,
    Random,
    RegexpReplace,
    Repeat,
    Replace,
    Reverse,
    Right,
    Rpad,
    Rtrim,
    SHA224,
    SHA256,
    SHA384,
    SHA512,
    SplitPart,
    StringToArray,
    StartsWith,
    Strpos,
    Substr,
    ToHex,
    ToTimestamp,
    ToTimestampMillis,
    ToTimestampMicros,
    ToTimestampNanos,
    ToTimestampSeconds,
    FromUnixtime,
    Now,
    CurrentDate,
    CurrentTime,
    Translate,
    Trim,
    Upper,
    Uuid,
    RegexpMatch,
    ArrowTypeof,
    OverLay,
    Levenshtein,
    SubstrIndex,
    FindInSet,
}

Enum of all built-in scalar functions

Variants

Abs

abs

Acos

acos

Asin

asin

Atan

atan

Atan2

atan2

Acosh

acosh

Asinh

asinh

Atanh

atanh

Cbrt

cbrt

Ceil

ceil

Coalesce

coalesce

Cos

cos

Cosh

cos

Decode

Decode

Degrees

degrees

Digest

Digest

Encode

Encode

Exp

exp

Factorial

factorial

Floor

floor

Gcd

gcd, Greatest common divisor

Lcm

lcm, Least common multiple

Isnan

isnan

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

Tan

tan

Tanh

tanh

Trunc

trunc

Cot

cot

ArrayAppend

array_append

ArraySort

array_sort

ArrayConcat

array_concat

ArrayHas

array_has

ArrayHasAll

array_has_all

ArrayHasAny

array_has_any

ArrayPopFront

array_pop_front

ArrayPopBack

array_pop_back

ArrayDims

array_dims

ArrayDistinct

array_distinct

ArrayElement

array_element

ArrayEmpty

array_empty

ArrayLength

array_length

ArrayNdims

array_ndims

ArrayPosition

array_position

ArrayPositions

array_positions

ArrayPrepend

array_prepend

ArrayRemove

array_remove

ArrayRemoveN

array_remove_n

ArrayRemoveAll

array_remove_all

ArrayRepeat

array_repeat

ArrayReplace

array_replace

ArrayReplaceN

array_replace_n

ArrayReplaceAll

array_replace_all

ArraySlice

array_slice

ArrayToString

array_to_string

ArrayIntersect

array_intersect

ArrayUnion

array_union

ArrayExcept

array_except

Cardinality

cardinality

ArrayResize

array_resize

MakeArray

construct an array from columns

Flatten

Flatten

Range

Range

Struct

struct

Ascii

ascii

BitLength

bit_length

Btrim

btrim

CharacterLength

character_length

Chr

chr

Concat

concat

ConcatWithSeparator

concat_ws

DatePart

date_part

DateTrunc

date_trunc

DateBin

date_bin

InitCap

initcap

Left

left

Lpad

lpad

Lower

lower

Ltrim

ltrim

MD5

md5

NullIf

nullif

OctetLength

octet_length

Random

random

RegexpReplace

regexp_replace

Repeat

repeat

Replace

replace

Reverse

reverse

Right

right

Rpad

rpad

Rtrim

rtrim

SHA224

sha224

SHA256

sha256

SHA384

sha384

SHA512

Sha512

SplitPart

split_part

StringToArray

string_to_array

StartsWith

starts_with

Strpos

strpos

Substr

substr

ToHex

to_hex

ToTimestamp

to_timestamp

ToTimestampMillis

to_timestamp_millis

ToTimestampMicros

to_timestamp_micros

ToTimestampNanos

to_timestamp_nanos

ToTimestampSeconds

to_timestamp_seconds

FromUnixtime

from_unixtime

Now

now

CurrentDate

current_date

CurrentTime

current_time

Translate

translate

Trim

trim

Upper

upper

Uuid

uuid

RegexpMatch

regexp_match

ArrowTypeof

arrow_typeof

OverLay

overlay

Levenshtein

levenshtein

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