Module physical_expr

re-export of datafusion_physical_expr crate

Modules

aggregate

analysis

Interval and selectivity in AnalysisContext

async_scalar_function

binary_map

equivalence

execution_props

expressions

Defines physical expressions that can evaluated at runtime during query execution

intervals

Interval arithmetic and constraint propagation library

planner

schema_rewriter

Physical expression schema rewriting utilities

simplifier

Simplifier for Physical Expressions

statistics

Statistics and constraint propagation library

tree_node

utils

window

Structs

AnalysisContext

The shared context used during the analysis of an expression. Includes the boundaries for all known columns.

ConstExpr

A structure representing a expression known to be constant in a physical execution plan.

DefaultPhysicalExprAdapter

Default implementation for rewriting physical expressions to match different schemas.

EquivalenceProperties

EquivalenceProperties stores information about the output of a plan node that can be used to optimize the plan. Currently, it keeps track of:

ExprBoundaries

Represents the boundaries (e.g. min and max values) of a particular column

GroupsAccumulatorAdapter

An adapter that implements GroupsAccumulator for any Accumulator

LexOrdering

This object represents a lexicographical ordering and contains a vector of PhysicalSortExpr objects.

LexRequirement

This object represents a lexicographical ordering requirement and contains a vector of PhysicalSortRequirement objects.

NullState

Track the accumulator null state per row: if any values for that group were null and if any values have been seen at all for that group.

PhysicalSortExpr

Represents Sort operation for a column in a RecordBatch

PhysicalSortRequirement

Represents sort requirement associated with a plan

ScalarFunctionExpr

Physical expression of a scalar function

Enums

AcrossPartitions

Represents whether a constant expression’s value is uniform or varies across partitions. Has two variants:

Distribution

How data is distributed amongst partitions. See Partitioning for more details.

OrderingRequirements

Represents a plan’s input ordering requirements. Vector elements represent alternative ordering requirements in the order of preference. The list of alternatives can be either hard or soft, depending on whether the operator can work without an input ordering.

Partitioning

Output partitioning supported by ExecutionPlans.

Traits

PhysicalExpr

PhysicalExprs represent expressions such as A + 1 or CAST(c1 AS int).

Functions

add_offset_to_expr

Adds the offset value to Column indices inside expr. This function is generally used during the update of the right table schema in join operations.

add_offset_to_physical_sort_exprs

analyze

Attempts to refine column boundaries and compute a selectivity value.

calculate_union

Calculates the union (in the sense of UnionExec) EquivalenceProperties of the given EquivalenceProperties in eqps according to the given output schema (which need not be the same with those of lhs and rhs as details such as nullability may be different).

conjunction

Create a conjunction of the given predicates. If the input is empty, return a literal true. If the input contains a single predicate, return the predicate. Otherwise, return a conjunction of the predicates (e.g. a AND b AND c).

conjunction_opt

Create a conjunction of the given predicates. If the input is empty or the return None. If the input contains a single predicate, return Some(predicate). Otherwise, return a Some(..) of a conjunction of the predicates (e.g. Some(a AND b AND c)).

create_ordering

Converts logical sort expressions to physical sort expressions.

create_physical_expr

PhysicalExpr evaluate DataFusion expressions such as A + 1, or CAST(c1 AS int).

create_physical_exprs

Create vector of Physical Expression from a vector of logical expression

create_physical_sort_expr

Create a physical sort expression from a logical expression

create_physical_sort_exprs

Create vector of physical sort expression from a vector of logical expression

physical_exprs_bag_equal

Checks whether the given physical expression slices are equal in the sense of bags (multi-sets), disregarding their orderings.

physical_exprs_contains

This function is similar to the contains method of Vec. It finds whether expr is among physical_exprs.

physical_exprs_equal

Checks whether the given physical expression slices are equal.

split_conjunction

Assume the predicate is in the form of CNF, split the predicate to a Vec of PhysicalExprs.

Type Aliases

PhysicalExprRef

Shared PhysicalExpr.