Packages

abstract class LogicalPlan extends QueryPlan[LogicalPlan] with AnalysisHelper with LogicalPlanStats with QueryPlanConstraints with Logging

Known Subclasses
NamedRelation, ResolvedFunc, ResolvedNamespace, ResolvedTable, ResolvedView, UnresolvedFunc, UnresolvedHaving, UnresolvedInlineTable, UnresolvedNamespace, UnresolvedRelation, UnresolvedSubqueryColumnAliases, UnresolvedTable, UnresolvedTableOrView, UnresolvedTableValuedFunction, UnresolvedV2Relation, UnresolvedView, DummyExpressionHolder, Aggregate, AlterNamespaceSetLocation, AlterNamespaceSetProperties, AlterTable, AlterTableAddColumnsStatement, AlterTableAddPartition, AlterTableAlterColumnStatement, AlterTableDropColumnsStatement, AlterTableDropPartition, AlterTableRecoverPartitions, AlterTableRenameColumnStatement, AlterTableRenamePartition, AlterTableReplaceColumnsStatement, AlterTableSerDeProperties, AlterTableSetLocationStatement, AlterTableSetPropertiesStatement, AlterTableUnsetPropertiesStatement, AlterViewAs, AlterViewSetProperties, AlterViewUnsetProperties, AnalyzeColumn, AnalyzeTable, AppendColumns, AppendColumnsWithObject, AppendData, BinaryNode, CacheTable, CacheTableAsSelect, CoGroup, CollectMetrics, Command, CommentOnNamespace, CommentOnTable, CreateFunctionStatement, CreateNamespace, CreateNamespaceStatement, CreateTableAsSelect, CreateTableAsSelectStatement, CreateTableStatement, CreateV2Table, CreateViewStatement, Deduplicate, DeleteFromTable, DescribeColumn, DescribeFunction, DescribeNamespace, DescribeRelation, DeserializeToObject, Distinct, DropFunction, DropNamespace, DropTable, DropView, EventTimeWatermark, Except, Expand, Filter, Generate, GlobalLimit, GroupingSets, IgnoreCachedData, InsertIntoStatement, Intersect, Join, LeafNode, LoadData, LocalLimit, LocalRelation, MapElements, MapGroups, MergeIntoTable, NoopCommand, ObjectConsumer, ObjectProducer, OneRowRelation, OrderPreservingUnaryNode, OverwriteByExpression, OverwritePartitionsDynamic, ParsedStatement, Pivot, Project, Range, RefreshFunction, RefreshTable, RenameTable, RepairTable, Repartition, RepartitionOperation, ReplaceTable, ReplaceTableAsSelect, ReplaceTableAsSelectStatement, ReplaceTableStatement, ResolvedHint, ReturnAnswer, Sample, ScriptTransformation, SerializeFromObject, SetCatalogAndNamespace, SetOperation, ShowColumns, ShowCreateTable, ShowCurrentNamespace, ShowCurrentNamespaceStatement, ShowFunctions, ShowNamespaces, ShowPartitions, ShowTableExtended, ShowTableProperties, ShowTables, ShowViews, Sort, Subquery, SubqueryAlias, SupportsSubquery, Tail, TruncateTable, TypedFilter, UnaryNode, UncacheTable, Union, UnresolvedHint, UpdateTable, UseStatement, V2CreateTablePlan, V2WriteCommand, Window, With, WithWindowDefinition
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LogicalPlan
  2. Logging
  3. QueryPlanConstraints
  4. ConstraintHelper
  5. LogicalPlanStats
  6. AnalysisHelper
  7. QueryPlan
  8. SQLConfHelper
  9. TreeNode
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LogicalPlan()

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def children: Seq[LogicalPlan]

    Returns a Seq of the children of this node.

    Returns a Seq of the children of this node. Children should not change. Immutability required for containsChild optimization

    Definition Classes
    TreeNode
  3. abstract def output: Seq[Attribute]
    Definition Classes
    QueryPlan
  4. abstract def productArity: Int
    Definition Classes
    Product
  5. abstract def productElement(n: Int): Any
    Definition Classes
    Product

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. lazy val allAttributes: AttributeSeq

    All the attributes that are used for this plan.

    All the attributes that are used for this plan.

    Definition Classes
    QueryPlan
  5. 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
  6. 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
  7. 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
  8. 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
  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def assertNotAnalysisRule(): Unit
    Attributes
    protected
    Definition Classes
    AnalysisHelper
  11. 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.)

    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()
  12. def childrenResolved: Boolean

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

  13. def clone(): LogicalPlan
    Definition Classes
    AnalysisHelperTreeNode → AnyRef
  14. 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.

    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
  15. 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.

    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
  16. def collectLeaves(): Seq[LogicalPlan]

    Returns a Seq containing the leaves in this tree.

    Returns a Seq containing the leaves in this tree.

    Definition Classes
    TreeNode
  17. 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
  18. def conf: get

    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
  19. 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
  20. 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
  21. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  22. def copyTagsFrom(other: LogicalPlan): Unit
    Definition Classes
    TreeNode
  23. def doCanonicalize(): LogicalPlan

    Defines how the canonicalization should work for the current plan.

    Defines how the canonicalization should work for the current plan.

    Attributes
    protected
    Definition Classes
    QueryPlan
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. final def expressions: Seq[Expression]

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

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

    Definition Classes
    QueryPlan
  27. 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
  28. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  29. 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
  30. 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.

    Returns a Seq by applying a function to all nodes in this tree and using the elements of the resulting collections.

    Definition Classes
    TreeNode
  31. def foreach(f: (LogicalPlan) => Unit): Unit

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

    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
  32. def foreachUp(f: (LogicalPlan) => Unit): Unit

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

    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
  33. def formattedNodeName: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  34. 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.

    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
  35. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  36. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  37. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  38. 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
  39. 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
    QueryPlanTreeNode
  40. def inputSet: AttributeSet

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

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

    Definition Classes
    QueryPlan
  41. final def invalidateStatsCache(): Unit

    Invalidates the stats cache.

    Invalidates the stats cache. See stats for more information.

    Definition Classes
    LogicalPlanStats
  42. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  43. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  44. def isStreaming: Boolean

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

  45. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  46. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  47. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  55. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. 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
  58. 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.

    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
  59. def mapChildren(f: (LogicalPlan) => LogicalPlan): LogicalPlan

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

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

    Definition Classes
    TreeNode
  60. def mapExpressions(f: (Expression) => Expression): LogicalPlan.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.

    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
  61. 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
  62. def maxRows: Option[Long]

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

    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).

  63. def maxRowsPerPartition: Option[Long]

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

  64. def metadataOutput: Seq[Attribute]

    Metadata fields that can be projected from this node

  65. final def missingInput: AttributeSet

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

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

    Definition Classes
    QueryPlan
  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. 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
  68. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  69. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  70. 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
  71. val origin: Origin
    Definition Classes
    TreeNode
  72. 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
  73. def outputOrdering: Seq[SortOrder]

    Returns the output ordering that this plan generates.

  74. lazy val outputSet: AttributeSet

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

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

    Definition Classes
    QueryPlan
    Annotations
    @transient()
  75. 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
  76. def prettyJson: String
    Definition Classes
    TreeNode
  77. def printSchema(): Unit

    Prints out the schema in the tree format

    Prints out the schema in the tree format

    Definition Classes
    QueryPlan
  78. def producedAttributes: AttributeSet

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

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

    Definition Classes
    QueryPlan
  79. def productElementName(n: Int): String
    Definition Classes
    Product
  80. def productElementNames: Iterator[String]
    Definition Classes
    Product
  81. def productIterator: Iterator[Any]
    Definition Classes
    Product
  82. def productPrefix: String
    Definition Classes
    Product
  83. 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()
  84. def refresh(): Unit

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

  85. 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]....

  86. 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.

  87. 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]....

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

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

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

    Definition Classes
    AnalysisHelper
  89. 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 use to transform this nodes children

    Definition Classes
    AnalysisHelper
  90. def resolveOperatorsDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Similar to resolveOperatorsUp, but does it top-down.

    Similar to resolveOperatorsUp, but does it top-down.

    Definition Classes
    AnalysisHelper
  91. 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 use to transform this nodes children

    Definition Classes
    AnalysisHelper
  92. def resolveOperatorsUpWithNewOutput(rule: PartialFunction[LogicalPlan, (LogicalPlan, Seq[(Attribute, Attribute)])]): LogicalPlan

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

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

    Definition Classes
    AnalysisHelper
  93. 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".

  94. 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).

  95. def sameOutput(other: LogicalPlan): Boolean

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

    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.
  96. final def sameResult(other: LogicalPlan): Boolean

    Returns true when the given query plan will return the same results as this query plan.

    Returns true when the given query plan will return the same results as this query plan.

    Since its likely undecidable to generally determine if two given plans will produce the same results, it is okay for this function to return false, even if the results are actually the same. Such behavior will not affect correctness, only the application of performance enhancements like caching. However, it is not acceptable to return true if the results could possibly be different.

    This function performs a modified version of equality that is tolerant of cosmetic differences like attribute naming and or expression id differences.

    Definition Classes
    QueryPlan
  97. lazy val schema: StructType
    Definition Classes
    QueryPlan
  98. def schemaString: String

    Returns the output schema in the tree format.

    Returns the output schema in the tree format.

    Definition Classes
    QueryPlan
  99. 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
  100. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  101. 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
    QueryPlanTreeNode
  102. 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
    QueryPlanTreeNode
  103. def statePrefix: String

    A prefix string used when printing the plan.

    A prefix string used when printing the plan.

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

    Attributes
    protected
    Definition Classes
    LogicalPlanQueryPlan
  104. 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
    LogicalPlanStats
  105. val statsCache: Option[Statistics]

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

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

    Attributes
    protected
    Definition Classes
    LogicalPlanStats
  106. 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
  107. 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
  108. 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
  109. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  110. def toJSON: String
    Definition Classes
    TreeNode
  111. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  112. 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 use to transform this nodes children

    Definition Classes
    TreeNode
  113. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): LogicalPlan.this.type

    Use resolveExpressions() in the analyzer.

    Use resolveExpressions() in the analyzer.

    Definition Classes
    AnalysisHelperQueryPlan
    See also

    QueryPlan.transformAllExpressions()

  114. def transformDown(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.

    rule

    the function used to transform this nodes children

    Definition Classes
    AnalysisHelperTreeNode
    See also

    org.apache.spark.sql.catalyst.trees.TreeNode.transformDown().

  115. def transformExpressions(rule: PartialFunction[Expression, Expression]): LogicalPlan.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
  116. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): LogicalPlan.this.type

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

    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
  117. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): LogicalPlan.this.type

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

    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
  118. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Use resolveOperators() in the analyzer.

    Use resolveOperators() in the analyzer.

    rule

    the function use to transform this nodes children

    Definition Classes
    AnalysisHelperTreeNode
    See also

    org.apache.spark.sql.catalyst.trees.TreeNode.transformUp()

  119. 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.

    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
    AnalysisHelperQueryPlan
  120. def treeString(append: (String) => Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  121. final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
    Definition Classes
    TreeNode
  122. 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
  123. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  124. 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
  125. 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
    QueryPlanTreeNode
  126. def verboseStringWithOperatorId(): String
    Definition Classes
    QueryPlan
  127. 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
    LogicalPlanTreeNode
  128. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  131. def withNewChildren(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.

    Definition Classes
    TreeNode

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 Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped