Packages

abstract class SparkPlan extends QueryPlan[SparkPlan] with Logging with Serializable

The base class for physical operators.

The naming convention is that physical operators end with "Exec" suffix, e.g. ProjectExec.

Linear Supertypes
Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], Product, Equals, AnyRef, Any
Known Subclasses
AliasAwareOutputPartitioning, AppendColumnsExec, AppendColumnsWithObjectExec, BaseLimitExec, BaseSubqueryExec, BinaryExecNode, BlockingOperatorWithCodegen, CoGroupExec, CoalesceExec, CodegenSupport, CollectLimitExec, CollectMetricsExec, CollectTailExec, ColumnarToRowExec, DataSourceScanExec, DeserializeToObjectExec, ExpandExec, ExternalRDDScanExec, FileSourceScanExec, FilterExec, FlatMapGroupsInRExec, FlatMapGroupsInRWithArrowExec, GenerateExec, GlobalLimitExec, InputAdapter, InputRDDCodegen, LeafExecNode, LimitExec, LocalLimitExec, LocalTableScanExec, MapElementsExec, MapGroupsExec, MapPartitionsExec, MapPartitionsInRWithArrowExec, ObjectConsumerExec, ObjectProducerExec, PlanLater, ProjectExec, RDDScanExec, RangeExec, ReusedSubqueryExec, RowDataSourceScanExec, RowToColumnarExec, SampleExec, SerializeFromObjectExec, SortExec, SubqueryBroadcastExec, SubqueryExec, TakeOrderedAndProjectExec, UnaryExecNode, UnionExec, WholeStageCodegenExec, AdaptiveSparkPlanExec, BroadcastQueryStageExec, CustomShuffleReaderExec, QueryStageExec, ShuffleQueryStageExec, BaseAggregateExec, HashAggregateExec, ObjectHashAggregateExec, SortAggregateExec, InMemoryTableScanExec, DataWritingCommandExec, ExecutedCommandExec, AlterNamespaceSetPropertiesExec, AlterTableExec, AppendDataExec, AppendDataExecV1, AtomicCreateTableAsSelectExec, AtomicReplaceTableAsSelectExec, AtomicReplaceTableExec, BatchScanExec, ContinuousScanExec, CreateNamespaceExec, CreateTableAsSelectExec, CreateTableExec, DataSourceV2ScanExecBase, DeleteFromTableExec, DescribeNamespaceExec, DescribeTableExec, DropNamespaceExec, DropTableExec, MicroBatchScanExec, OverwriteByExpressionExec, OverwriteByExpressionExecV1, OverwritePartitionsDynamicExec, RefreshTableExec, RenameTableExec, ReplaceTableAsSelectExec, ReplaceTableExec, SetCatalogAndNamespaceExec, ShowCurrentNamespaceExec, ShowNamespacesExec, ShowTablePropertiesExec, ShowTablesExec, SupportsV1Write, V1FallbackWriters, V2CommandExec, V2TableWriteExec, WriteToDataSourceV2Exec, DebugExec, BroadcastExchangeExec, BroadcastExchangeLike, Exchange, ReusedExchangeExec, ShuffleExchangeExec, ShuffleExchangeLike, BroadcastHashJoinExec, BroadcastNestedLoopJoinExec, CartesianProductExec, ShuffledHashJoinExec, SortMergeJoinExec, AggregateInPandasExec, ArrowEvalPythonExec, BatchEvalPythonExec, EvalPythonExec, FlatMapCoGroupsInPandasExec, FlatMapGroupsInPandasExec, MapInPandasExec, WindowInPandasExec, EventTimeWatermarkExec, FlatMapGroupsWithStateExec, StateStoreReader, StateStoreRestoreExec, StateStoreSaveExec, StateStoreWriter, StatefulOperator, StreamingDeduplicateExec, StreamingGlobalLimitExec, StreamingLocalLimitExec, StreamingRelationExec, StreamingSymmetricHashJoinExec, WatermarkSupport, ContinuousCoalesceExec, WriteToContinuousDataSourceExec, WindowExec, WindowExecBase
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparkPlan
  2. Serializable
  3. Serializable
  4. Logging
  5. QueryPlan
  6. TreeNode
  7. Product
  8. Equals
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SparkPlan()

