Spark Project Catalyst 3.2.0 API - org.apache.spark.sql.catalyst.plans.logical.CommentOnTable

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.

Definition Classes: QueryPlan

def analyzed: Boolean

Returns true if this node and its children have already been gone through analysis and verification.

Returns true if this node and its children have already been gone through analysis and verification. Note that this is only an optimization used to avoid analyzing trees that have already been analyzed, and can be reset by transformations.

Definition Classes: AnalysisHelper

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

def assertNotAnalysisRule(): Unit

Attributes: protected
Definition Classes: AnalysisHelper

final lazy val canonicalized: LogicalPlan

Returns a plan where a best effort attempt has been made to transform this in a way that preserves the result but removes cosmetic variations (case sensitivity, ordering for commutative operations, expression id, etc.)

Plans where this.canonicalized == other.canonicalized will always evaluate to the same result.

Plan nodes that require special canonicalization should override doCanonicalize(). They should remove expressions cosmetic variations themselves.

Definition Classes: QueryPlan
Annotations: @transient()

def changes: Seq[TableChange]

Definition Classes: CommentOnTable → AlterTableCommand

final def child: LogicalPlan

Definition Classes: AlterTableCommand → UnaryLike

final lazy val children: Seq[LogicalPlan]

Definition Classes: UnaryLike
Annotations: @transient()

def childrenResolved: Boolean

Returns true if all its children of this query plan have been resolved.

Definition Classes: LogicalPlan

def clone(): LogicalPlan

Definition Classes: AnalysisHelper → TreeNode → AnyRef

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

Returns a Seq containing the leaves in this tree.

Definition Classes: TreeNode

def collectWithSubqueries[B](f: PartialFunction[LogicalPlan, 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

Definition Classes: QueryPlan

val comment: String

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

lazy val constraints: ExpressionSet

An ExpressionSet that contains invariants about the rows output by this operator.

An ExpressionSet that contains invariants about the rows output by this operator. For example, if this set contains the expression a = 2 then that expression is guaranteed to evaluate to true for all rows produced.

Definition Classes: QueryPlanConstraints

def constructIsNotNullConstraints(constraints: ExpressionSet, output: Seq[Attribute]): ExpressionSet

Infers a set of isNotNull constraints from null intolerant expressions as well as non-nullable attributes.

Infers a set of isNotNull constraints from null intolerant expressions as well as non-nullable attributes. For e.g., if an expression is of the form (a > 5), this returns a constraint of the form isNotNull(a)

Definition Classes: ConstraintHelper

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: LogicalPlan): Unit

Definition Classes: TreeNode

def doCanonicalize(): LogicalPlan

Defines how the canonicalization should work for the current plan.

Attributes: protected
Definition Classes: QueryPlan

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def expressions: Seq[Expression]

Returns all of the expressions present in this query plan operator.

Definition Classes: QueryPlan

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: (LogicalPlan) ⇒ Boolean): Option[LogicalPlan]

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: (LogicalPlan) ⇒ 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: (LogicalPlan) ⇒ 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: (LogicalPlan) ⇒ 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 formattedNodeName: String

Attributes: protected
Definition Classes: QueryPlan

