Struct ScalarFunctionExpr

pub struct ScalarFunctionExpr { /* private fields */ }

Physical expression of a scalar function

Implementations

impl ScalarFunctionExpr

pub fn new( name: &str, fun: Arc<ScalarUDF>, args: Vec<Arc<dyn PhysicalExpr>>, return_field: Arc<Field>, ) -> ScalarFunctionExpr

Create a new Scalar function

pub fn try_new( fun: Arc<ScalarUDF>, args: Vec<Arc<dyn PhysicalExpr>>, schema: &Schema, ) -> Result<ScalarFunctionExpr, DataFusionError>

Create a new Scalar function

pub fn fun(&self) -> &ScalarUDF

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 with_nullable(self, nullable: bool) -> ScalarFunctionExpr

pub fn nullable(&self) -> bool

Trait Implementations

impl Debug for ScalarFunctionExpr

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

Formats the value using the given formatter.

impl Display for ScalarFunctionExpr

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

Formats the value using the given formatter.

impl Hash for ScalarFunctionExpr

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

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

fn as_any(&self) -> &(dyn Any + 'static)

Return a reference to Any that can be used for downcasting

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

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

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

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

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

Evaluate an expression against a RecordBatch

fn return_field( &self, _input_schema: &Schema, ) -> Result<Arc<Field>, DataFusionError>

The output field associated with this expression

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<ScalarFunctionExpr>, children: Vec<Arc<dyn PhysicalExpr>>, ) -> Result<Arc<dyn PhysicalExpr>, DataFusionError>

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

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

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

fn propagate_constraints( &self, interval: &Interval, children: &[&Interval], ) -> Result<Option<Vec<Interval>>, DataFusionError>

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

fn get_properties( &self, children: &[ExprProperties], ) -> Result<ExprProperties, DataFusionError>

Calculates the properties of this PhysicalExpr based on its children’s properties (i.e. order and range), recursively aggregating the information from its children. In cases where the PhysicalExpr has no children (e.g., Literal or Column), these properties should be specified externally, as the function defaults to unknown properties.

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

Format this PhysicalExpr in nice human readable “SQL” format

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

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

fn evaluate_statistics( &self, children: &[&Distribution], ) -> Result<Distribution, DataFusionError>

Computes the output statistics for the expression, given the input statistics.

fn propagate_statistics( &self, parent: &Distribution, children: &[&Distribution], ) -> Result<Option<Vec<Distribution>>, DataFusionError>

Updates children statistics using the given parent statistic for this expression.

fn snapshot(&self) -> Result<Option<Arc<dyn PhysicalExpr>>, DataFusionError>

Take a snapshot of this PhysicalExpr, if it is dynamic.

impl Eq for ScalarFunctionExpr

impl StructuralPartialEq for ScalarFunctionExpr