Enum ExprImpl

pub enum ExprImpl {
    CorrelatedInputRef(Box<CorrelatedInputRef>),
    InputRef(Box<InputRef>),
    Literal(Box<Literal>),
    FunctionCall(Box<FunctionCall>),
    FunctionCallWithLambda(Box<FunctionCallWithLambda>),
    AggCall(Box<AggCall>),
    Subquery(Box<Subquery>),
    TableFunction(Box<TableFunction>),
    WindowFunction(Box<WindowFunction>),
    UserDefinedFunction(Box<UserDefinedFunction>),
    Parameter(Box<Parameter>),
    Now(Box<Now>),
}

Variants

CorrelatedInputRef(Box<CorrelatedInputRef>)

InputRef(Box<InputRef>)

Literal(Box<Literal>)

FunctionCall(Box<FunctionCall>)

FunctionCallWithLambda(Box<FunctionCallWithLambda>)

AggCall(Box<AggCall>)

Subquery(Box<Subquery>)

TableFunction(Box<TableFunction>)

WindowFunction(Box<WindowFunction>)

UserDefinedFunction(Box<UserDefinedFunction>)

Parameter(Box<Parameter>)

Now(Box<Now>)

Implementations

impl ExprImpl

pub fn is_correlated_input_ref(&self) -> bool

Returns true if this is a ExprImpl::CorrelatedInputRef, otherwise false

pub fn as_correlated_input_ref_mut( &mut self, ) -> Option<&mut Box<CorrelatedInputRef>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::CorrelatedInputRef, otherwise None

pub fn as_correlated_input_ref(&self) -> Option<&Box<CorrelatedInputRef>>

Optionally returns references to the inner fields if this is a ExprImpl::CorrelatedInputRef, otherwise None

pub fn into_correlated_input_ref(self) -> Result<Box<CorrelatedInputRef>, Self>

Returns the inner fields if this is a ExprImpl::CorrelatedInputRef, otherwise returns back the enum in the Err case of the result

pub fn is_input_ref(&self) -> bool

Returns true if this is a ExprImpl::InputRef, otherwise false

pub fn as_input_ref_mut(&mut self) -> Option<&mut Box<InputRef>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::InputRef, otherwise None

pub fn as_input_ref(&self) -> Option<&Box<InputRef>>

Optionally returns references to the inner fields if this is a ExprImpl::InputRef, otherwise None

pub fn into_input_ref(self) -> Result<Box<InputRef>, Self>

Returns the inner fields if this is a ExprImpl::InputRef, otherwise returns back the enum in the Err case of the result

pub fn is_literal(&self) -> bool

Returns true if this is a ExprImpl::Literal, otherwise false

pub fn as_literal_mut(&mut self) -> Option<&mut Box<Literal>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::Literal, otherwise None

pub fn as_literal(&self) -> Option<&Box<Literal>>

Optionally returns references to the inner fields if this is a ExprImpl::Literal, otherwise None

pub fn into_literal(self) -> Result<Box<Literal>, Self>

Returns the inner fields if this is a ExprImpl::Literal, otherwise returns back the enum in the Err case of the result

pub fn is_function_call(&self) -> bool

Returns true if this is a ExprImpl::FunctionCall, otherwise false

pub fn as_function_call_mut(&mut self) -> Option<&mut Box<FunctionCall>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::FunctionCall, otherwise None

pub fn as_function_call(&self) -> Option<&Box<FunctionCall>>

Optionally returns references to the inner fields if this is a ExprImpl::FunctionCall, otherwise None

pub fn into_function_call(self) -> Result<Box<FunctionCall>, Self>

Returns the inner fields if this is a ExprImpl::FunctionCall, otherwise returns back the enum in the Err case of the result

pub fn is_function_call_with_lambda(&self) -> bool

Returns true if this is a ExprImpl::FunctionCallWithLambda, otherwise false

pub fn as_function_call_with_lambda_mut( &mut self, ) -> Option<&mut Box<FunctionCallWithLambda>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::FunctionCallWithLambda, otherwise None

pub fn as_function_call_with_lambda( &self, ) -> Option<&Box<FunctionCallWithLambda>>

Optionally returns references to the inner fields if this is a ExprImpl::FunctionCallWithLambda, otherwise None

pub fn into_function_call_with_lambda( self, ) -> Result<Box<FunctionCallWithLambda>, Self>

Returns the inner fields if this is a ExprImpl::FunctionCallWithLambda, otherwise returns back the enum in the Err case of the result

pub fn is_agg_call(&self) -> bool

Returns true if this is a ExprImpl::AggCall, otherwise false

pub fn as_agg_call_mut(&mut self) -> Option<&mut Box<AggCall>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::AggCall, otherwise None

pub fn as_agg_call(&self) -> Option<&Box<AggCall>>

