abstract class QueryPlan[PlanType <: QueryPlan[PlanType]] extends TreeNode[PlanType] with SQLConfHelper
An abstraction of the Spark SQL query plan tree, which can be logical or physical. This class defines some basic properties of a query plan node, as well as some new transform APIs to transform the expressions of the plan node.
Note that, the query plan is a mutually recursive structure:
QueryPlan -> Expression (subquery) -> QueryPlan
The tree traverse APIs like transform, foreach, collect, etc. that are
inherited from TreeNode, do not traverse into query plans inside subqueries.
- Self Type
- PlanType
- Alphabetic
- By Inheritance
- QueryPlan
- SQLConfHelper
- TreeNode
- WithOrigin
- TreePatternBits
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
- new QueryPlan()
Abstract Value Members
-
abstract
def
canEqual(that: Any): Boolean
- Definition Classes
- Equals
-
abstract
def
children: Seq[PlanType]
Returns a Seq of the children of this node.
Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization
- Definition Classes
- TreeNode
- abstract def output: Seq[Attribute]
-
abstract
def
productArity: Int
- Definition Classes
- Product
-
abstract
def
productElement(n: Int): Any
- Definition Classes
- Product
-
abstract
def
withNewChildrenInternal(newChildren: IndexedSeq[PlanType]): PlanType
- Attributes
- protected
- Definition Classes
- TreeNode
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
lazy val
allAttributes: AttributeSeq
All the attributes that are used for this plan.
-
def
apply(number: Int): TreeNode[_]
Returns the tree node at the specified number, used primarily for interactive debugging.
Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.
Note that this cannot return BaseType because logical plan's plan node might return physical plan for innerChildren, e.g. in-memory relation logical plan node has a reference to the physical plan node it is referencing.
- Definition Classes
- TreeNode
-
def
argString(maxFields: Int): String
Returns a string representing the arguments to this node, minus any children
Returns a string representing the arguments to this node, minus any children
- Definition Classes
- TreeNode
-
def
asCode: String
Returns a 'scala code' representation of this
TreeNodeand its children.Returns a 'scala code' representation of this
TreeNodeand its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure'TreeNodesthat only contain primitives and other TreeNodes, the result can be pasted in the REPL to build an equivalent Tree.- Definition Classes
- TreeNode
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
lazy val
canonicalized: PlanType
Returns a plan where a best effort attempt has been made to transform
thisin a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, expression id, etc.)Returns a plan where a best effort attempt has been made to transform
thisin a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, expression id, etc.)Plans where
this.canonicalized == other.canonicalizedwill always evaluate to the same result.Plan nodes that require special canonicalization should override doCanonicalize(). They should remove expressions cosmetic variations themselves.
- Annotations
- @transient()
-
def
clone(): PlanType
- Definition Classes
- TreeNode → AnyRef
-
def
collect[B](pf: PartialFunction[PlanType, B]): Seq[B]
Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.
Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.
- Definition Classes
- TreeNode
-
def
collectFirst[B](pf: PartialFunction[PlanType, B]): Option[B]
Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.
-
def
collectLeaves(): Seq[PlanType]
Returns a Seq containing the leaves in this tree.
Returns a Seq containing the leaves in this tree.
- Definition Classes
- TreeNode
-
def
collectWithSubqueries[B](f: PartialFunction[PlanType, B]): Seq[B]
A variant of
collect.A variant of
collect. This method not only apply the given function to all elements in this plan, also considering all the plans in its (nested) subqueries -
def
conf: SQLConf
The active config object within the current scope.
The active config object within the current scope. See SQLConf.get for more information.
- Definition Classes
- SQLConfHelper
-
final
def
containsAllPatterns(patterns: TreePattern*): Boolean
- returns
true if every bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
-
final
def
containsAnyPattern(patterns: TreePattern*): Boolean
- returns
true if at least one bit for
patternsis set; false otherwise.
- Definition Classes
- TreePatternBits
-
lazy val
containsChild: Set[TreeNode[_]]
- Definition Classes
- TreeNode
-
final
def
containsPattern(t: TreePattern): Boolean
- returns
true if the bit for
tis set; false otherwise.
- Definition Classes
- TreePatternBits
- Annotations
- @inline()
-
def
copyTagsFrom(other: PlanType): Unit
- Definition Classes
- TreeNode
-
lazy val
deterministic: Boolean
Returns true when the all the expressions in the current node as well as all of its children are deterministic
-
def
doCanonicalize(): PlanType
Defines how the canonicalization should work for the current plan.
Defines how the canonicalization should work for the current plan.
- Attributes
- protected
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exists(f: (PlanType) ⇒ Boolean): Boolean
Test whether there is TreeNode satisfies the conditions specified in
f. -
final
def
expressions: Seq[Expression]
Returns all of the expressions present in this query plan operator.
-
def
fastEquals(other: TreeNode[_]): Boolean
Faster version of equality which short-circuits when two treeNodes are the same instance.
Faster version of equality which short-circuits when two treeNodes are the same instance. We don't just override Object.equals, as doing so prevents the scala compiler from generating case class
equalsmethods- Definition Classes
- TreeNode
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(f: (PlanType) ⇒ Boolean): Option[PlanType]
Find the first TreeNode that satisfies the condition specified by
f. -
def
flatMap[A](f: (PlanType) ⇒ TraversableOnce[A]): Seq[A]
Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.
Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.
- Definition Classes
- TreeNode
-
def
foreach(f: (PlanType) ⇒ Unit): Unit
Runs the given function on this node and then recursively on children.
-
def
foreachUp(f: (PlanType) ⇒ Unit): Unit
Runs the given function recursively on children then on this node.
-
def
formattedNodeName: String
- Attributes
- protected
-
def
generateTreeString(depth: Int, lastChildren: ArrayList[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean, indent: Int = 0): Unit
Appends the string representation of this node and its children to the given Writer.
Appends the string representation of this node and its children to the given Writer.
The
i-th element inlastChildrenindicates whether the ancestor of the current node at depthi + 1is the last child of its own parent node. The depth of the root node is 0, andlastChildrenfor the root node should be empty.Note that this traversal (numbering) order must be the same as getNodeNumbered.
- Definition Classes
- TreeNode
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDefaultTreePatternBits: BitSet
Default tree pattern for a TreeNode.
-
def
getTagValue[T](tag: TreeNodeTag[T]): Option[T]
- Definition Classes
- TreeNode
-
def
hashCode(): Int
- Definition Classes
- TreeNode → AnyRef → Any
-
def
innerChildren: Seq[QueryPlan[_]]
All the nodes that should be shown as a inner nested tree of this node.
-
def
inputSet: AttributeSet
The set of all attributes that are input to this operator by its children.
-
def
isCanonicalizedPlan: Boolean
- Attributes
- protected
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isRuleIneffective(ruleId: RuleId): Boolean
Whether this TreeNode and its subtree have been marked as ineffective for the rule with id
ruleId.Whether this TreeNode and its subtree have been marked as ineffective for the rule with id
ruleId.- ruleId
the unique id of the rule
- returns
true if the rule has been marked as ineffective; false otherwise. If
ruleIdis UnknownId, it returns false.
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
jsonFields: List[JField]
- Attributes
- protected
- Definition Classes
- TreeNode
-
final
def
legacyWithNewChildren(newChildren: Seq[PlanType]): PlanType
Returns a copy of this node with the children replaced.
Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
makeCopy(newArgs: Array[AnyRef]): PlanType
Creates a copy of this type of tree node after a transformation.
Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.
- newArgs
the new product arguments.
- Definition Classes
- TreeNode
-
def
map[A](f: (PlanType) ⇒ A): Seq[A]
Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.
Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.
- f
the function to be applied.
- Definition Classes
- TreeNode
-
def
mapChildren(f: (PlanType) ⇒ PlanType): PlanType
Returns a copy of this node where
fhas been applied to all the nodes inchildren.Returns a copy of this node where
fhas been applied to all the nodes inchildren.- Definition Classes
- TreeNode
-
def
mapExpressions(f: (Expression) ⇒ Expression): QueryPlan.this.type
Apply a map function to each expression present in this query operator, and return a new query operator based on the mapped expressions.
-
def
mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
Efficient alternative to
productIterator.map(f).toArray.Efficient alternative to
productIterator.map(f).toArray.- Attributes
- protected
- Definition Classes
- TreeNode
-
def
markRuleAsIneffective(ruleId: RuleId): Unit
Mark that a rule (with id
ruleId) is ineffective for this TreeNode and its subtree.Mark that a rule (with id
ruleId) is ineffective for this TreeNode and its subtree.- ruleId
the unique identifier of the rule. If
ruleIdis UnknownId, it is a no-op.
- Attributes
- protected
- Definition Classes
- TreeNode
-
final
def
missingInput: AttributeSet
Attributes that are referenced by expressions but not provided by this node's children.
-
def
multiTransformDown(rule: PartialFunction[PlanType, Seq[PlanType]]): Stream[PlanType]
Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).- rule
a function used to generate alternatives for a node
- returns
the stream of alternatives
- Definition Classes
- TreeNode
-
def
multiTransformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[PlanType, Seq[PlanType]]): Stream[PlanType]
Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns alternative copies of this node where
rulehas been recursively applied to it and all of its children (pre-order).As it is very easy to generate enormous number of alternatives when the input tree is huge or when the rule returns many alternatives for many nodes, this function returns the alternatives as a lazy
Streamto be able to limit the number of alternatives generated at the caller side as needed.The purpose of this function to access the returned alternatives by the rule only if they are needed so the rule can return a
Streamwhose elements are also lazily calculated. E.g.multiTransform*calls can be nested with the help ofMultiTransform.generateCartesianProduct().The rule should not apply or can return a one element
Seqof original node to indicate that the original node without any transformation is a valid alternative.The rule can return
Seq.emptyto indicate that the original node should be pruned. In this casemultiTransform()returns an emptyStream.Please consider the following examples of
input.multiTransformDown(rule):We have an input expression:
Add(a, b)1. We have a simple rule:
a=>Seq(1, 2)b=>Seq(10, 20)Add(a, b)=>Seq(11, 12, 21, 22)The output is:
Stream(11, 12, 21, 22)2. In the previous example if we want to generate alternatives of
aandbtoo then we need to explicitly add the originalAdd(a, b)expression to the rule:a=>Seq(1, 2)b=>Seq(10, 20)Add(a, b)=>Seq(11, 12, 21, 22, Add(a, b))The output is:
Stream(11, 12, 21, 22, Add(1, 10), Add(2, 10), Add(1, 20), Add(2, 20))- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
a function used to generate alternatives for a node
- returns
the stream of alternatives
- Definition Classes
- TreeNode
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
nodeName: String
Returns the name of this type of TreeNode.
Returns the name of this type of TreeNode. Defaults to the class name. Note that we remove the "Exec" suffix for physical operators here.
- Definition Classes
- TreeNode
-
val
nodePatterns: Seq[TreePattern]
- returns
a sequence of tree pattern enums in a TreeNode T. It does not include propagated patterns in the subtree of T.
- Attributes
- protected
- Definition Classes
- TreeNode
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
numberedTreeString: String
Returns a string representation of the nodes in this tree, where each operator is numbered.
Returns a string representation of the nodes in this tree, where each operator is numbered. The numbers can be used with TreeNode.apply to easily access specific subtrees.
The numbers are based on depth-first traversal of the tree (with innerChildren traversed first before children).
- Definition Classes
- TreeNode
-
val
origin: Origin
- Definition Classes
- TreeNode → WithOrigin
-
def
otherCopyArgs: Seq[AnyRef]
Args to the constructor that should be copied, but not transformed.
Args to the constructor that should be copied, but not transformed. These are appended to the transformed args automatically by makeCopy
- Attributes
- protected
- Definition Classes
- TreeNode
-
def
outputOrdering: Seq[SortOrder]
Returns the output ordering that this plan generates, although the semantics differ in logical and physical plans.
Returns the output ordering that this plan generates, although the semantics differ in logical and physical plans. In the logical plan it means global ordering of the data while in physical it means ordering in each partition.
-
lazy val
outputSet: AttributeSet
Returns the set of attributes that are output by this node.
Returns the set of attributes that are output by this node.
- Annotations
- @transient()
-
def
p(number: Int): PlanType
Returns the tree node at the specified number, used primarily for interactive debugging.
Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.
This is a variant of apply that returns the node as BaseType (if the type matches).
- Definition Classes
- TreeNode
-
def
prettyJson: String
- Definition Classes
- TreeNode
-
def
printSchema(): Unit
Prints out the schema in the tree format
-
def
producedAttributes: AttributeSet
The set of all attributes that are produced by this node.
-
def
productIterator: Iterator[Any]
- Definition Classes
- Product
-
def
productPrefix: String
- Definition Classes
- Product
-
lazy val
references: AttributeSet
All Attributes that appear in expressions from this operator.
All Attributes that appear in expressions from this operator. Note that this set does not include attributes that are implicitly referenced by being passed through to the output tuple.
- Annotations
- @transient()
- def rewriteAttrs(attrMap: AttributeMap[Attribute]): PlanType
-
final
def
sameResult(other: PlanType): Boolean
Returns true when the given query plan will return the same results as this query plan.
Returns true when the given query plan will return the same results as this query plan.
Since its likely undecidable to generally determine if two given plans will produce the same results, it is okay for this function to return false, even if the results are actually the same. Such behavior will not affect correctness, only the application of performance enhancements like caching. However, it is not acceptable to return true if the results could possibly be different.
This function performs a modified version of equality that is tolerant of cosmetic differences like attribute naming and or expression id differences.
- lazy val schema: StructType
-
def
schemaString: String
Returns the output schema in the tree format.
-
final
def
semanticHash(): Int
Returns a
hashCodefor the calculation performed by this plan.Returns a
hashCodefor the calculation performed by this plan. Unlike the standardhashCode, an attempt has been made to eliminate cosmetic differences. -
def
setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
- Definition Classes
- TreeNode
-
def
simpleString(maxFields: Int): String
ONE line description of this node.
-
def
simpleStringWithNodeId(): String
ONE line description of this node containing the node identifier.
-
def
statePrefix: String
A prefix string used when printing the plan.
A prefix string used when printing the plan.
We use "!" to indicate an invalid plan, and "'" to indicate an unresolved plan.
- Attributes
- protected
-
def
stringArgs: Iterator[Any]
The arguments that should be included in the arg string.
The arguments that should be included in the arg string. Defaults to the
productIterator.- Attributes
- protected
- Definition Classes
- TreeNode
-
lazy val
subqueries: Seq[PlanType]
All the top-level subqueries of the current plan node.
All the top-level subqueries of the current plan node. Nested subqueries are not included.
- Annotations
- @transient()
-
def
subqueriesAll: Seq[PlanType]
All the subqueries of the current plan node and all its children.
All the subqueries of the current plan node and all its children. Nested subqueries are also included.
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toJSON: String
- Definition Classes
- TreeNode
-
def
toString(): String
- Definition Classes
- TreeNode → AnyRef → Any
-
def
transform(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformAllExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Returns the result of running transformExpressions on this node and all its children.
Returns the result of running transformExpressions on this node and all its children. Note that this method skips expressions inside subqueries.
-
def
transformAllExpressionsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Returns the result of running transformExpressionsWithPruning on this node and all its children.
Returns the result of running transformExpressionsWithPruning on this node and all its children. Note that this method skips expressions inside subqueries.
-
def
transformAllExpressionsWithSubqueries(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
A variant of transformAllExpressions which considers plan nodes inside subqueries as well.
-
def
transformDown(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order).Returns a copy of this node where
rulehas been recursively applied to it and all of its children (pre-order). Whenruledoes not apply to a given node it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformDownWithSubqueries(f: PartialFunction[PlanType, PlanType]): PlanType
This method is the top-down (pre-order) counterpart of transformUpWithSubqueries.
This method is the top-down (pre-order) counterpart of transformUpWithSubqueries. Returns a copy of this node where the given partial function has been recursively applied first to this node, then this node's subqueries and finally this node's children. When the partial function does not apply to a given node, it is left unchanged.
-
def
transformDownWithSubqueriesAndPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(f: PartialFunction[PlanType, PlanType]): PlanType
This method is the top-down (pre-order) counterpart of transformUpWithSubqueries.
This method is the top-down (pre-order) counterpart of transformUpWithSubqueries. Returns a copy of this node where the given partial function has been recursively applied first to this node, then this node's subqueries and finally this node's children. When the partial function does not apply to a given node, it is left unchanged.
-
def
transformExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformExpressionsDown with
ruleon all expressions present in this query operator.Runs transformExpressionsDown with
ruleon all expressions present in this query operator. Users should not expect a specific directionality. If a specific directionality is needed, transformExpressionsDown or transformExpressionsUp should be used.- rule
the rule to be applied to every expression in this operator.
-
def
transformExpressionsDown(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformDown with
ruleon all expressions present in this query operator.Runs transformDown with
ruleon all expressions present in this query operator.- rule
the rule to be applied to every expression in this operator.
-
def
transformExpressionsDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformDownWithPruning with
ruleon all expressions present in this query operator.Runs transformDownWithPruning with
ruleon all expressions present in this query operator.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on an expression T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on an expression T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the rule to be applied to every expression in this operator.
-
def
transformExpressionsUp(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformUp with
ruleon all expressions present in this query operator.Runs transformUp with
ruleon all expressions present in this query operator.- rule
the rule to be applied to every expression in this operator.
-
def
transformExpressionsUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformExpressionsUpWithPruning with
ruleon all expressions present in this query operator.Runs transformExpressionsUpWithPruning with
ruleon all expressions present in this query operator.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on an expression T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on an expression T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the rule to be applied to every expression in this operator.
-
def
transformExpressionsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type
Runs transformExpressionsDownWithPruning with
ruleon all expressions present in this query operator.Runs transformExpressionsDownWithPruning with
ruleon all expressions present in this query operator. Users should not expect a specific directionality. If a specific directionality is needed, transformExpressionsDown or transformExpressionsUp should be used.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on an expression T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on an expression T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the rule to be applied to every expression in this operator.
-
def
transformUp(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformUpWithBeforeAndAfterRuleOnChildren(cond: (PlanType) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(PlanType, PlanType), PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function use to transform this node and its descendant nodes. The function takes a tuple as its input, where the first/second field is the before/after image of applying the rule on the node's children.
- Definition Classes
- TreeNode
-
def
transformUpWithNewOutput(rule: PartialFunction[PlanType, (PlanType, Seq[(Attribute, Attribute)])], skipCond: (PlanType) ⇒ Boolean = _ => false, canGetOutput: (PlanType) ⇒ Boolean = _ => true): PlanType
A variant of
transformUp, which takes care of the case that the rule replaces a plan node with a new one that has different output expr IDs, by updating the attribute references in the parent nodes accordingly.A variant of
transformUp, which takes care of the case that the rule replaces a plan node with a new one that has different output expr IDs, by updating the attribute references in the parent nodes accordingly.- rule
the function to transform plan nodes, and return new nodes with attributes mapping from old attributes to new attributes. The attribute mapping will be used to rewrite attribute references in the parent nodes.
- skipCond
a boolean condition to indicate if we can skip transforming a plan node to save time.
- canGetOutput
a boolean condition to indicate if we can get the output of a plan node to prune the attributes mapping to be propagated. The default value is true as only unresolved logical plan can't get output.
-
def
transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order).Returns a copy of this node where
rulehas been recursively applied first to all of its children and then itself (post-order). Whenruledoes not apply to a given node, it is left unchanged.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformUpWithSubqueries(f: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where the given partial function has been recursively applied first to the subqueries in this node's children, then this node's children, and finally this node itself (post-order).
Returns a copy of this node where the given partial function has been recursively applied first to the subqueries in this node's children, then this node's children, and finally this node itself (post-order). When the partial function does not apply to a given node, it is left unchanged.
-
def
transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[PlanType, PlanType]): PlanType
Returns a copy of this node where
rulehas been recursively applied to the tree.Returns a copy of this node where
rulehas been recursively applied to the tree. Whenruledoes not apply to a given node it is left unchanged. Users should not expect a specific directionality. If a specific directionality is needed, transformDown or transformUp should be used.- cond
a Lambda expression to prune tree traversals. If
cond.applyreturns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.- ruleId
is a unique Id for
ruleto prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, ifrule(with idruleId) has been marked as in effective on a TreeNode T, skips processing T and its subtree. Do not pass it if the rule is not purely functional and reads a varying initial state for different invocations.- rule
the function used to transform this nodes children
- Definition Classes
- TreeNode
-
def
transformWithSubqueries(f: PartialFunction[PlanType, PlanType]): PlanType
This method is similar to the transform method, but also applies the given partial function also to all the plans in the subqueries of a node.
This method is similar to the transform method, but also applies the given partial function also to all the plans in the subqueries of a node. This method is useful when we want to rewrite the whole plan, include its subqueries, in one go.
-
lazy val
treePatternBits: BitSet
A BitSet of tree patterns for this TreeNode and its subtree.
A BitSet of tree patterns for this TreeNode and its subtree. If this TreeNode and its subtree contains a pattern
P, the corresponding bit forP.idis set in this BitSet.- Definition Classes
- QueryPlan → TreeNode → TreePatternBits
-
def
treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
- Definition Classes
- TreeNode
-
final
def
treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
- Definition Classes
- TreeNode
-
final
def
treeString: String
Returns a string representation of the nodes in this tree
Returns a string representation of the nodes in this tree
- Definition Classes
- TreeNode
-
def
unsetTagValue[T](tag: TreeNodeTag[T]): Unit
- Definition Classes
- TreeNode
-
def
updateOuterReferencesInSubquery(plan: PlanType, attrMap: AttributeMap[Attribute]): PlanType
The outer plan may have old references and the function below updates the outer references to refer to the new attributes.
The outer plan may have old references and the function below updates the outer references to refer to the new attributes.
- Attributes
- protected
-
def
verboseString(maxFields: Int): String
ONE line description of this node with more information
- def verboseStringWithOperatorId(): String
-
def
verboseStringWithSuffix(maxFields: Int): String
ONE line description of this node with some suffix information
ONE line description of this node with some suffix information
- Definition Classes
- TreeNode
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
withNewChildren(newChildren: Seq[PlanType]): PlanType
- Definition Classes
- TreeNode