Enum mz_sql::plan::expr::TableFunc

pub enum TableFunc {
    AclExplode,
    MzAclExplode,
    JsonbEach {
        stringify: bool,
    },
    JsonbObjectKeys,
    JsonbArrayElements {
        stringify: bool,
    },
    RegexpExtract(AnalyzedRegex),
    CsvExtract(usize),
    GenerateSeriesInt32,
    GenerateSeriesInt64,
    GenerateSeriesTimestamp,
    GenerateSeriesTimestampTz,
    Repeat,
    UnnestArray {
        el_typ: ScalarType,
    },
    UnnestList {
        el_typ: ScalarType,
    },
    UnnestMap {
        value_type: ScalarType,
    },
    Wrap {
        types: Vec<ColumnType>,
        width: usize,
    },
    GenerateSubscriptsArray,
    TabletizedScalar {
        name: String,
        relation: RelationType,
    },
}

Variants

AclExplode

MzAclExplode

JsonbEach

Fields

stringify: bool

JsonbObjectKeys

JsonbArrayElements

Fields

stringify: bool

RegexpExtract(AnalyzedRegex)

CsvExtract(usize)

GenerateSeriesInt32

GenerateSeriesInt64

GenerateSeriesTimestamp

GenerateSeriesTimestampTz

Repeat

UnnestArray

Fields

el_typ: ScalarType

UnnestList

Fields

el_typ: ScalarType

UnnestMap

Fields

value_type: ScalarType

Wrap

Given n input expressions, wraps them into n / width rows, each of width columns.

This function is not intended to be called directly by end users, but is useful in the planning of e.g. VALUES clauses.

Fields

types: Vec<ColumnType>

width: usize

GenerateSubscriptsArray

TabletizedScalar

Execute some arbitrary scalar function as a table function.

Fields

name: String

relation: RelationType

Implementations

impl TableFunc

pub fn eval<'a>( &'a self, datums: &'a [Datum<'a>], temp_storage: &'a RowArena, ) -> Result<Box<dyn Iterator<Item = (Row, i64)> + 'a>, EvalError>

pub fn output_type(&self) -> RelationType

pub fn output_arity(&self) -> usize

pub fn empty_on_null_input(&self) -> bool

pub fn preserves_monotonicity(&self) -> bool

True iff the table function preserves the append-only property of its input.

Trait Implementations

impl Arbitrary for TableFunc

type Parameters = (<bool as Arbitrary>::Parameters, <bool as Arbitrary>::Parameters, <AnalyzedRegex as Arbitrary>::Parameters, <usize as Arbitrary>::Parameters, <ScalarType as Arbitrary>::Parameters, <ScalarType as Arbitrary>::Parameters, <ScalarType as Arbitrary>::Parameters, (<Vec<ColumnType> as Arbitrary>::Parameters, <usize as Arbitrary>::Parameters), (<String as Arbitrary>::Parameters, <RelationType as Arbitrary>::Parameters))

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

type Strategy = Union<BoxedStrategy<TableFunc>>

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

fn arbitrary_with( _top: <TableFunc as Arbitrary>::Parameters, ) -> <TableFunc as Arbitrary>::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 TableFunc

fn clone(&self) -> TableFunc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TableFunc

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TableFunc

fn deserialize<__D>( __deserializer: __D, ) -> Result<TableFunc, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TableFunc

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

Formats the value using the given formatter.

impl Hash for TableFunc

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

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 TableFunc

fn cmp(&self, other: &TableFunc) -> 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 TableFunc

fn eq(&self, other: &TableFunc) -> 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 TableFunc

fn partial_cmp(&self, other: &TableFunc) -> 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<ProtoTableFunc> for TableFunc

fn into_proto(&self) -> ProtoTableFunc

Convert a Self into a Proto value.

fn from_proto(proto: ProtoTableFunc) -> Result<TableFunc, 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 TableFunc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for TableFunc

impl StructuralPartialEq for TableFunc