Packages

object SubExprUtils extends PredicateHelper

Linear Supertypes
PredicateHelper, Logging, AliasHelper, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SubExprUtils
  2. PredicateHelper
  3. Logging
  4. AliasHelper
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def MDC(key: LogKey, value: Any): MDC
    Attributes
    protected
    Definition Classes
    Logging
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def buildBalancedPredicate(expressions: Seq[Expression], op: (Expression, Expression) => Expression): Expression

    Builds a balanced output predicate in bottom up approach, by applying binary operator op pair by pair on input predicates exprs recursively.

    Builds a balanced output predicate in bottom up approach, by applying binary operator op pair by pair on input predicates exprs recursively. Example: exprs = [a, b, c, d], op = And, returns (a And b) And (c And d) exprs = [a, b, c, d, e, f], op = And, returns ((a And b) And (c And d)) And (e And f)

    Attributes
    protected
    Definition Classes
    PredicateHelper
  7. def canEvaluate(expr: Expression, plan: LogicalPlan): Boolean

    Returns true if expr can be evaluated using only the output of plan.

    Returns true if expr can be evaluated using only the output of plan. This method can be used to determine when it is acceptable to move expression evaluation within a query plan.

    For example consider a join between two relations R(a, b) and S(c, d).

    - canEvaluate(EqualTo(a,b), R) returns true - canEvaluate(EqualTo(a,c), R) returns false - canEvaluate(Literal(1), R) returns true as literals CAN be evaluated on any plan

    Attributes
    protected
    Definition Classes
    PredicateHelper
  8. def canEvaluateWithinJoin(expr: Expression): Boolean

    Returns true iff expr could be evaluated as a condition within join.

    Returns true iff expr could be evaluated as a condition within join.

    Attributes
    protected
    Definition Classes
    PredicateHelper
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  10. def containsOuter(e: Expression): Boolean

    Returns true when an expression contains correlated predicates i.e outer references and returns false otherwise.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def extractPredicatesWithinOutputSet(condition: Expression, outputSet: AttributeSet): Option[Expression]

    Returns a filter that its reference is a subset of outputSet and it contains the maximum constraints from condition.

    Returns a filter that its reference is a subset of outputSet and it contains the maximum constraints from condition. This is used for predicate pushdown. When there is no such filter, None is returned.

    Attributes
    protected
    Definition Classes
    PredicateHelper
  14. def findExpressionAndTrackLineageDown(exp: Expression, plan: LogicalPlan): Option[(Expression, LogicalPlan)]

    Find the origin of where the input references of expression exp were scanned in the tree of plan, and if they originate from a single leaf node.

    Find the origin of where the input references of expression exp were scanned in the tree of plan, and if they originate from a single leaf node. Returns optional tuple with Expression, undoing any projections and aliasing that has been done along the way from plan to origin, and the origin LeafNode plan from which all the exp

    Definition Classes
    PredicateHelper
  15. def getAliasMap(exprs: Iterable[NamedExpression]): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  16. def getAliasMap(plan: Aggregate): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  17. def getAliasMap(plan: Project): AttributeMap[Alias]
    Attributes
    protected
    Definition Classes
    AliasHelper
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. def getCorrelatedEquivalentInnerExpressions(plan: LogicalPlan): ExpressionSet

    Returns the inner query expressions that are guaranteed to have a single value for each outer row.

    Returns the inner query expressions that are guaranteed to have a single value for each outer row. Therefore, a scalar subquery is allowed to group-by on these expressions. We can derive these from correlated equality predicates, though we need to take care about propagating this through operators like OUTER JOIN or UNION.

    Positive examples: - x = outer(a) AND y = outer(b) - x = 1 - x = outer(a) + 1 - cast(x as date) = current_date() + outer(b)

    Negative examples: - x <= outer(a) - x + y = outer(a) - x = outer(a) OR y = outer(b) - y + outer(b) = 1 (this and similar expressions could be supported, but very carefully) - An equality under the right side of a LEFT OUTER JOIN, e.g. select *, (select count(*) from y left join (select * from z where z1 = x1) sub on y2 = z2 group by z1) from x; - An equality under UNION e.g. select *, (select count(*) from (select * from y where y1 = x1 union all select * from y) group by y1) from x;

  20. def getCorrelatedPredicates(plan: LogicalPlan): Seq[Expression]

    Returns the correlated predicates from a logical plan.

    Returns the correlated predicates from a logical plan. The OuterReference wrapper is removed before returning the predicate to the caller.

  21. def getOuterReferences(plan: LogicalPlan): Seq[Expression]

    Returns all the expressions that have outer references from a logical plan.

    Returns all the expressions that have outer references from a logical plan. Currently only Filter operator can host outer references.

  22. def getOuterReferences(expr: Expression): Seq[Expression]

    Given an expression, returns the expressions which have outer references.

    Given an expression, returns the expressions which have outer references. Aggregate expressions are treated in a special way. If the children of aggregate expression contains an outer reference, then the entire aggregate expression is marked as an outer reference. Example (SQL):

    SELECT a FROM l GROUP by 1 HAVING EXISTS (SELECT 1 FROM r WHERE d < min(b))

    In the above case, we want to mark the entire min(b) as an outer reference OuterReference(min(b)) instead of min(OuterReference(b)). TODO: Currently we don't allow deep correlation. Also, we don't allow mixing of outer references and local references under an aggregate expression. For example (SQL):

    SELECT .. FROM p1
    WHERE EXISTS (SELECT ...
                  FROM p2
                  WHERE EXISTS (SELECT ...
                                FROM sq
                                WHERE min(p1.a + p2.b) = sq.c))
    
    SELECT .. FROM p1
    WHERE EXISTS (SELECT ...
                  FROM p2
                  WHERE EXISTS (SELECT ...
                                FROM sq
                                WHERE min(p1.a) + max(p2.b) = sq.c))
    
    SELECT .. FROM p1
    WHERE EXISTS (SELECT ...
                  FROM p2
                  WHERE EXISTS (SELECT ...
                                FROM sq
                                WHERE min(p1.a + sq.c) > 1))

    The code below needs to change when we support the above cases.

  23. def hasOuterReferences(plan: LogicalPlan): Boolean

    Given a logical plan, returns TRUE if it has an outer reference and false otherwise.

  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  26. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isLikelySelective(e: Expression): Boolean

    Returns whether an expression is likely to be selective

    Returns whether an expression is likely to be selective

    Definition Classes
    PredicateHelper
  29. def isNullIntolerant(expr: Expression): Boolean
    Attributes
    protected
    Definition Classes
    PredicateHelper
  30. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  31. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  32. def logBasedOnLevel(level: Level)(f: => MessageWithContext): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  46. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. final def mergeAliases(alias: Alias): Alias

    Merge an Alias(Alias(x)) into Alias(x) preserving metadata.

    Merge an Alias(Alias(x)) into Alias(x) preserving metadata.

    If the outer alias has explicit metadata, it is preserved. Else if the inner alias has explicit metadata, the result has explicit outer.metadata. Else both are deriving the metadata. the result is deriving metadata, with the union of noninheritable keys.

    alias

    An Alias with a child Alias, Alias(Alias(x))

    returns

    The merged alias, Alias(x)

    Attributes
    protected
    Definition Classes
    AliasHelper
  55. final def mergeAndTrimAliases(alias: Alias): Alias

    Merge any stack of aliases under the top-level alias, and then drops any aliases deeper in the expression tree.

    Merge any stack of aliases under the top-level alias, and then drops any aliases deeper in the expression tree. So Alias1(Alias2(Alias3(Foo(Alias4(x))))) becomes Alias5(Foo(x)) where Alias5 preserves the metadata of Alias{1,2,3} and the name and exprId of Alias1. Alias4 is simply removed.

    Attributes
    protected
    Definition Classes
    AliasHelper
    Annotations
    @tailrec()
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def nonEquivalentGroupbyCols(query: LogicalPlan, aggNode: Aggregate): ExpressionSet
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  60. def outputWithNullability(output: Seq[Attribute], nonNullAttrExprIds: Seq[ExprId]): Seq[Attribute]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  61. def replaceAlias(expr: Expression, aliasMap: AttributeMap[Alias]): Expression

    Replace all attributes, that reference an alias, with the aliased expression

    Replace all attributes, that reference an alias, with the aliased expression

    Attributes
    protected
    Definition Classes
    AliasHelper
  62. def replaceAliasButKeepName(expr: NamedExpression, aliasMap: AttributeMap[Alias]): NamedExpression

    Replace all attributes, that reference an alias, with the aliased expression, but keep the name of the outermost attribute.

    Replace all attributes, that reference an alias, with the aliased expression, but keep the name of the outermost attribute.

    Attributes
    protected
    Definition Classes
    AliasHelper
  63. def splitConjunctivePredicates(condition: Expression): Seq[Expression]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  64. def splitDisjunctivePredicates(condition: Expression): Seq[Expression]
    Attributes
    protected
    Definition Classes
    PredicateHelper
  65. def stripOuterReference[E <: Expression](e: E): E

    Returns an expression after removing the OuterReference shell.

  66. def stripOuterReferences(p: LogicalPlan): LogicalPlan

    Returns the logical plan after removing the OuterReference shell from all the expressions of the input logical plan.

  67. def stripOuterReferences[E <: Expression](e: Seq[E]): Seq[E]

    Returns the list of expressions after removing the OuterReference shell from each of the expression.

  68. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. def trimAliases(e: Expression): Expression
    Attributes
    protected
    Definition Classes
    AliasHelper
  71. def trimNonTopLevelAliases[T <: Expression](e: T): T
    Attributes
    protected
    Definition Classes
    AliasHelper
  72. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  73. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  74. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  75. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging
  76. def wrapOuterReference[E <: Expression](e: E): E

    Wrap attributes in the expression with OuterReferences.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from PredicateHelper

Inherited from Logging

Inherited from AliasHelper

Inherited from AnyRef

Inherited from Any

Ungrouped