pub enum TableFunc {
Show 21 variants
AclExplode,
MzAclExplode,
JsonbEach {
stringify: bool,
},
JsonbObjectKeys,
JsonbArrayElements {
stringify: bool,
},
RegexpExtract(AnalyzedRegex),
CsvExtract(usize),
GenerateSeriesInt32,
GenerateSeriesInt64,
GenerateSeriesTimestamp,
GenerateSeriesTimestampTz,
GuardSubquerySize {
column_type: ScalarType,
},
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,
},
RegexpMatches,
WithOrdinality(WithOrdinality),
}
Expand description
When adding a new TableFunc
variant, please consider adding it to
TableFunc::with_ordinality
!
Variants§
AclExplode
MzAclExplode
JsonbEach
JsonbObjectKeys
JsonbArrayElements
RegexpExtract(AnalyzedRegex)
CsvExtract(usize)
GenerateSeriesInt32
GenerateSeriesInt64
GenerateSeriesTimestamp
GenerateSeriesTimestampTz
GuardSubquerySize
Supplied with an input count,
- Adds a column as if a typed subquery result,
- Filters the row away if the count is only one,
- Errors if the count is not exactly one. The intent is that this presents as if a subquery result with too many records contributing. The error column has the same type as the result should have, but we only produce it if the count exceeds one.
This logic could nearly be achieved with map, filter, project logic, but has been challenging to do in a way that respects the vagaries of SQL and our semantics. If we reveal a constant value in the column we risk the optimizer pruning the branch; if we reveal that this will not produce rows we risk the optimizer pruning the branch; if we reveal that the only possible value is an error we risk the optimizer propagating that error without guards.
Before replacing this by an MirScalarExpr
, quadruple check that it
would not result in misoptimizations due to expression evaluation order
being utterly undefined, and predicate pushdown trimming any fragments
that might produce columns that will not be needed.
Fields
column_type: ScalarType
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.
GenerateSubscriptsArray
TabletizedScalar
Execute some arbitrary scalar function as a table function.
RegexpMatches
WithOrdinality(WithOrdinality)
Implements the WITH ORDINALITY clause.
Don’t construct TableFunc::WithOrdinality
manually! Use the with_ordinality
constructor
function instead, which checks whether the given table function supports WithOrdinality
.
Implementations§
Source§impl TableFunc
impl TableFunc
Sourcepub fn with_ordinality(inner: TableFunc) -> Option<TableFunc>
pub fn with_ordinality(inner: TableFunc) -> Option<TableFunc>
Adds WITH ORDINALITY
to a table function if it’s allowed on the given table function.
Source§impl TableFunc
impl TableFunc
Sourcepub fn eval<'a>(
&'a self,
datums: &'a [Datum<'a>],
temp_storage: &'a RowArena,
) -> Result<Box<dyn Iterator<Item = (Row, Diff)> + 'a>, EvalError>
pub fn eval<'a>( &'a self, datums: &'a [Datum<'a>], temp_storage: &'a RowArena, ) -> Result<Box<dyn Iterator<Item = (Row, Diff)> + 'a>, EvalError>
Executes self
on the given input row (datums
).
pub fn output_type(&self) -> RelationType
pub fn output_arity(&self) -> usize
pub fn empty_on_null_input(&self) -> bool
Sourcepub fn preserves_monotonicity(&self) -> bool
pub fn preserves_monotonicity(&self) -> bool
True iff the table function preserves the append-only property of its input.
Trait Implementations§
Source§impl Arbitrary for TableFunc
Manual Arbitrary
, because proptest-derive is choking on the recursive WithOrdinality
variant.
impl Arbitrary for TableFunc
Manual Arbitrary
, because proptest-derive is choking on the recursive WithOrdinality
variant.
Source§type Parameters = ()
type Parameters = ()
arbitrary_with
accepts for configuration
of the generated Strategy
. Parameters must implement Default
.Source§type Strategy = BoxedStrategy<TableFunc>
type Strategy = BoxedStrategy<TableFunc>
Strategy
used to generate values of type Self
.Source§fn arbitrary_with(_: Self::Parameters) -> Self::Strategy
fn arbitrary_with(_: Self::Parameters) -> Self::Strategy
Source§impl<'de> Deserialize<'de> for TableFunc
impl<'de> Deserialize<'de> for TableFunc
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
Source§impl MzReflect for TableFunc
impl MzReflect for TableFunc
Source§fn add_to_reflected_type_info(rti: &mut ReflectedTypeInfo)
fn add_to_reflected_type_info(rti: &mut ReflectedTypeInfo)
rti
. Read moreSource§impl Ord for TableFunc
impl Ord for TableFunc
Source§impl PartialOrd for TableFunc
impl PartialOrd for TableFunc
Source§impl RustType<ProtoTableFunc> for TableFunc
impl RustType<ProtoTableFunc> for TableFunc
Source§fn into_proto(&self) -> ProtoTableFunc
fn into_proto(&self) -> ProtoTableFunc
Self
into a Proto
value.Source§fn from_proto(proto: ProtoTableFunc) -> Result<Self, TryFromProtoError>
fn from_proto(proto: ProtoTableFunc) -> Result<Self, TryFromProtoError>
Source§fn into_proto_owned(self) -> Proto
fn into_proto_owned(self) -> Proto
Self::into_proto
that types can
optionally implement, otherwise, the default implementation
delegates to Self::into_proto
.impl Eq for TableFunc
impl StructuralPartialEq for TableFunc
Auto Trait Implementations§
impl Freeze for TableFunc
impl RefUnwindSafe for TableFunc
impl Send for TableFunc
impl Sync for TableFunc
impl Unpin for TableFunc
impl UnwindSafe for TableFunc
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<Q, K> Comparable<K> for Q
impl<Q, K> Comparable<K> for Q
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key
and return true
if they are equal.Source§impl<T> FutureExt for T
impl<T> FutureExt for T
Source§fn with_context(self, otel_cx: Context) -> WithContext<Self>
fn with_context(self, otel_cx: Context) -> WithContext<Self>
Source§fn with_current_context(self) -> WithContext<Self>
fn with_current_context(self) -> WithContext<Self>
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> IntoRequest<T> for T
impl<T> IntoRequest<T> for T
Source§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T
in a tonic::Request
Source§impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
impl<T, U> OverrideFrom<Option<&T>> for Uwhere
U: OverrideFrom<T>,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
impl<P, R> ProtoType<R> for Pwhere
R: RustType<P>,
Source§fn into_rust(self) -> Result<R, TryFromProtoError>
fn into_rust(self) -> Result<R, TryFromProtoError>
RustType::from_proto
.Source§fn from_rust(rust: &R) -> P
fn from_rust(rust: &R) -> P
RustType::into_proto
.Source§impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
impl<'a, S, T> Semigroup<&'a S> for Twhere
T: Semigroup<S>,
Source§fn plus_equals(&mut self, rhs: &&'a S)
fn plus_equals(&mut self, rhs: &&'a S)
std::ops::AddAssign
, for types that do not implement AddAssign
.Source§impl<T> ServiceExt for T
impl<T> ServiceExt for T
Source§fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
fn map_response_body<F>(self, f: F) -> MapResponseBody<Self, F>where
Self: Sized,
Source§fn decompression(self) -> Decompression<Self>where
Self: Sized,
fn decompression(self) -> Decompression<Self>where
Self: Sized,
Source§fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
fn trace_for_http(self) -> Trace<Self, SharedClassifier<ServerErrorsAsFailures>>where
Self: Sized,
Source§fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
fn trace_for_grpc(self) -> Trace<Self, SharedClassifier<GrpcErrorsAsFailures>>where
Self: Sized,
Source§fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
fn follow_redirects(self) -> FollowRedirect<Self>where
Self: Sized,
Source§impl<T> ToStringFallible for Twhere
T: Display,
impl<T> ToStringFallible for Twhere
T: Display,
Source§fn try_to_string(&self) -> Result<String, TryReserveError>
fn try_to_string(&self) -> Result<String, TryReserveError>
ToString::to_string
, but without panic on OOM.