def generateTreeString(depth: Int, lastChildren: Seq[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 inferAdditionalConstraints(constraints: ExpressionSet): ExpressionSet

Infers an additional set of constraints from a given set of equality constraints.

Infers an additional set of constraints from a given set of equality constraints. For e.g., if an operator has constraints of the form (a = 5, a = b), this returns an additional constraint of the form b = 5.

Definition Classes: ConstraintHelper

def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean

Attributes: protected
Definition Classes: Logging

def initializeLogIfNecessary(isInterpreter: Boolean): Unit

Attributes: protected
Definition Classes: Logging

def innerChildren: Seq[QueryPlan[_]]

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

def inputSet: AttributeSet

The set of all attributes that are input to this operator by its children.

Definition Classes: QueryPlan

final def invalidateStatsCache(): Unit

Invalidates the stats cache.

Invalidates the stats cache. See stats for more information.

Definition Classes: LogicalPlanStats

def isCanonicalizedPlan: Boolean

Attributes: protected
Definition Classes: QueryPlan

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

Returns true if this subtree has data from a streaming data source.

Definition Classes: LogicalPlan

def isTraceEnabled(): Boolean

Attributes: protected
Definition Classes: Logging

def jsonFields: List[JField]

Attributes: protected
Definition Classes: TreeNode

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

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 log: Logger

Attributes: protected
Definition Classes: Logging

def logDebug(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logDebug(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logError(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logError(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logInfo(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logInfo(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logName: String

Attributes: protected
Definition Classes: Logging

def logTrace(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logTrace(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

def logWarning(msg: ⇒ String, throwable: Throwable): Unit

Attributes: protected
Definition Classes: Logging

def logWarning(msg: ⇒ String): Unit

Attributes: protected
Definition Classes: Logging

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

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

final def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LogicalPlan

Definition Classes: UnaryLike

def mapExpressions(f: (Expression) ⇒ Expression): CommentOnTable.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.

Definition Classes: QueryPlan

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 maxRows: Option[Long]

Returns the maximum number of rows that this plan may compute.

Any operator that a Limit can be pushed passed should override this function (e.g., Union). Any operator that can push through a Limit should override this function (e.g., Project).

Definition Classes: LogicalPlan

def maxRowsPerPartition: Option[Long]

Returns the maximum number of rows this plan may compute on each partition.

Definition Classes: LogicalPlan

def metadataOutput: Seq[Attribute]

Metadata fields that can be projected from this node.

Metadata fields that can be projected from this node. Should be overridden if the plan does not propagate its children's output.

Definition Classes: LogicalPlan

final def missingInput: AttributeSet

Attributes that are referenced by expressions but not provided by this node's children.

Definition Classes: QueryPlan

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

final val nodePatterns: Seq[TreePattern]

Definition Classes: Command → 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

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 output: Seq[Attribute]

Definition Classes: Command → QueryPlan

def outputOrdering: Seq[SortOrder]

Returns the output ordering that this plan generates.

Definition Classes: LogicalPlan

lazy val outputSet: AttributeSet

Returns the set of attributes that are output by this node.

Definition Classes: QueryPlan
Annotations: @transient()

def p(number: Int): LogicalPlan

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

Definition Classes: QueryPlan

def producedAttributes: AttributeSet

The set of all attributes that are produced by this node.

Definition Classes: Command → QueryPlan

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.

Definition Classes: QueryPlan
Annotations: @transient()

def refresh(): Unit

Refreshes (or invalidates) any metadata/data cached in the plan recursively.

Definition Classes: LogicalPlan

def resolve(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

Optionally resolves the given strings to a NamedExpression based on the output of this LogicalPlan.

Optionally resolves the given strings to a NamedExpression based on the output of this LogicalPlan. The attribute is expressed as string in the following form: [scope].AttributeName.[nested].[fields]....

Definition Classes: LogicalPlan

def resolve(schema: StructType, resolver: Resolver): Seq[Attribute]

Resolves a given schema to concrete Attribute references in this query plan.

Resolves a given schema to concrete Attribute references in this query plan. This function should only be called on analyzed plans since it will throw AnalysisException for unresolved Attributes.

Definition Classes: LogicalPlan

def resolveChildren(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

Optionally resolves the given strings to a NamedExpression using the input from all child nodes of this LogicalPlan.

Optionally resolves the given strings to a NamedExpression using the input from all child nodes of this LogicalPlan. The attribute is expressed as string in the following form: [scope].AttributeName.[nested].[fields]....

Definition Classes: LogicalPlan

def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan

Recursively transforms the expressions of a tree, skipping nodes that have already been analyzed.

Definition Classes: AnalysisHelper

def resolveExpressionsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): LogicalPlan

Recursively transforms the expressions of a tree, skipping nodes that have already been analyzed.

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

def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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. This function is similar to transform, but skips sub-trees that have already been marked as analyzed. Users should not expect a specific directionality. If a specific directionality is needed, resolveOperatorsUp or resolveOperatorsDown should be used.

rule: the function used to transform this nodes children.

Definition Classes: AnalysisHelper

def resolveOperatorsDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

Similar to resolveOperatorsUp, but does it top-down.

Definition Classes: AnalysisHelper

def resolveOperatorsDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

Similar to resolveOperatorsUpWithPruning, but does it top-down.

Definition Classes: AnalysisHelper

def resolveOperatorsUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order, bottom-up). When rule does not apply to a given node, it is left unchanged. This function is similar to transformUp, but skips sub-trees that have already been marked as analyzed.

rule: the function used to transform this nodes children.

Definition Classes: AnalysisHelper

def resolveOperatorsUpWithNewOutput(rule: PartialFunction[LogicalPlan, (LogicalPlan, Seq[(Attribute, Attribute)])]): LogicalPlan

A variant of transformUpWithNewOutput, which skips touching already analyzed plan.

Definition Classes: AnalysisHelper

def resolveOperatorsUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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

Returns a copy of this node where rule has been recursively applied first to all of its children and then itself (post-order, bottom-up). When rule does not apply to a given node, it is left unchanged. This function is similar to transformUp, but skips sub-trees that have already been marked as analyzed.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on an operator 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 an operator 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: AnalysisHelper

def resolveOperatorsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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. This function is similar to transform, but skips sub-trees that have already been marked as analyzed. Users should not expect a specific directionality. If a specific directionality is needed, resolveOperatorsUpWithPruning or resolveOperatorsDownWithPruning should be used.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on an operator 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 an operator 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: AnalysisHelper

def resolveQuoted(name: String, resolver: Resolver): Option[NamedExpression]

Given an attribute name, split it to name parts by dot, but don't split the name parts quoted by backticks, for example, ab.cd.efg should be split into two parts "ab.cd" and "efg".

Definition Classes: LogicalPlan

lazy val resolved: Boolean

Returns true if this expression and all its children have been resolved to a specific schema and false if it still contains any unresolved placeholders.

Returns true if this expression and all its children have been resolved to a specific schema and false if it still contains any unresolved placeholders. Implementations of LogicalPlan can override this (e.g. UnresolvedRelation should return false).

Definition Classes: LogicalPlan

def rewriteAttrs(attrMap: AttributeMap[Attribute]): LogicalPlan

Definition Classes: QueryPlan

def sameOutput(other: LogicalPlan): Boolean

Returns true iff other's output is semantically the same, i.e.:

it contains the same number of Attributes;
references are the same;
the order is equal too.

Definition Classes: LogicalPlan

final def sameResult(other: LogicalPlan): Boolean

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.

Definition Classes: QueryPlan

lazy val schema: StructType

Definition Classes: QueryPlan

def schemaString: String

Returns the output schema in the tree format.

Definition Classes: QueryPlan

final def semanticHash(): Int

Returns a hashCode for the calculation performed by this plan.

Returns a hashCode for the calculation performed by this plan. Unlike the standard hashCode, an attempt has been made to eliminate cosmetic differences.

Definition Classes: QueryPlan

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

def simpleStringWithNodeId(): String

ONE line description of this node containing the node identifier.

Definition Classes: QueryPlan → TreeNode

def statePrefix: String

A prefix string used when printing the plan.

We use "!" to indicate an invalid plan, and "'" to indicate an unresolved plan.

Attributes: protected
Definition Classes: LogicalPlan → QueryPlan

def stats: Statistics

Returns the estimated statistics for the current logical plan node.

Returns the estimated statistics for the current logical plan node. Under the hood, this method caches the return value, which is computed based on the configuration passed in the first time. If the configuration changes, the cache can be invalidated by calling invalidateStatsCache().

Definition Classes: Command → LogicalPlanStats

val statsCache: Option[Statistics]

A cache for the estimated statistics, such that it will only be computed once.

Attributes: protected
Definition Classes: LogicalPlanStats

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 subqueries: Seq[LogicalPlan]

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.

Definition Classes: QueryPlan

def subqueriesAll: Seq[LogicalPlan]

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.

Definition Classes: QueryPlan

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

Definition Classes: AnyRef

val table: LogicalPlan

Definition Classes: CommentOnTable → AlterTableCommand

def toJSON: String

Definition Classes: TreeNode

def toString(): String

Definition Classes: TreeNode → AnyRef → Any

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

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 transformAllExpressions(rule: PartialFunction[Expression, Expression]): CommentOnTable.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.

Definition Classes: QueryPlan

def transformAllExpressionsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Use resolveExpressions() in the analyzer.

Definition Classes: AnalysisHelper → QueryPlan
See also: QueryPlan.transformAllExpressionsWithPruning()

def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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

In analyzer, use resolveOperatorsDown() instead.

In analyzer, use resolveOperatorsDown() instead. If this is used in the analyzer, an exception will be thrown in test mode. It is however OK to call this function within the scope of a resolveOperatorsDown() call.

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: AnalysisHelper → TreeNode
See also: org.apache.spark.sql.catalyst.trees.TreeNode.transformDownWithPruning().

def transformExpressions(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformExpressionsDown with rule on all expressions present in this query operator.

Runs transformExpressionsDown with rule on 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.

Definition Classes: QueryPlan

def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformDown with rule on all expressions present in this query operator.

rule: the rule to be applied to every expression in this operator.

Definition Classes: QueryPlan

def transformExpressionsDownWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformDownWithPruning with rule on all expressions present in this query operator.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on an expression 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 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.

Definition Classes: QueryPlan

def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformUp with rule on all expressions present in this query operator.

rule: the rule to be applied to every expression in this operator.

Definition Classes: QueryPlan

def transformExpressionsUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformExpressionsUpWithPruning with rule on all expressions present in this query operator.

cond: a Lambda expression to prune tree traversals. If cond.apply returns false on an expression 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 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.

Definition Classes: QueryPlan

def transformExpressionsWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[Expression, Expression]): CommentOnTable.this.type

Runs transformExpressionsDownWithPruning with rule on all expressions present in this query operator.

Runs transformExpressionsDownWithPruning with rule on 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.apply returns false on an expression 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 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.

Definition Classes: QueryPlan

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

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: (LogicalPlan) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[(LogicalPlan, LogicalPlan), LogicalPlan]): LogicalPlan

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 transformUpWithNewOutput(rule: PartialFunction[LogicalPlan, (LogicalPlan, Seq[(Attribute, Attribute)])], skipCond: (LogicalPlan) ⇒ Boolean, canGetOutput: (LogicalPlan) ⇒ Boolean): LogicalPlan

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.

Definition Classes: AnalysisHelper → QueryPlan

def transformUpWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

Use resolveOperators() in the analyzer.

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: AnalysisHelper → TreeNode
See also: org.apache.spark.sql.catalyst.trees.TreeNode.transformUpWithPruning()

def transformUpWithSubqueries(f: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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.

Definition Classes: QueryPlan

def transformWithPruning(cond: (TreePatternBits) ⇒ Boolean, ruleId: RuleId = UnknownRuleId)(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

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

Definition Classes: TreeNode

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

Definition Classes: TreeNode

def updateOuterReferencesInSubquery(plan: LogicalPlan, attrMap: AttributeMap[Attribute]): LogicalPlan

The outer plan may have old references and the function below updates the outer references to refer to the new attributes.

Definition Classes: AnalysisHelper → QueryPlan

lazy val validConstraints: ExpressionSet

This method can be overridden by any child class of QueryPlan to specify a set of constraints based on the given operator's constraint propagation logic.

This method can be overridden by any child class of QueryPlan to specify a set of constraints based on the given operator's constraint propagation logic. These constraints are then canonicalized and filtered automatically to contain only those attributes that appear in the outputSet.

See Canonicalize for more details.

Attributes: protected
Definition Classes: QueryPlanConstraints

def verboseString(maxFields: Int): String

ONE line description of this node with more information

Definition Classes: QueryPlan → TreeNode

def verboseStringWithOperatorId(): String

Definition Classes: QueryPlan

def verboseStringWithSuffix(maxFields: Int): String

ONE line description of this node with some suffix information

Definition Classes: LogicalPlan → 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()

def withNewChildInternal(newChild: LogicalPlan): LogicalPlan

Attributes: protected
Definition Classes: CommentOnTable → UnaryLike

final def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan

Definition Classes: TreeNode

final def withNewChildrenInternal(newChildren: IndexedSeq[LogicalPlan]): LogicalPlan

Definition Classes: UnaryLike

Packages

CommentOnTable

case class CommentOnTable(table: LogicalPlan, comment: String) extends LogicalPlan with AlterTableCommand with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from AlterTableCommand

Inherited from UnaryCommand

Inherited from UnaryLike[LogicalPlan]

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlanConstraints

Inherited from ConstraintHelper

Inherited from LogicalPlanStats

Inherited from AnalysisHelper

Inherited from QueryPlan[LogicalPlan]

Inherited from SQLConfHelper

Inherited from TreeNode[LogicalPlan]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

CommentOnTable 

case class CommentOnTable(table: LogicalPlan, comment: String) extends LogicalPlan with AlterTableCommand with Product with Serializable

Instance Constructors

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from AlterTableCommand

Inherited from UnaryCommand

Inherited from UnaryLike[LogicalPlan]

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlanConstraints

Inherited from ConstraintHelper

Inherited from LogicalPlanStats

Inherited from AnalysisHelper

Inherited from QueryPlan[LogicalPlan]

Inherited from SQLConfHelper

Inherited from TreeNode[LogicalPlan]

Inherited from TreePatternBits

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

CommentOnTable