Optionally returns references to the inner fields if this is a ExprImpl::AggCall, otherwise None

pub fn into_agg_call(self) -> Result<Box<AggCall>, Self>

Returns the inner fields if this is a ExprImpl::AggCall, otherwise returns back the enum in the Err case of the result

pub fn is_subquery(&self) -> bool

Returns true if this is a ExprImpl::Subquery, otherwise false

pub fn as_subquery_mut(&mut self) -> Option<&mut Box<Subquery>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::Subquery, otherwise None

pub fn as_subquery(&self) -> Option<&Box<Subquery>>

Optionally returns references to the inner fields if this is a ExprImpl::Subquery, otherwise None

pub fn into_subquery(self) -> Result<Box<Subquery>, Self>

Returns the inner fields if this is a ExprImpl::Subquery, otherwise returns back the enum in the Err case of the result

pub fn is_table_function(&self) -> bool

Returns true if this is a ExprImpl::TableFunction, otherwise false

pub fn as_table_function_mut(&mut self) -> Option<&mut Box<TableFunction>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::TableFunction, otherwise None

pub fn as_table_function(&self) -> Option<&Box<TableFunction>>

Optionally returns references to the inner fields if this is a ExprImpl::TableFunction, otherwise None

pub fn into_table_function(self) -> Result<Box<TableFunction>, Self>

Returns the inner fields if this is a ExprImpl::TableFunction, otherwise returns back the enum in the Err case of the result

pub fn is_window_function(&self) -> bool

Returns true if this is a ExprImpl::WindowFunction, otherwise false

pub fn as_window_function_mut(&mut self) -> Option<&mut Box<WindowFunction>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::WindowFunction, otherwise None

pub fn as_window_function(&self) -> Option<&Box<WindowFunction>>

Optionally returns references to the inner fields if this is a ExprImpl::WindowFunction, otherwise None

pub fn into_window_function(self) -> Result<Box<WindowFunction>, Self>

Returns the inner fields if this is a ExprImpl::WindowFunction, otherwise returns back the enum in the Err case of the result

pub fn is_user_defined_function(&self) -> bool

Returns true if this is a ExprImpl::UserDefinedFunction, otherwise false

pub fn as_user_defined_function_mut( &mut self, ) -> Option<&mut Box<UserDefinedFunction>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::UserDefinedFunction, otherwise None

pub fn as_user_defined_function(&self) -> Option<&Box<UserDefinedFunction>>

Optionally returns references to the inner fields if this is a ExprImpl::UserDefinedFunction, otherwise None

pub fn into_user_defined_function( self, ) -> Result<Box<UserDefinedFunction>, Self>

Returns the inner fields if this is a ExprImpl::UserDefinedFunction, otherwise returns back the enum in the Err case of the result

pub fn is_parameter(&self) -> bool

Returns true if this is a ExprImpl::Parameter, otherwise false

pub fn as_parameter_mut(&mut self) -> Option<&mut Box<Parameter>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::Parameter, otherwise None

pub fn as_parameter(&self) -> Option<&Box<Parameter>>

Optionally returns references to the inner fields if this is a ExprImpl::Parameter, otherwise None

pub fn into_parameter(self) -> Result<Box<Parameter>, Self>

Returns the inner fields if this is a ExprImpl::Parameter, otherwise returns back the enum in the Err case of the result

pub fn is_now(&self) -> bool

Returns true if this is a ExprImpl::Now, otherwise false

pub fn as_now_mut(&mut self) -> Option<&mut Box<Now>>

Optionally returns mutable references to the inner fields if this is a ExprImpl::Now, otherwise None

pub fn as_now(&self) -> Option<&Box<Now>>

Optionally returns references to the inner fields if this is a ExprImpl::Now, otherwise None

pub fn into_now(self) -> Result<Box<Now>, Self>

Returns the inner fields if this is a ExprImpl::Now, otherwise returns back the enum in the Err case of the result

impl ExprImpl

pub fn variant_name(&self) -> &'static str

impl ExprImpl

pub fn literal_int(v: i32) -> Self

A literal int value.

pub fn literal_bigint(v: i64) -> Self

A literal bigint value

pub fn literal_f64(v: f64) -> Self

A literal float64 value.

pub fn literal_bool(v: bool) -> Self

A literal boolean value.

pub fn literal_varchar(v: String) -> Self

A literal varchar value.

pub fn literal_null(element_type: DataType) -> Self

A literal null value.

pub fn literal_jsonb(v: JsonbVal) -> Self

A literal jsonb value.

pub fn literal_list(v: ListValue, element_type: DataType) -> Self

A literal list value.

pub fn take(&mut self) -> Self

Takes the expression, leaving a literal null of the same type in its place.

pub fn count_star() -> Self

A count(*) aggregate function.

pub fn and(exprs: impl IntoIterator<Item = ExprImpl>) -> Self

