Struct datafusion_physical_expr::ScalarFunctionExpr

pub struct ScalarFunctionExpr { /* private fields */ }

Physical expression of a scalar function

Implementations

impl ScalarFunctionExpr

pub fn new( name: &str, fun: ScalarFunctionDefinition, args: Vec<Arc<dyn PhysicalExpr>>, return_type: DataType, monotonicity: Option<FuncMonotonicity>, supports_zero_argument: bool ) -> Self

Create a new Scalar function

pub fn fun(&self) -> &ScalarFunctionDefinition

Get the scalar function implementation

pub fn name(&self) -> &str

The name for this expression

pub fn args(&self) -> &[Arc<dyn PhysicalExpr>]

Input arguments

pub fn return_type(&self) -> &DataType

Data type produced by this expression

pub fn monotonicity(&self) -> &Option<FuncMonotonicity>

Monotonicity information of the function

Trait Implementations

impl Debug for ScalarFunctionExpr

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

Formats the value using the given formatter.

impl Display for ScalarFunctionExpr

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

Formats the value using the given formatter.

impl PartialEq<dyn Any> for ScalarFunctionExpr

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

Comparing name, args and return_type

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 PhysicalExpr for ScalarFunctionExpr

fn as_any(&self) -> &dyn Any

Return a reference to Any that can be used for downcasting

fn data_type(&self, _input_schema: &Schema) -> Result<DataType>

Get the data type of this expression, given the schema of the input

fn nullable(&self, _input_schema: &Schema) -> Result<bool>

Determine whether this expression is nullable, given the schema of the input

fn evaluate(&self, batch: &RecordBatch) -> Result<ColumnarValue>

Evaluate an expression against a RecordBatch

fn children(&self) -> Vec<Arc<dyn PhysicalExpr>>

Get a list of child PhysicalExpr that provide the input for this expr.

fn with_new_children( self: Arc<Self>, children: Vec<Arc<dyn PhysicalExpr>> ) -> Result<Arc<dyn PhysicalExpr>>

Returns a new PhysicalExpr where all children were replaced by new exprs.

fn dyn_hash(&self, state: &mut dyn Hasher)

Update the hash state with this expression requirements from Hash.

fn get_ordering(&self, children: &[SortProperties]) -> SortProperties

The order information of a PhysicalExpr can be estimated from its children. This is especially helpful for projection expressions. If we can ensure that the order of a PhysicalExpr to project matches with the order of SortExec, we can eliminate that SortExecs.

fn evaluate_selection( &self, batch: &RecordBatch, selection: &BooleanArray ) -> Result<ColumnarValue>

Evaluate an expression against a RecordBatch after first applying a validity array

fn evaluate_bounds(&self, _children: &[&Interval]) -> Result<Interval>

Computes the output interval for the expression, given the input intervals.

fn propagate_constraints( &self, _interval: &Interval, _children: &[&Interval] ) -> Result<Option<Vec<Interval>>>

Updates bounds for child expressions, given a known interval for this expression.