Packages

abstract class QueryPlan[PlanType <: QueryPlan[PlanType]] extends TreeNode[PlanType]

An abstraction of the Spark SQL query plan tree, which can be logical or physical. This class defines some basic properties of a query plan node, as well as some new transform APIs to transform the expressions of the plan node.

Note that, the query plan is a mutually recursive structure: QueryPlan -> Expression (subquery) -> QueryPlan The tree traverse APIs like transform, foreach, collect, etc. that are inherited from TreeNode, do not traverse into query plans inside subqueries.

Self Type
PlanType
Linear Supertypes
TreeNode[PlanType], Product, Equals, AnyRef, Any
Known Subclasses
NamedRelation, ResolvedNamespace, ResolvedTable, ResolvedView, UnresolvedHaving, UnresolvedInlineTable, UnresolvedNamespace, UnresolvedRelation, UnresolvedSubqueryColumnAliases, UnresolvedTable, UnresolvedTableOrView, UnresolvedTableValuedFunction, UnresolvedV2Relation, HiveTableRelation, UnresolvedCatalogRelation, DummyExpressionHolder, OrderedJoin, Aggregate, AlterNamespaceSetLocation, AlterNamespaceSetProperties, AlterTable, AlterTableAddColumnsStatement, AlterTableAddPartitionStatement, AlterTableAlterColumnStatement, AlterTableDropColumnsStatement, AlterTableDropPartitionStatement, AlterTableRecoverPartitionsStatement, AlterTableRenameColumnStatement, AlterTableRenamePartitionStatement, AlterTableSerDePropertiesStatement, AlterTableSetLocationStatement, AlterTableSetPropertiesStatement, AlterTableUnsetPropertiesStatement, AlterViewAsStatement, AlterViewSetPropertiesStatement, AlterViewUnsetPropertiesStatement, AnalysisHelper, AnalyzeColumnStatement, AnalyzeTableStatement, AppendColumns, AppendColumnsWithObject, AppendData, ArrowEvalPython, BaseEvalPython, BatchEvalPython, BinaryNode, CacheTableStatement, CoGroup, CollectMetrics, Command, CommentOnNamespace, CommentOnTable, CreateFunctionStatement, CreateNamespace, CreateNamespaceStatement, CreateTableAsSelect, CreateTableAsSelectStatement, CreateTableStatement, CreateV2Table, CreateViewStatement, Deduplicate, DeleteFromTable, DescribeColumnStatement, DescribeFunctionStatement, DescribeNamespace, DescribeRelation, DeserializeToObject, Distinct, DropFunctionStatement, DropNamespace, DropTable, DropTableStatement, DropViewStatement, EventTimeWatermark, Except, Expand, Filter, FlatMapCoGroupsInPandas, FlatMapGroupsInPandas, FlatMapGroupsInR, FlatMapGroupsInRWithArrow, FlatMapGroupsWithState, Generate, GlobalLimit, GroupingSets, IgnoreCachedData, InsertIntoDir, InsertIntoStatement, Intersect, Join, LeafNode, LoadDataStatement, LocalLimit, LocalRelation, LogicalPlan, MapElements, MapGroups, MapInPandas, MapPartitions, MapPartitionsInR, MapPartitionsInRWithArrow, MergeIntoTable, ObjectConsumer, ObjectProducer, OneRowRelation, OrderPreservingUnaryNode, OverwriteByExpression, OverwritePartitionsDynamic, ParsedStatement, Pivot, Project, Range, RefreshTable, RefreshTableStatement, RenameTable, RenameTableStatement, RepairTableStatement, Repartition, RepartitionByExpression, RepartitionOperation, ReplaceTable, ReplaceTableAsSelect, ReplaceTableAsSelectStatement, ReplaceTableStatement, ResolvedHint, ReturnAnswer, Sample, ScriptTransformation, SerializeFromObject, SetCatalogAndNamespace, SetOperation, ShowColumnsStatement, ShowCreateTableStatement, ShowCurrentNamespace, ShowCurrentNamespaceStatement, ShowFunctionsStatement, ShowNamespaces, ShowPartitionsStatement, ShowTableProperties, ShowTableStatement, ShowTables, ShowViews, Sort, Subquery, SubqueryAlias, SupportsSubquery, Tail, TruncateTableStatement, TypedFilter, UnaryNode, UncacheTableStatement, Union, UnresolvedHint, UpdateTable, UseStatement, V2CreateTablePlan, V2WriteCommand, View, Window, With, WithWindowDefinition, DataSourceV2Relation, DataSourceV2ScanRelation, StreamingDataSourceV2Relation
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryPlan
  2. TreeNode
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new QueryPlan()