Create a new expression by merging the given expressions by And.

If exprs is empty, return a literal true.

pub fn or(exprs: impl IntoIterator<Item = ExprImpl>) -> Self

Create a new expression by merging the given expressions by Or.

If exprs is empty, return a literal false.

pub fn collect_input_refs(&self, input_col_num: usize) -> FixedBitSet

Collect all InputRefs’ indexes in the expression.

Panics

Panics if input_ref >= input_col_num.

pub fn is_pure(&self) -> bool

Check if the expression has no side effects and output is deterministic

pub fn is_impure(&self) -> bool

pub fn count_nows(&self) -> usize

Count Nows in the expression.

pub fn is_null(&self) -> bool

Check whether self is literal NULL.

pub fn is_untyped(&self) -> bool

Check whether self is a literal NULL or literal string.

pub fn cast_implicit(self, target: DataType) -> Result<ExprImpl, CastError>

Shorthand to create cast expr to target type in implicit context.

pub fn cast_assign(self, target: DataType) -> Result<ExprImpl, CastError>

Shorthand to create cast expr to target type in assign context.

pub fn cast_explicit(self, target: DataType) -> Result<ExprImpl, CastError>

Shorthand to create cast expr to target type in explicit context.

pub fn cast_implicit_mut(&mut self, target: DataType) -> Result<(), CastError>

Shorthand to inplace cast expr to target type in implicit context.

pub fn cast_explicit_mut(&mut self, target: DataType) -> Result<(), CastError>

Shorthand to inplace cast expr to target type in explicit context.

pub fn cast_to_regclass(self) -> Result<ExprImpl, CastError>

Casting to Regclass type means getting the oid of expr. See https://www.postgresql.org/docs/current/datatype-oid.html

pub fn cast_to_regclass_mut(&mut self) -> Result<(), CastError>

Shorthand to inplace cast expr to regclass type.

pub fn ensure_array_type(&self) -> Result<(), ErrorCode>

Ensure the return type of this expression is an array of some type.

pub fn try_into_map_type(&self) -> Result<MapType, ErrorCode>

Ensure the return type of this expression is a map of some type.

pub fn enforce_bool_clause(self, clause: &str) -> Result<ExprImpl, RwError>

Shorthand to enforce implicit cast to boolean

pub fn cast_output(self) -> Result<ExprImpl, RwError>

Create “cast” expr to string (varchar) type. This is different from a real cast, as boolean is converted to a single char rather than full word.

Choose between cast_output and cast_{assign,explicit}(Varchar) based on PostgreSQL’s behavior on bools. For example, concat(':', true) is :t but ':' || true is :true. All other types have the same behavior when formatting to output and casting to string.

References in PostgreSQL:

• cast
• impl

pub async fn eval_row(&self, input: &OwnedRow) -> Result<Datum, RwError>

Evaluate the expression on the given input.

TODO: This is a naive implementation. We should avoid proto ser/de. Tracking issue: https://github.com/risingwavelabs/risingwave/issues/3479

pub fn try_fold_const(&self) -> Option<Result<Datum, RwError>>

Try to evaluate an expression if it’s a constant expression by ExprImpl::is_const.

Returns…

• None if it’s not a constant expression,
• Some(Ok(_)) if constant evaluation succeeds,
• Some(Err(_)) if there’s an error while evaluating a constant expression.

pub fn fold_const(&self) -> Result<Datum, RwError>

Similar to ExprImpl::try_fold_const, but panics if the expression is not constant.

impl ExprImpl

pub fn has_input_ref(&self) -> bool

pub fn has_literal(&self) -> bool

pub fn has_function_call(&self) -> bool

pub fn has_function_call_with_lambda(&self) -> bool

pub fn has_agg_call(&self) -> bool

pub fn has_subquery(&self) -> bool

pub fn has_table_function(&self) -> bool

pub fn has_window_function(&self) -> bool

pub fn has_now(&self) -> bool

impl ExprImpl

pub fn has_correlated_input_ref(&self, _: Infallible) -> bool

This function is not meant to be called. In most cases you would want ExprImpl::has_correlated_input_ref_by_depth.

When an expr contains a CorrelatedInputRef with lower depth, the whole expr is still considered to be uncorrelated, and can be checked with ExprImpl::has_subquery as well. See examples on crate::binder::BoundQuery::is_correlated for details.

This is a placeholder to trigger a compiler error when a trivial implementation checking for enum variant is generated by accident. It cannot be called either because you cannot pass Infallible to it.

pub fn has_correlated_input_ref_by_depth(&self, depth: Depth) -> bool

Used to check whether the expression has CorrelatedInputRef.

This is the core logic that supports crate::binder::BoundQuery::is_correlated. Check the doc of it for examples of depth being equal, less or greater.

