case class ArrayTransform(argument: Expression, function: Expression) extends Expression with ArrayBasedSimpleHigherOrderFunction with CodegenFallback with Product with Serializable
Transform elements in an array using the transform function. This is similar to
a map in functional programming.
- Annotations
- @ExpressionDescription()
- Alphabetic
- By Inheritance
- ArrayTransform
- Serializable
- CodegenFallback
- ArrayBasedSimpleHigherOrderFunction
- SimpleHigherOrderFunction
- BinaryLike
- HigherOrderFunction
- ExpectsInputTypes
- Expression
- TreeNode
- WithOrigin
- TreePatternBits
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new ArrayTransform(argument: Expression, function: Expression)
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
- 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
- val argument: Expression
- Definition Classes
- ArrayTransform → SimpleHigherOrderFunction
- def argumentType: AbstractDataType
- Definition Classes
- ArrayBasedSimpleHigherOrderFunction → SimpleHigherOrderFunction
- def argumentTypes(): Seq[AbstractDataType]
- Definition Classes
- SimpleHigherOrderFunction → HigherOrderFunction
- def arguments: Seq[Expression]
Arguments of the higher ordered function.
Arguments of the higher ordered function.
- Definition Classes
- SimpleHigherOrderFunction → HigherOrderFunction
- lazy val argumentsResolved: Boolean
All arguments have been resolved.
All arguments have been resolved. This means that the types and nullability of (most of) the lambda function arguments is known, and that we can start binding the lambda functions.
- Definition Classes
- HigherOrderFunction
- 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 def bind(f: (Expression, Seq[(DataType, Boolean)]) => LambdaFunction): HigherOrderFunction
Bind the lambda functions to the HigherOrderFunction using the given bind function.
Bind the lambda functions to the HigherOrderFunction using the given bind function. The bind function takes the potential lambda and it's (partial) arguments and converts this into a bound lambda function.
- Definition Classes
- HigherOrderFunction
- def bindInternal(f: (Expression, Seq[(DataType, Boolean)]) => LambdaFunction): ArrayTransform
- Attributes
- protected
- Definition Classes
- ArrayTransform → HigherOrderFunction
- lazy val canonicalized: Expression
Returns an expression 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, etc.).Returns an expression 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, etc.).deterministicexpressions wherethis.canonicalized == other.canonicalizedwill always evaluate to the same result.The process of canonicalization is a one pass, bottum-up expression tree computation based on canonicalizing children before canonicalizing the current node. There is one exception though, as adjacent, same class CommutativeExpressions canonicalazion happens in a way that calling
canonicalizedon the root:- Gathers and canonicalizes the non-commutative (or commutative but not same class) child
expressions of the adjacent expressions.
2. Reorder the canonicalized child expressions by their hashcode.
This means that the lazy
cannonicalizedis called and computed only on the root of the adjacent expressions.
- Definition Classes
- HigherOrderFunction → Expression
- Gathers and canonicalizes the non-commutative (or commutative but not same class) child
expressions of the adjacent expressions.
2. Reorder the canonicalized child expressions by their hashcode.
This means that the lazy
- def checkArgumentDataTypes(): TypeCheckResult
Checks the argument data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid.Checks the argument data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid. Note: it's not valid to call this method untilargumentsResolved == true.- Definition Classes
- HigherOrderFunction
- def checkInputDataTypes(): TypeCheckResult
Checks the input data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid.Checks the input data types, returns
TypeCheckResult.successif it's valid, or returns aTypeCheckResultwith an error message if invalid. Note: it's not valid to call this method untilchildrenResolved == true.- Definition Classes
- ExpectsInputTypes → Expression
- final lazy val children: Seq[Expression]
- Definition Classes
- BinaryLike
- Annotations
- @transient()
- def childrenResolved: Boolean
Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.
Returns true if all the children of this expression have been resolved to a specific schema and false if any still contains any unresolved placeholders.
- Definition Classes
- Expression
- def clone(): Expression
- Definition Classes
- TreeNode → AnyRef
- def collect[B](pf: PartialFunction[Expression, 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[Expression, 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.
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.
- Definition Classes
- TreeNode
- def collectLeaves(): Seq[Expression]
Returns a Seq containing the leaves in this tree.
Returns a Seq containing the leaves in this tree.
- Definition Classes
- TreeNode
- 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: Expression): Unit
- Definition Classes
- TreeNode
- def dataType: ArrayType
Returns the DataType of the result of evaluating this expression.
Returns the DataType of the result of evaluating this expression. It is invalid to query the dataType of an unresolved expression (i.e., when
resolved== false).- Definition Classes
- ArrayTransform → Expression
- lazy val deterministic: Boolean
Returns true when the current expression always return the same result for fixed inputs from children.
Returns true when the current expression always return the same result for fixed inputs from children. The non-deterministic expressions should not change in number and order. They should not be evaluated during the query planning.
Note that this means that an expression should be considered as non-deterministic if: - it relies on some mutable internal state, or - it relies on some implicit input that is not part of the children expression list. - it has non-deterministic child or children. - it assumes the input satisfies some certain condition via the child operator.
An example would be
SparkPartitionIDthat relies on the partition id returned by TaskContext. By default leaf expressions are deterministic as Nil.forall(_.deterministic) returns true.- Definition Classes
- Expression
- def doGenCode(ctx: CodegenContext, ev: ExprCode): ExprCode
Returns Java source code that can be compiled to evaluate this expression.
Returns Java source code that can be compiled to evaluate this expression. The default behavior is to call the eval method of the expression. Concrete expression implementations should override this to do actual code generation.
- ctx
a CodegenContext
- ev
an ExprCode with unique terms.
- returns
an ExprCode containing the Java source code to generate the given expression
- Attributes
- protected
- Definition Classes
- CodegenFallback → Expression
- lazy val elementVar: NamedLambdaVariable
- Annotations
- @transient()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def eval(inputRow: InternalRow): Any
Returns the result of evaluating this expression on a given input Row
Returns the result of evaluating this expression on a given input Row
- Definition Classes
- SimpleHigherOrderFunction → Expression
- def exists(f: (Expression) => Boolean): Boolean
Test whether there is TreeNode satisfies the conditions specified in
f.Test whether there is TreeNode satisfies the conditions specified in
f. The condition is recursively applied to this node and all of its children (pre-order).- Definition Classes
- TreeNode
- 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: (Expression) => Boolean): Option[Expression]
Find the first TreeNode that satisfies the condition specified by
f.Find the first TreeNode that satisfies the condition specified by
f. The condition is recursively applied to this node and all of its children (pre-order).- Definition Classes
- TreeNode
- def flatArguments: Iterator[Any]
- Attributes
- protected
- Definition Classes
- Expression
- def flatMap[A](f: (Expression) => 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 foldable: Boolean
Returns true when an expression is a candidate for static evaluation before the query is executed.
Returns true when an expression is a candidate for static evaluation before the query is executed. A typical use case: org.apache.spark.sql.catalyst.optimizer.ConstantFolding
The following conditions are used to determine suitability for constant folding:
- A Coalesce is foldable if all of its children are foldable
- A BinaryExpression is foldable if its both left and right child are foldable
- A Not, IsNull, or IsNotNull is foldable if its child is foldable
- A Literal is foldable
- A Cast or UnaryMinus is foldable if its child is foldable
- Definition Classes
- Expression
- def foreach(f: (Expression) => Unit): Unit
Runs the given function on this node and then recursively on children.
- def foreachUp(f: (Expression) => Unit): Unit
Runs the given function recursively on children then on this node.
- def freshCopyIfContainsStatefulExpression(): Expression
Returns a copy of this expression where all stateful expressions are replaced with fresh uninitialized copies.
Returns a copy of this expression where all stateful expressions are replaced with fresh uninitialized copies. If the expression contains no stateful expressions then the original expression is returned.
- Definition Classes
- Expression
- val function: Expression
- Definition Classes
- ArrayTransform → SimpleHigherOrderFunction
- def functionForEval: Expression
- Definition Classes
- SimpleHigherOrderFunction
- def functionType: AbstractDataType
- Definition Classes
- SimpleHigherOrderFunction
- def functionTypes: Seq[AbstractDataType]
- Definition Classes
- SimpleHigherOrderFunction → HigherOrderFunction
- def functions: Seq[Expression]
Functions applied by the higher order function.
Functions applied by the higher order function.
- Definition Classes
- SimpleHigherOrderFunction → HigherOrderFunction
- lazy val functionsForEval: Seq[Expression]
- Definition Classes
- HigherOrderFunction
- Annotations
- @transient()
- def genCode(ctx: CodegenContext): ExprCode
Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.
Returns an ExprCode, that contains the Java source code to generate the result of evaluating the expression on an input row.
- ctx
a CodegenContext
- returns
ExprCode
- Definition Classes
- Expression
- 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[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def getDefaultTreePatternBits: BitSet
Default tree pattern for a TreeNode.
Default tree pattern for a TreeNode.
- Attributes
- protected
- Definition Classes
- TreeNode
- def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
- Definition Classes
- TreeNode
- def hashCode(): Int
- Definition Classes
- TreeNode → AnyRef → Any
- lazy val indexVar: Option[NamedLambdaVariable]
- Annotations
- @transient()
- def innerChildren: Seq[TreeNode[_]]
All the nodes that should be shown as a inner nested tree of this node.
All the nodes that should be shown as a inner nested tree of this node. For example, this can be used to show sub-queries.
- Definition Classes
- TreeNode
- def inputTypes: Seq[AbstractDataType]
Expected input types from child expressions.
Expected input types from child expressions. The i-th position in the returned seq indicates the type requirement for the i-th child.
The possible values at each position are: 1. a specific data type, e.g. LongType, StringType. 2. a non-leaf abstract data type, e.g. NumericType, IntegralType, FractionalType.
- Definition Classes
- HigherOrderFunction → ExpectsInputTypes
- 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
- def left: Expression
- Definition Classes
- SimpleHigherOrderFunction → BinaryLike
- final def legacyWithNewChildren(newChildren: Seq[Expression]): Expression
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]): Expression
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: (Expression) => 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
- final def mapChildren(f: (Expression) => Expression): Expression
- Definition Classes
- BinaryLike
- 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
- def multiTransformDown(rule: PartialFunction[Expression, Seq[Expression]]): Stream[Expression]
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[Expression, Seq[Expression]]): Stream[Expression]
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
- ArrayTransform → TreeNode
- final val nodePatterns: Seq[TreePattern]
- Definition Classes
- HigherOrderFunction → TreeNode
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def nullSafeEval(inputRow: InternalRow, argumentValue: Any): Any
Called by eval.
Called by eval. If a subclass keeps the default nullability, it can override this method in order to save null-check code.
- Definition Classes
- ArrayTransform → SimpleHigherOrderFunction
- def nullable: Boolean
- Definition Classes
- HigherOrderFunction → Expression
- 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 p(number: Int): Expression
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 prettyName: String
Returns a user-facing string representation of this expression's name.
Returns a user-facing string representation of this expression's name. This should usually match the name of the function in SQL.
- Definition Classes
- Expression
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- def references: AttributeSet
- Definition Classes
- Expression
- lazy val resolved: Boolean
All inputs must be resolved and all functions must be resolved lambda functions.
All inputs must be resolved and all functions must be resolved lambda functions.
- Definition Classes
- HigherOrderFunction → Expression
- def right: Expression
- Definition Classes
- SimpleHigherOrderFunction → BinaryLike
- final def semanticEquals(other: Expression): Boolean
Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e.
Returns true when two expressions will always compute the same result, even if they differ cosmetically (i.e. capitalization of names in attributes may be different).
See Canonicalize for more details.
- Definition Classes
- Expression
- def semanticHash(): Int
Returns a
hashCodefor the calculation performed by this expression.Returns a
hashCodefor the calculation performed by this expression. Unlike the standardhashCode, an attempt has been made to eliminate cosmetic differences.See Canonicalize for more details.
- Definition Classes
- Expression
- def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
- Definition Classes
- TreeNode
- def simpleString(maxFields: Int): String
ONE line description of this node.
ONE line description of this node.
- maxFields
Maximum number of fields that will be converted to strings. Any elements beyond the limit will be dropped.
- Definition Classes
- Expression → TreeNode
- def simpleStringWithNodeId(): String
ONE line description of this node containing the node identifier.
ONE line description of this node containing the node identifier.
- Definition Classes
- Expression → TreeNode
- def sql: String
Returns SQL representation of this expression.
Returns SQL representation of this expression. For expressions extending NonSQLExpression, this method may return an arbitrary user facing string.
- Definition Classes
- Expression
- def stateful: Boolean
Returns true if the expression contains mutable state.
Returns true if the expression contains mutable state.
A stateful expression should never be evaluated multiple times for a single row. This should only be a problem for interpreted execution. This can be prevented by creating fresh copies of the stateful expression before execution. A common example to trigger this issue:
val rand = functions.rand() df.select(rand, rand) // These 2 rand should not share a state.
- Definition Classes
- Expression
- 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
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJSON: String
- Definition Classes
- TreeNode
- def toString(): String
- Definition Classes
- Expression → TreeNode → AnyRef → Any
- def transform(rule: PartialFunction[Expression, Expression]): Expression
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 transformDown(rule: PartialFunction[Expression, Expression]): Expression
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[Expression, Expression]): Expression
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 transformUp(rule: PartialFunction[Expression, Expression]): Expression
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: (Expression) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(Expression, Expression), Expression]): Expression
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 transformUpWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression
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 transformWithPruning(cond: (TreePatternBits) => Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): Expression
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
- 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
- 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 typeSuffix: String
- Attributes
- protected
- Definition Classes
- Expression
- def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
- Definition Classes
- TreeNode
- final def verboseString(maxFields: Int): String
ONE line description of this node with more information
ONE line description of this node with more information
- Definition Classes
- Expression → TreeNode
- 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(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def withCanonicalizedChildren: Expression
The default process of canonicalization.
The default process of canonicalization. It is a one pass, bottum-up expression tree computation based oncanonicalizing children before canonicalizing the current node.
- Attributes
- protected
- Definition Classes
- Expression
- final def withNewChildren(newChildren: Seq[Expression]): Expression
- Definition Classes
- TreeNode
- def withNewChildrenInternal(newLeft: Expression, newRight: Expression): ArrayTransform
- Attributes
- protected
- Definition Classes
- ArrayTransform → BinaryLike
- final def withNewChildrenInternal(newChildren: IndexedSeq[Expression]): Expression
- Definition Classes
- BinaryLike