Enum mz_expr::func::VariadicFunc

pub enum VariadicFunc {
    Coalesce,
    Greatest,
    Least,
    Concat,
    ConcatWs,
    MakeTimestamp,
    PadLeading,
    Substr,
    Replace,
    JsonbBuildArray,
    JsonbBuildObject,
    MapBuild {
        value_type: ScalarType,
    },
    ArrayCreate {
        elem_type: ScalarType,
    },
    ArrayToString {
        elem_type: ScalarType,
    },
    ArrayIndex {
        offset: i64,
    },
    ListCreate {
        elem_type: ScalarType,
    },
    RecordCreate {
        field_names: Vec<ColumnName>,
    },
    ListIndex,
    ListSliceLinear,
    SplitPart,
    RegexpMatch,
    HmacString,
    HmacBytes,
    ErrorIfNull,
    DateBinTimestamp,
    DateBinTimestampTz,
    DateDiffTimestamp,
    DateDiffTimestampTz,
    DateDiffDate,
    DateDiffTime,
    And,
    Or,
    RangeCreate {
        elem_type: ScalarType,
    },
    MakeAclItem,
    MakeMzAclItem,
    Translate,
    ArrayPosition,
    ArrayFill {
        elem_type: ScalarType,
    },
    TimezoneTime,
    RegexpSplitToArray,
    RegexpReplace,
}

Variants

Coalesce

Greatest

Least

Concat

ConcatWs

MakeTimestamp

PadLeading

Substr

Replace

JsonbBuildArray

JsonbBuildObject

MapBuild

Fields

value_type: ScalarType

ArrayCreate

Fields

elem_type: ScalarType

ArrayToString

Fields

elem_type: ScalarType

ArrayIndex

Fields

offset: i64

ListCreate

Fields

elem_type: ScalarType

RecordCreate

Fields

field_names: Vec<ColumnName>

ListIndex

ListSliceLinear

SplitPart

RegexpMatch

HmacString

HmacBytes

ErrorIfNull

DateBinTimestamp

DateBinTimestampTz

DateDiffTimestamp

DateDiffTimestampTz

DateDiffDate

DateDiffTime

And

Or

RangeCreate

Fields

elem_type: ScalarType

MakeAclItem

MakeMzAclItem

Translate

ArrayPosition

ArrayFill

Fields

elem_type: ScalarType

TimezoneTime

RegexpSplitToArray

RegexpReplace

Implementations

impl VariadicFunc

pub fn eval<'a>( &'a self, datums: &[Datum<'a>], temp_storage: &'a RowArena, exprs: &'a [MirScalarExpr], ) -> Result<Datum<'a>, EvalError>

pub fn is_associative(&self) -> bool

pub fn output_type(&self, input_types: Vec<ColumnType>) -> ColumnType

pub fn propagates_nulls(&self) -> bool

Whether the function output is NULL if any of its inputs are NULL.

pub fn introduces_nulls(&self) -> bool

Whether the function might return NULL even if none of its inputs are NULL.

This is presently conservative, and may indicate that a function introduces nulls even when it does not.

pub fn switch_and_or(&self) -> Self

pub fn is_infix_op(&self) -> bool

pub fn unit_of_and_or(&self) -> MirScalarExpr

Gives the unit (u) of OR or AND, such that u AND/OR x == x. Note that a 0-arg AND/OR evaluates to unit_of_and_or.

pub fn zero_of_and_or(&self) -> MirScalarExpr

Gives the zero (z) of OR or AND, such that z AND/OR x == z.

pub fn could_error(&self) -> bool

Returns true if the function could introduce an error on non-error inputs.

pub fn is_monotone(&self) -> bool

Returns true if the function is monotone. (Non-strict; either increasing or decreasing.) Monotone functions map ranges to ranges: ie. given a range of possible inputs, we can determine the range of possible outputs just by mapping the endpoints.

This describes the pointwise behaviour of the function: ie. if more than one argument is provided, this describes the behaviour of any specific argument as the others are held constant. (For example, COALESCE(a, b) is monotone in a because for any particular value of b, increasing a will never cause the result to decrease.)

This property describes the behaviour of the function over ranges where the function is defined: ie. the arguments and the result are non-error datums.

Trait Implementations

impl Arbitrary for VariadicFunc

An explicit Arbitrary implementation needed here because of a known proptest issue.

Revert to the derive-macro impementation once the issue¹ is fixed.

---

1. https://github.com/AltSysrq/proptest/issues/152 ↩

type Parameters = ()

The type of parameters that arbitrary_with accepts for configuration of the generated Strategy. Parameters must implement Default.

type Strategy = Union<BoxedStrategy<VariadicFunc>>

The type of Strategy used to generate values of type Self.

fn arbitrary_with(_: Self::Parameters) -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self). The strategy is passed the arguments given in args.

fn arbitrary() -> Self::Strategy

Generates a Strategy for producing arbitrary values of type the implementing type (Self).

impl Clone for VariadicFunc

fn clone(&self) -> VariadicFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VariadicFunc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VariadicFunc

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for VariadicFunc

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

Formats the value using the given formatter.

impl Hash for VariadicFunc

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

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 MzReflect for VariadicFunc

fn add_to_reflected_type_info(rti: &mut ReflectedTypeInfo)

Adds names and types of the fields of the struct or enum to rti.

impl Ord for VariadicFunc

fn cmp(&self, other: &VariadicFunc) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VariadicFunc

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for VariadicFunc

fn partial_cmp(&self, other: &VariadicFunc) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl RustType<ProtoVariadicFunc> for VariadicFunc

fn into_proto(&self) -> ProtoVariadicFunc

Convert a Self into a Proto value.

fn from_proto(proto: ProtoVariadicFunc) -> Result<Self, TryFromProtoError>

Consume and convert a Proto back into a Self value.

fn into_proto_owned(self) -> Proto

A zero clone version of Self::into_proto that types can optionally implement, otherwise, the default implementation delegates to Self::into_proto.

impl Serialize for VariadicFunc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for VariadicFunc

impl StructuralPartialEq for VariadicFunc