Abstract Value Members

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

    Returns a Seq of the children of this node.

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

    Definition Classes
    TreeNode
  3. abstract def output: Seq[Attribute]
  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.

  5. 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
  6. 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
  7. 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
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final lazy val canonicalized: PlanType

    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.

    Annotations
    @transient()
  10. def clone(): PlanType
    Definition Classes
    TreeNode → AnyRef
  11. def collect[B](pf: PartialFunction[PlanType, B]): Seq[B]

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Returns a Seq containing the result of applying a partial function to all elements in this tree on which the function is defined.

    Definition Classes
    TreeNode
  12. def collectFirst[B](pf: PartialFunction[PlanType, B]): Option[B]

    Finds and returns the first TreeNode of the tree for which the given partial function is defined (pre-order), and applies the partial function to it.

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

    Returns a Seq containing the leaves in this tree.

    Returns a Seq containing the leaves in this tree.

    Definition Classes
    TreeNode
  14. def collectWithSubqueries[B](f: PartialFunction[PlanType, B]): Seq[B]

    A variant of collect.

    A variant of collect. This method not only apply the given function to all elements in this plan, also considering all the plans in its (nested) subqueries

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

  16. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  17. def copyTagsFrom(other: PlanType): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  18. def doCanonicalize(): PlanType

    Defines how the canonicalization should work for the current plan.

    Defines how the canonicalization should work for the current plan.

    Attributes
    protected
  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. final def expressions: Seq[Expression]

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

  22. 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
  23. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  24. def find(f: (PlanType) ⇒ Boolean): Option[PlanType]

    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
  25. def flatMap[A](f: (PlanType) ⇒ TraversableOnce[A]): Seq[A]

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

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

    Definition Classes
    TreeNode
  26. def foreach(f: (PlanType) ⇒ 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
  27. def foreachUp(f: (PlanType) ⇒ 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
  28. def formattedNodeName: String
    Attributes
    protected
  29. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String = "", addSuffix: Boolean = false, maxFields: Int, printNodeId: Boolean): 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
  30. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  32. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  33. 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
  34. def inputSet: AttributeSet

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

  35. def isCanonicalizedPlan: Boolean
    Attributes
    protected
  36. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  37. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  38. def makeCopy(newArgs: Array[AnyRef]): PlanType

    Creates a copy of this type of tree node after a transformation.

    Creates a copy of this type of tree node after a transformation. Must be overridden by child classes that have constructor arguments that are not present in the productIterator.

    newArgs

    the new product arguments.

    Definition Classes
    TreeNode
  39. def map[A](f: (PlanType) ⇒ A): Seq[A]

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    Returns a Seq containing the result of applying the given function to each node in this tree in a preorder traversal.

    f

    the function to be applied.

    Definition Classes
    TreeNode
  40. def mapChildren(f: (PlanType) ⇒ PlanType): PlanType

    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
  41. def mapExpressions(f: (Expression) ⇒ Expression): QueryPlan.this.type

    Apply a map function to each expression present in this query operator, and return a new query operator based on the mapped expressions.

  42. 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
  43. final def missingInput: AttributeSet

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

  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. 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
  46. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  48. 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
  49. val origin: Origin
    Definition Classes
    TreeNode
  50. 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
  51. lazy val outputSet: AttributeSet

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

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

    Annotations
    @transient()
  52. def p(number: Int): PlanType

    Returns the tree node at the specified number, used primarily for interactive debugging.

    Returns the tree node at the specified number, used primarily for interactive debugging. Numbers for each node can be found in the numberedTreeString.

    This is a variant of apply that returns the node as BaseType (if the type matches).

    Definition Classes
    TreeNode
  53. def prettyJson: String
    Definition Classes
    TreeNode
  54. def printSchema(): Unit

    Prints out the schema in the tree format

  55. def producedAttributes: AttributeSet

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

  56. def productIterator: Iterator[Any]
    Definition Classes
    Product
  57. def productPrefix: String
    Definition Classes
    Product
  58. lazy val references: AttributeSet

    All Attributes that appear in expressions from this operator.

    All Attributes that appear in expressions from this operator. Note that this set does not include attributes that are implicitly referenced by being passed through to the output tuple.

    Annotations
    @transient()
  59. final def sameResult(other: PlanType): Boolean

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

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

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

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

  60. lazy val schema: StructType
  61. def schemaString: String

    Returns the output schema in the tree format.

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

  63. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  64. 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
    QueryPlan → TreeNode
  65. 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
    QueryPlan → TreeNode
  66. 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
  67. 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
  68. def subqueries: Seq[PlanType]

    All the top-level subqueries of the current plan node.

    All the top-level subqueries of the current plan node. Nested subqueries are not included.

  69. def subqueriesAll: Seq[PlanType]

    All the subqueries of the current plan node and all its children.

    All the subqueries of the current plan node and all its children. Nested subqueries are also included.

  70. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  71. def toJSON: String
    Definition Classes
    TreeNode
  72. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  73. def transform(rule: PartialFunction[PlanType, PlanType]): PlanType

    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
  74. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.this.type

    Returns the result of running transformExpressions on this node and all its children.

    Returns the result of running transformExpressions on this node and all its children. Note that this method skips expressions inside subqueries.

  75. def transformDown(rule: PartialFunction[PlanType, PlanType]): PlanType

    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
  76. def transformExpressions(rule: PartialFunction[Expression, Expression]): QueryPlan.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.

  77. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): QueryPlan.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.

  78. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): QueryPlan.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.

  79. def transformUp(rule: PartialFunction[PlanType, PlanType]): PlanType

    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 use to transform this nodes children

    Definition Classes
    TreeNode
  80. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  81. final def treeString(verbose: Boolean, addSuffix: Boolean = false, maxFields: Int = SQLConf.get.maxToStringFields, printOperatorId: Boolean = false): String
    Definition Classes
    TreeNode
  82. 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
  83. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  84. 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
    QueryPlan → TreeNode
  85. def verboseStringWithOperatorId(): String
  86. def verboseStringWithSuffix(maxFields: Int): String

    ONE line description of this node with some suffix information

    ONE line description of this node with some suffix information

    Definition Classes
    TreeNode
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  88. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  89. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  90. def withNewChildren(newChildren: Seq[PlanType]): PlanType

    Returns a copy of this node with the children replaced.

    Returns a copy of this node with the children replaced. TODO: Validate somewhere (in debug mode?) that children are ordered correctly.

    Definition Classes
    TreeNode

Inherited from TreeNode[PlanType]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped