Spark Project Catalyst 3.5.0 API - org.apache.spark.sql.catalyst.expressions.codegen.CodeBlock

final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

def +(other: Block): Block

Definition Classes: Block

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

val _marginChar: Option[Char]

Definition Classes: Block

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

Definition Classes: TreeNode

def asCode: String

Returns a 'scala code' representation of this TreeNode and its children.

Returns a 'scala code' representation of this TreeNode and its children. Intended for use when debugging where the prettier toString function is obfuscating the actual structure. In the case of 'pure' TreeNodes that 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

val blockInputs: Seq[JavaCode]

def children: Seq[Block]

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: CodeBlock → TreeNode

def clone(): Block

Definition Classes: TreeNode → AnyRef

lazy val code: String

Definition Classes: CodeBlock → JavaCode

val codeParts: Seq[String]

def collect[B](pf: PartialFunction[Block, 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.

Definition Classes: TreeNode

def collectFirst[B](pf: PartialFunction[Block, 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.

Definition Classes: TreeNode

def collectLeaves(): Seq[Block]

Returns a Seq containing the leaves in this tree.

Definition Classes: TreeNode

final def containsAllPatterns(patterns: TreePattern*): Boolean

returns: true if every bit for patterns is set; false otherwise.

Definition Classes: TreePatternBits

final def containsAnyPattern(patterns: TreePattern*): Boolean

returns: true if at least one bit for patterns is 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 t is set; false otherwise.

Definition Classes: TreePatternBits
Annotations: @inline()

def copyTagsFrom(other: Block): Unit

Definition Classes: TreeNode

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def exists(f: (Block) ⇒ 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 equals methods

Definition Classes: TreeNode

def finalize(): Unit

Attributes: protected[lang]
Definition Classes: AnyRef
Annotations: @throws( classOf[java.lang.Throwable] )

def find(f: (Block) ⇒ Boolean): Option[Block]

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 flatMap[A](f: (Block) ⇒ 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.

Definition Classes: TreeNode

def foreach(f: (Block) ⇒ Unit): Unit

Runs the given function on this node and then recursively on children.

f: the function to be applied to each node in the tree.

Definition Classes: TreeNode

def foreachUp(f: (Block) ⇒ Unit): Unit

Runs the given function recursively on children then on this node.

f: the function to be applied to each node in the tree.

Definition Classes: TreeNode

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.

The i-th element in lastChildren indicates whether the ancestor of the current node at depth i + 1 is the last child of its own parent node. The depth of the root node is 0, and lastChildren for 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.

Attributes: protected
Definition Classes: TreeNode

def getTagValue[T](tag: TreeNodeTag[T]): Option[T]

Definition Classes: TreeNode

def hashCode(): Int

Definition Classes: TreeNode → AnyRef → Any

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 isEmpty: Boolean

Definition Classes: Block

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.

ruleId: the unique id of the rule
returns: true if the rule has been marked as ineffective; false otherwise. If ruleId is UnknownId, it returns false.

Attributes: protected
Definition Classes: TreeNode

def jsonFields: List[JField]

Attributes: protected
Definition Classes: TreeNode

final def legacyWithNewChildren(newChildren: Seq[Block]): Block

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 length: Int

Definition Classes: Block

def makeCopy(newArgs: Array[AnyRef]): Block

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: (Block) ⇒ A): Seq[A]

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: (Block) ⇒ Block): Block

Returns a copy of this node where f has been applied to all the nodes in children.

Definition Classes: TreeNode

def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

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.

ruleId: the unique identifier of the rule. If ruleId is UnknownId, it is a no-op.

Attributes: protected
Definition Classes: TreeNode

def multiTransformDown(rule: PartialFunction[Block, Seq[Block]]): Stream[Block]

Returns alternative copies of this node where rule has 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[Block, Seq[Block]]): Stream[Block]

Returns alternative copies of this node where rule has 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 Stream to 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 Stream whose elements are also lazily calculated. E.g. multiTransform* calls can be nested with the help of MultiTransform.generateCartesianProduct().

The rule should not apply or can return a one element Seq of original node to indicate that the original node without any transformation is a valid alternative.

The rule can return Seq.empty to indicate that the original node should be pruned. In this case multiTransform() returns an empty Stream.

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 a and b too then we need to explicitly add the original Add(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.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.
ruleId: is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) 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

def nonEmpty: Boolean

Definition Classes: Block

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 p(number: Int): Block

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 setTagValue[T](tag: TreeNodeTag[T], value: T): Unit

Definition Classes: TreeNode

def simpleString(maxFields: Int): String

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: TreeNode

def simpleStringWithNodeId(): String

ONE line description of this node containing the node identifier.

Definition Classes: Block → TreeNode

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

def stripMargin: CodeBlock.this.type

Definition Classes: Block

def stripMargin(c: Char): CodeBlock.this.type

Definition Classes: Block

final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes: AnyRef

def toJSON: String

Definition Classes: TreeNode

def toString(): String

Definition Classes: Block → JavaCode → TreeNode → AnyRef → Any

def transform(rule: PartialFunction[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied to the tree.

Returns a copy of this node where rule has been recursively applied to the tree. When rule does 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[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order).

Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order). When rule does 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[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order).

Returns a copy of this node where rule has been recursively applied to it and all of its children (pre-order). When rule does not apply to a given node it is left unchanged.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.
ruleId: is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) 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 transformExprValues(f: PartialFunction[ExprValue, ExprValue]): CodeBlock.this.type

Apply a map function to each java expression codes present in this java code, and return a new java code based on the mapped java expression codes.

Definition Classes: Block

def transformUp(rule: PartialFunction[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does 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: (Block) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(Block, Block), Block]): Block

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does not apply to a given node, it is left unchanged.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.
ruleId: is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) 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[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order).

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order). When rule does not apply to a given node, it is left unchanged.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.
ruleId: is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) 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[Block, Block]): Block

Returns a copy of this node where rule has been recursively applied to the tree.

Returns a copy of this node where rule has been recursively applied to the tree. When rule does 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.apply returns false on a TreeNode T, skips processing T and its subtree; otherwise, processes T and its subtree recursively.
ruleId: is a unique Id for rule to prune unnecessary tree traversals. When it is UnknownRuleId, no pruning happens. Otherwise, if rule (with id ruleId) 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 for P.id is 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

Definition Classes: TreeNode

def unsetTagValue[T](tag: TreeNodeTag[T]): Unit

Definition Classes: TreeNode

def verboseString(maxFields: Int): String

ONE line description of this node with more information

Definition Classes: Block → TreeNode

def verboseStringWithSuffix(maxFields: Int): String

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[Block]): Block

Definition Classes: TreeNode

def withNewChildrenInternal(newChildren: IndexedSeq[Block]): Block

Attributes: protected
Definition Classes: CodeBlock → TreeNode

Packages

Standard Expressions

Named Expressions

Evaluation

CodeBlock

case class CodeBlock(codeParts: Seq[String], blockInputs: Seq[JavaCode]) extends TreeNode[Block] with Block with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Block

Inherited from JavaCode

Inherited from TreeNode[Block]

Inherited from WithOrigin

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Standard Expressions

Named Expressions

Evaluation

CodeBlock 

case class CodeBlock(codeParts: Seq[String], blockInputs: Seq[JavaCode]) extends TreeNode[Block] with Block with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from Block

Inherited from JavaCode

Inherited from TreeNode[Block]

Inherited from WithOrigin

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

CodeBlock