Struct BinaryExpr 

pub struct BinaryExpr { /* private fields */ }

Binary expression

Implementations

impl BinaryExpr

pub fn new( left: Arc<dyn PhysicalExpr>, op: Operator, right: Arc<dyn PhysicalExpr>, ) -> Self

Create new binary expression

pub fn with_fail_on_overflow(self, fail_on_overflow: bool) -> Self

Create new binary expression with explicit fail_on_overflow value

pub fn left(&self) -> &Arc<dyn PhysicalExpr>

Get the left side of the binary expression

pub fn right(&self) -> &Arc<dyn PhysicalExpr>

Get the right side of the binary expression

pub fn op(&self) -> &Operator

Get the operator for this binary expression

impl BinaryExpr

pub fn try_from_proto( node: &PhysicalExprNode, ctx: &PhysicalExprDecodeCtx<'_>, ) -> Result<Arc<dyn PhysicalExpr>>

Available on crate feature proto only.

Reconstruct a BinaryExpr (or a left-deep tree of them when the proto uses the linearized operands form) from its protobuf representation.

Takes the whole PhysicalExprNode — the exact inverse of what PhysicalExpr::try_to_proto produces — so every expression’s try_from_proto shares one signature. The operator string is parsed via the canonical Operator::from_proto_name mapping, so no op argument needs to be threaded in by the caller.

Trait Implementations

impl Clone for BinaryExpr

fn clone(&self) -> BinaryExpr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BinaryExpr

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

Formats the value using the given formatter.

impl Display for BinaryExpr

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

Formats the value using the given formatter.

impl Eq for BinaryExpr

impl Hash for BinaryExpr

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 BinaryExpr

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

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl PhysicalExpr for BinaryExpr

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

For each operator, BinaryExpr has distinct rules. TODO: There may be rules specific to some data types and expression ranges.

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

Get the data type of this expression, given the schema of the input. Returns an error if the data type cannot be determined, ex. if the schema is missing a required field.

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 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.

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

👎Deprecated since 54.0.0:

Part of the unused Statistics V2 framework; see https://github.com/apache/datafusion/pull/22071

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

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

Format this PhysicalExpr in nice human readable “SQL” format

fn try_to_proto( &self, ctx: &PhysicalExprEncodeCtx<'_>, ) -> Result<Option<PhysicalExprNode>>

Available on crate feature proto only.

Serialize this expression to a PhysicalExprNode proto message.

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

The output field associated with this expression

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

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

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

👎Deprecated since 54.0.0:

Part of the unused Statistics V2 framework; see https://github.com/apache/datafusion/pull/22071

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.

fn snapshot_generation(&self) -> u64

Returns the generation of this PhysicalExpr for snapshotting purposes. The generation is an arbitrary u64 that can be used to track changes in the state of the PhysicalExpr over time without having to do an exhaustive comparison. This is useful to avoid unnecessary computation or serialization if there are no changes to the expression. In particular, dynamic expressions that may change over time; this allows cheap checks for changes. Static expressions that do not change over time should return 0, as does the default implementation. You should not call this method directly as it does not handle recursion. Instead use snapshot_generation to handle recursion and capture the full state of the PhysicalExpr.

fn is_volatile_node(&self) -> bool

Returns true if the expression node is volatile, i.e. whether it can return different results when evaluated multiple times with the same input.

fn placement(&self) -> ExpressionPlacement

Returns placement information for this expression.

fn expression_id(&self) -> Option<u64>

Return a stable, globally-unique identifier for this PhysicalExpr, if it has one.