pub fn has_correlated_input_ref_by_correlated_id( &self, correlated_id: CorrelatedId, ) -> bool

pub fn collect_correlated_indices_by_depth_and_assign_id( &mut self, depth: Depth, correlated_id: CorrelatedId, ) -> Vec<usize>

Collect CorrelatedInputRefs in ExprImpl by relative depth, return their indices, and assign absolute correlated_id for them.

pub fn is_const(&self) -> bool

Checks whether this is a constant expr that can be evaluated over a dummy chunk.

The expression tree should only consist of literals and pure function calls.

pub fn as_eq_cond(&self) -> Option<(InputRef, InputRef)>

Returns the InputRefs of an Equality predicate if it matches ordered by the canonical ordering (lower, higher), else returns None

pub fn as_is_not_distinct_from_cond(&self) -> Option<(InputRef, InputRef)>

pub fn reverse_comparison(comparison: ExprType) -> ExprType

pub fn as_comparison_cond(&self) -> Option<(InputRef, ExprType, InputRef)>

pub fn as_now_comparison_cond(&self) -> Option<(ExprImpl, ExprType, ExprImpl)>

Accepts expressions of the form input_expr cmp now_expr or now_expr cmp input_expr, where input_expr contains an InputRef and contains no now(), and now_expr contains a now() but no InputRef.

Canonicalizes to the first ordering and returns (input_expr, cmp, now_expr)

pub(crate) fn as_input_comparison_cond(&self) -> Option<InequalityInputPair>

Accepts expressions of the form InputRef cmp InputRef [+- const_expr] or InputRef [+- const_expr] cmp InputRef.

fn as_input_offset(&self) -> Option<(usize, Option<(ExprType, ExprImpl)>)>

Returns the InputRef and offset of a predicate if it matches the form InputRef [+- const_expr], else returns None.

pub fn as_eq_const(&self) -> Option<(InputRef, ExprImpl)>

pub fn as_eq_correlated_input_ref( &self, ) -> Option<(InputRef, CorrelatedInputRef)>

pub fn as_is_null(&self) -> Option<InputRef>

pub fn as_comparison_const(&self) -> Option<(InputRef, ExprType, ExprImpl)>

pub fn as_in_const_list(&self) -> Option<(InputRef, Vec<ExprImpl>)>

pub fn as_or_disjunctions(&self) -> Option<Vec<ExprImpl>>

pub fn to_project_set_select_item_proto(&self) -> ProjectSetSelectItem

pub fn from_expr_proto(proto: &ExprNode) -> Result<Self, RwError>

Trait Implementations

impl Clone for ExprImpl

fn clone(&self) -> ExprImpl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExprImpl

A custom Debug implementation that is more concise and suitable to use with std::fmt::Formatter::debug_list in plan nodes. If the verbose output is preferred, it is still available via {:#?}.

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

Formats the value using the given formatter.

impl Expr for ExprImpl

fn return_type(&self) -> DataType

Get the return type of the expr

fn to_expr_proto(&self) -> ExprNode

Serialize the expression

impl From<AggCall> for ExprImpl

fn from(o: AggCall) -> ExprImpl

Converts to this type from the input type.

impl From<Condition> for ExprImpl

fn from(c: Condition) -> Self

Converts to this type from the input type.

impl From<CorrelatedInputRef> for ExprImpl

fn from(o: CorrelatedInputRef) -> ExprImpl

Converts to this type from the input type.

impl From<FunctionCall> for ExprImpl

fn from(o: FunctionCall) -> ExprImpl

Converts to this type from the input type.

impl From<FunctionCallWithLambda> for ExprImpl

fn from(o: FunctionCallWithLambda) -> ExprImpl

Converts to this type from the input type.

impl From<InputRef> for ExprImpl

fn from(o: InputRef) -> ExprImpl

Converts to this type from the input type.

impl From<Literal> for ExprImpl

fn from(o: Literal) -> ExprImpl

Converts to this type from the input type.

impl From<Now> for ExprImpl

fn from(o: Now) -> ExprImpl

Converts to this type from the input type.

impl From<Parameter> for ExprImpl

fn from(o: Parameter) -> ExprImpl

Converts to this type from the input type.

impl From<Subquery> for ExprImpl

fn from(o: Subquery) -> ExprImpl

Converts to this type from the input type.

impl From<TableFunction> for ExprImpl

fn from(o: TableFunction) -> ExprImpl

Converts to this type from the input type.

impl From<UserDefinedFunction> for ExprImpl

fn from(o: UserDefinedFunction) -> ExprImpl

Converts to this type from the input type.

impl From<WindowFunction> for ExprImpl

fn from(o: WindowFunction) -> ExprImpl

Converts to this type from the input type.

impl Hash for ExprImpl

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 PartialEq for ExprImpl

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

impl StructuralPartialEq for ExprImpl