Module datafusion::physical_expr

re-export of datafusion_physical_expr crate

Modules

• aggregate
• array_expressions
  Array expressions
• conditional_expressions
• crypto_expressions
  Crypto expressions
• datetime_expressions
  DateTime expressions
• encoding_expressions
  Encoding expressions
• equivalence
• execution_props
• expressions
  Defines physical expressions that can evaluated at runtime during query execution
• functions
  Declaration of built-in (scalar) functions. This module contains built-in functions’ enumeration and metadata.
• hash_utils
  Functionality used both on logical and physical plans
• intervals
  Interval arithmetic and constraint propagation library
• math_expressions
  Math expressions
• planner
• regex_expressions
  Regex expressions
• string_expressions
  String expressions
• struct_expressions
  Struct expressions
• tree_node
  This module provides common traits for visiting or rewriting tree nodes easily.
• udf
  UDF support
• unicode_expressions
  Unicode expressions
• utils
• var_provider
  Variable provider
• window

Macros

• analysis_expect
• binary_array_op
  The binary_array_op macro includes types that extend beyond the primitive, such as Utf8 strings.
• binary_array_op_dyn_scalar
  The binary_array_op_dyn_scalar macro includes types that extend beyond the primitive, such as Utf8 strings.

Structs

• AnalysisContext
  The shared context used during the analysis of an expression. Includes the boundaries for all known columns.
• EquivalenceProperties
  Represents a collection of EquivalentClass (equivalences between columns in relations)
• EquivalentClass
  EquivalentClass is a set of Columns or PhysicalSortExprs that are known to have the same value in all tuples in a relation. EquivalentClass<Column> is generated by equality predicates, typically equijoin conditions and equality conditions in filters. EquivalentClass<PhysicalSortExpr> is generated by the ROW_NUMBER window function.
• ExprBoundaries
  Represents the boundaries of the resulting value from a physical expression, if it were to be an expression, if it were to be evaluated.
• GroupsAccumulatorAdapter
  An adapter that implements GroupsAccumulator for any Accumulator
• 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

• EmitTo
  Describes how many rows should be emitted during grouping.

Traits

• AggregateExpr
  An aggregate expression that:
• GroupsAccumulator
  GroupAccumulator implements a single aggregate (e.g. AVG) and stores the state for all groups internally.
• PhysicalExpr
  Expression that can be evaluated against a RecordBatch A Physical expression knows its type, nullability and how to evaluate itself.

Functions

• analyze
  Attempts to refine column boundaries and compute a selectivity value.
• create_physical_expr
  Create a physical expression from a logical expression (Expr).
• expr_list_eq_any_order
  Compare the two expr lists are equal no matter the order. For example two InListExpr can be considered to be equals no matter the order:
• expr_list_eq_strict_order
  Strictly compare the two expr lists are equal in the given order.
• normalize_expr_with_equivalence_properties
• normalize_out_expr_with_columns_map
  Normalize the output expressions based on Columns Map.
• project_equivalence_properties
  This function applies the given projection to the given equivalence properties to compute the resulting (projected) equivalence properties; e.g.
• project_ordering_equivalence_properties
  This function applies the given projection to the given ordering equivalence properties to compute the resulting (projected) ordering equivalence properties; e.g.
• reverse_order_bys
  Reverses the ORDER BY expression, which is useful during equivalent window expression construction. For instance, ‘ORDER BY a ASC, NULLS LAST’ turns into ‘ORDER BY a DESC, NULLS FIRST’.
• split_conjunction
  Assume the predicate is in the form of CNF, split the predicate to a Vec of PhysicalExprs.

Type Definitions

• LexOrdering
  LexOrdering is a type alias for lexicographical ordering definitionVec<PhysicalSortExpr>
• LexOrderingRef
  LexOrderingRef is a type alias for lexicographical ordering reference &[PhysicalSortExpr]
• LexOrderingReq
  LexOrderingReq is a type alias for lexicographical ordering requirement definitionVec<PhysicalSortRequirement>
• OrderingEquivalenceProperties
  OrderingEquivalenceProperties keeps track of columns that describe the global ordering of the schema. These columns are not necessarily same; e.g.
• OrderingEquivalentClass
  LexOrdering stores the lexicographical ordering for a schema. OrderingEquivalentClass keeps track of different alternative orderings than can describe the schema. For instance, for the table below |a|b|c|d| |1|4|3|1| |2|3|3|2| |3|1|2|2| |3|2|1|3| both vec![a ASC, b ASC] and vec![c DESC, d ASC] describe the ordering of the table. For this case, we say that vec![a ASC, b ASC], and vec![c DESC, d ASC] are ordering equivalent.
• PhysicalExprRef
  Shared PhysicalExpr.