Abstract Value Members

  1. abstract def canEqual(that: Any): Boolean
    Definition Classes
    Equals
  2. abstract def children: Seq[SparkPlan]
    Definition Classes
    TreeNode
  3. abstract def doExecute(): RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Produces the result of the query as an RDD[InternalRow]

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected
  4. abstract def output: Seq[Attribute]
    Definition Classes
    QueryPlan
  5. abstract def productArity: Int
    Definition Classes
    Product
  6. 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
    Definition Classes
    QueryPlan
  5. def apply(number: Int): TreeNode[_]
    Definition Classes
    TreeNode
  6. def argString(maxFields: Int): String
    Definition Classes
    TreeNode
  7. def asCode: String
    Definition Classes
    TreeNode
  8. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  9. final lazy val canonicalized: SparkPlan
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  10. def cleanupResources(): Unit

    Cleans up the resources used by the physical operator (if any).

    Cleans up the resources used by the physical operator (if any). In general, all the resources should be cleaned up when the task finishes but operators like SortMergeJoinExec and LimitExec may want eager cleanup to free up tight resources (e.g., memory).

    Attributes
    protected[sql]
  11. def clone(): SparkPlan
    Definition Classes
    TreeNode → AnyRef
  12. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    TreeNode
  13. def collectFirst[B](pf: PartialFunction[SparkPlan, B]): Option[B]
    Definition Classes
    TreeNode
  14. def collectLeaves(): Seq[SparkPlan]
    Definition Classes
    TreeNode
  15. def collectWithSubqueries[B](f: PartialFunction[SparkPlan, B]): Seq[B]
    Definition Classes
    QueryPlan
  16. def conf: SQLConf
    Definition Classes
    QueryPlan
  17. lazy val containsChild: Set[TreeNode[_]]
    Definition Classes
    TreeNode
  18. def copyTagsFrom(other: SparkPlan): Unit
    Attributes
    protected
    Definition Classes
    TreeNode
  19. def doCanonicalize(): SparkPlan
    Attributes
    protected
    Definition Classes
    QueryPlan
  20. def doExecuteBroadcast[T](): Broadcast[T]

    Produces the result of the query as a broadcast variable.

    Produces the result of the query as a broadcast variable.

    Overridden by concrete implementations of SparkPlan.

    Attributes
    protected[sql]
  21. def doExecuteColumnar(): RDD[ColumnarBatch]

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true.

    Produces the result of the query as an RDD[ColumnarBatch] if supportsColumnar returns true. By convention the executor that creates a ColumnarBatch is responsible for closing it when it is no longer needed. This allows input formats to be able to reuse batches if needed.

    Attributes
    protected
  22. def doPrepare(): Unit

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. It is guaranteed to run before any execute of SparkPlan. This is helpful if we want to set up some state before executing the query, e.g., BroadcastHashJoin uses it to broadcast asynchronously.

    Attributes
    protected
    Note

    prepare method has already walked down the tree, so the implementation doesn't have to call children's prepare methods. This will only be called once, protected by this.

  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. final def execute(): RDD[InternalRow]

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Returns the result of this query as an RDD[InternalRow] by delegating to doExecute after preparations.

    Concrete implementations of SparkPlan should override doExecute.

  26. final def executeBroadcast[T](): Broadcast[T]

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Returns the result of this query as a broadcast variable by delegating to doExecuteBroadcast after preparations.

    Concrete implementations of SparkPlan should override doExecuteBroadcast.

  27. def executeCollect(): Array[InternalRow]

    Runs this query returning the result as an array.

  28. def executeCollectPublic(): Array[Row]

    Runs this query returning the result as an array, using external Row format.

  29. final def executeColumnar(): RDD[ColumnarBatch]

    Returns the result of this query as an RDD[ColumnarBatch] by delegating to doColumnarExecute after preparations.

    Returns the result of this query as an RDD[ColumnarBatch] by delegating to doColumnarExecute after preparations.

    Concrete implementations of SparkPlan should override doColumnarExecute if supportsColumnar returns true.

  30. final def executeQuery[T](query: ⇒ T): T

    Executes a query after preparing the query and adding query plan information to created RDDs for visualization.

    Executes a query after preparing the query and adding query plan information to created RDDs for visualization.

    Attributes
    protected
  31. def executeTail(n: Int): Array[InternalRow]

    Runs this query returning the last n rows as an array.

    Runs this query returning the last n rows as an array.

    This is modeled after RDD.take but never runs any job locally on the driver.

  32. def executeTake(n: Int): Array[InternalRow]

    Runs this query returning the first n rows as an array.

    Runs this query returning the first n rows as an array.

    This is modeled after RDD.take but never runs any job locally on the driver.

  33. def executeToIterator(): Iterator[InternalRow]

    Runs this query returning the result as an iterator of InternalRow.

    Runs this query returning the result as an iterator of InternalRow.

    Note

    Triggers multiple jobs (one for each partition).

  34. final def expressions: Seq[Expression]
    Definition Classes
    QueryPlan
  35. def fastEquals(other: TreeNode[_]): Boolean
    Definition Classes
    TreeNode
  36. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  37. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]
    Definition Classes
    TreeNode
  38. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]
    Definition Classes
    TreeNode
  39. def foreach(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  40. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit
    Definition Classes
    TreeNode
  41. def formattedNodeName: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  42. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], append: (String) ⇒ Unit, verbose: Boolean, prefix: String, addSuffix: Boolean, maxFields: Int, printNodeId: Boolean): Unit
    Definition Classes
    TreeNode
  43. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  44. def getTagValue[T](tag: TreeNodeTag[T]): Option[T]
    Definition Classes
    TreeNode
  45. def hashCode(): Int
    Definition Classes
    TreeNode → AnyRef → Any
  46. val id: Int
  47. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  48. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def innerChildren: Seq[QueryPlan[_]]
    Definition Classes
    QueryPlan → TreeNode
  50. def inputSet: AttributeSet
    Definition Classes
    QueryPlan
  51. def isCanonicalizedPlan: Boolean
    Attributes
    protected
    Definition Classes
    QueryPlan
  52. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  53. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  54. def jsonFields: List[JField]
    Attributes
    protected
    Definition Classes
    TreeNode
  55. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  56. def logDebug(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logDebug(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logError(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logError(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logInfo(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logInfo(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  63. def logTrace(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  64. def logTrace(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  65. def logWarning(msg: ⇒ String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  66. def logWarning(msg: ⇒ String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  67. def logicalLink: Option[LogicalPlan]

    returns

    The logical plan this plan is linked to.

  68. def longMetric(name: String): SQLMetric

    returns

    SQLMetric for the name.

  69. def makeCopy(newArgs: Array[AnyRef]): SparkPlan

    Overridden make copy also propagates sqlContext to copied plan.

    Overridden make copy also propagates sqlContext to copied plan.

    Definition Classes
    SparkPlan → TreeNode
  70. def map[A](f: (SparkPlan) ⇒ A): Seq[A]
    Definition Classes
    TreeNode
  71. def mapChildren(f: (SparkPlan) ⇒ SparkPlan): SparkPlan
    Definition Classes
    TreeNode
  72. def mapExpressions(f: (Expression) ⇒ Expression): SparkPlan.this.type
    Definition Classes
    QueryPlan
  73. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]
    Attributes
    protected
    Definition Classes
    TreeNode
  74. def metrics: Map[String, SQLMetric]

    returns

    All metrics containing metrics of this SparkPlan.

  75. final def missingInput: AttributeSet
    Definition Classes
    QueryPlan
  76. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  77. def nodeName: String
    Definition Classes
    TreeNode
  78. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  79. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  80. def numberedTreeString: String
    Definition Classes
    TreeNode
  81. val origin: Origin
    Definition Classes
    TreeNode
  82. def otherCopyArgs: Seq[AnyRef]
    Attributes
    protected
    Definition Classes
    TreeNode
  83. def outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

  84. def outputPartitioning: Partitioning

    Specifies how data is partitioned across different nodes in the cluster.

  85. lazy val outputSet: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  86. def p(number: Int): SparkPlan
    Definition Classes
    TreeNode
  87. final def prepare(): Unit

    Prepares this SparkPlan for execution.

    Prepares this SparkPlan for execution. It's idempotent.

  88. def prepareSubqueries(): Unit

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Finds scalar subquery expressions in this plan node and starts evaluating them.

    Attributes
    protected
  89. def prettyJson: String
    Definition Classes
    TreeNode
  90. def printSchema(): Unit
    Definition Classes
    QueryPlan
  91. def producedAttributes: AttributeSet
    Definition Classes
    QueryPlan
  92. def productIterator: Iterator[Any]
    Definition Classes
    Product
  93. def productPrefix: String
    Definition Classes
    Product
  94. lazy val references: AttributeSet
    Definition Classes
    QueryPlan
    Annotations
    @transient()
  95. def requiredChildDistribution: Seq[Distribution]

    Specifies the data distribution requirements of all the children for this operator.

    Specifies the data distribution requirements of all the children for this operator. By default it's UnspecifiedDistribution for each child, which means each child can have any distribution.

    If an operator overwrites this method, and specifies distribution requirements(excluding UnspecifiedDistribution and BroadcastDistribution) for more than one child, Spark guarantees that the outputs of these children will have same number of partitions, so that the operator can safely zip partitions of these children's result RDDs. Some operators can leverage this guarantee to satisfy some interesting requirement, e.g., non-broadcast joins can specify HashClusteredDistribution(a,b) for its left child, and specify HashClusteredDistribution(c,d) for its right child, then it's guaranteed that left and right child are co-partitioned by a,b/c,d, which means tuples of same value are in the partitions of same index, e.g., (a=1,b=2) and (c=1,d=2) are both in the second partition of left and right child.

  96. def requiredChildOrdering: Seq[Seq[SortOrder]]

    Specifies sort order for each partition requirements on the input data for this operator.

  97. def resetMetrics(): Unit

    Resets all the metrics.

  98. final def sameResult(other: SparkPlan): Boolean
    Definition Classes
    QueryPlan
  99. lazy val schema: StructType
    Definition Classes
    QueryPlan
  100. def schemaString: String
    Definition Classes
    QueryPlan
  101. final def semanticHash(): Int
    Definition Classes
    QueryPlan
  102. def setLogicalLink(logicalPlan: LogicalPlan): Unit

    Set logical plan link recursively if unset.

  103. def setTagValue[T](tag: TreeNodeTag[T], value: T): Unit
    Definition Classes
    TreeNode
  104. def simpleString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  105. def simpleStringWithNodeId(): String
    Definition Classes
    QueryPlan → TreeNode
  106. def sparkContext: SparkContext
    Attributes
    protected
  107. final val sqlContext: SQLContext

    A handle to the SQL Context that was used to create this plan.

    A handle to the SQL Context that was used to create this plan. Since many operators need access to the sqlContext for RDD operations or configuration this field is automatically populated by the query planning infrastructure.

  108. def statePrefix: String
    Attributes
    protected
    Definition Classes
    QueryPlan
  109. def stringArgs: Iterator[Any]
    Attributes
    protected
    Definition Classes
    TreeNode
  110. def subqueries: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  111. def subqueriesAll: Seq[SparkPlan]
    Definition Classes
    QueryPlan
  112. def supportsColumnar: Boolean

    Return true if this stage of the plan supports columnar execution.

  113. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  114. def toJSON: String
    Definition Classes
    TreeNode
  115. def toString(): String
    Definition Classes
    TreeNode → AnyRef → Any
  116. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  117. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type
    Definition Classes
    QueryPlan
  118. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  119. def transformExpressions(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type
    Definition Classes
    QueryPlan
  120. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type
    Definition Classes
    QueryPlan
  121. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type
    Definition Classes
    QueryPlan
  122. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan
    Definition Classes
    TreeNode
  123. def treeString(append: (String) ⇒ Unit, verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): Unit
    Definition Classes
    TreeNode
  124. final def treeString(verbose: Boolean, addSuffix: Boolean, maxFields: Int, printOperatorId: Boolean): String
    Definition Classes
    TreeNode
  125. final def treeString: String
    Definition Classes
    TreeNode
  126. def unsetTagValue[T](tag: TreeNodeTag[T]): Unit
    Definition Classes
    TreeNode
  127. def vectorTypes: Option[Seq[String]]

    The exact java types of the columns that are output in columnar processing mode.

    The exact java types of the columns that are output in columnar processing mode. This is a performance optimization for code generation and is optional.

  128. def verboseString(maxFields: Int): String
    Definition Classes
    QueryPlan → TreeNode
  129. def verboseStringWithOperatorId(): String
    Definition Classes
    QueryPlan
  130. def verboseStringWithSuffix(maxFields: Int): String
    Definition Classes
    TreeNode
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  133. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  134. def waitForSubqueries(): Unit

    Blocks the thread until all subqueries finish evaluation and update the results.

    Blocks the thread until all subqueries finish evaluation and update the results.

    Attributes
    protected
  135. def withNewChildren(newChildren: Seq[SparkPlan]): SparkPlan
    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from QueryPlan[SparkPlan]

Inherited from TreeNode[SparkPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped