org.apache.spark.sql.execution

SparkPlan

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
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
Learn more about member selection
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]

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. Produces the result of the query as an RDD[InternalRow]

    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: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. lazy val allAttributes: AttributeSeq

    Definition Classes
    QueryPlan
  7. def apply(number: Int): TreeNode[_]

    Definition Classes
    TreeNode
  8. def argString: String

    Definition Classes
    TreeNode
  9. def asCode: String

    Definition Classes
    TreeNode
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. lazy val canonicalized: SparkPlan

    Definition Classes
    QueryPlan
  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  13. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]

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

    Definition Classes
    TreeNode
  15. def collectLeaves(): Seq[SparkPlan]

    Definition Classes
    TreeNode
  16. lazy val constraints: ExpressionSet

    Definition Classes
    QueryPlan
  17. lazy val containsChild: Set[TreeNode[_]]

    Definition Classes
    TreeNode
  18. def doExecuteBroadcast[T](): Broadcast[T]

    Overridden by concrete implementations of SparkPlan.

    Overridden by concrete implementations of SparkPlan. Produces the result of the query as a broadcast variable.

    Attributes
    protected[org.apache.spark.sql]
  19. 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.

    Note: the prepare method has already walked down the tree, so the implementation doesn't need to call children's prepare methods.

    This will only be called once, protected by this.

    Attributes
    protected
  20. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  21. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  22. 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.

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

  24. def executeCollect(): Array[InternalRow]

    Runs this query returning the result as an array.

  25. def executeCollectPublic(): Array[Row]

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

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

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

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

    Attributes
    protected
  27. 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.

  28. 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: this will trigger multiple jobs (one for each partition).

  29. final def expressions: Seq[Expression]

    Definition Classes
    QueryPlan
  30. def fastEquals(other: TreeNode[_]): Boolean

    Definition Classes
    TreeNode
  31. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  32. def find(f: (SparkPlan) ⇒ Boolean): Option[SparkPlan]

    Definition Classes
    TreeNode
  33. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]

    Definition Classes
    TreeNode
  34. def foreach(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  35. def foreachUp(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode
  36. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String, addSuffix: Boolean): StringBuilder

    Definition Classes
    TreeNode
  37. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  38. def getRelevantConstraints(constraints: Set[Expression]): Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  39. def hashCode(): Int

    Definition Classes
    TreeNode → AnyRef → Any
  40. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes
    protected
    Definition Classes
    Logging
  41. def innerChildren: Seq[QueryPlan[_]]

    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode
  42. def inputSet: AttributeSet

    Definition Classes
    QueryPlan
  43. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  44. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging
  45. def jsonFields: List[(String, JValue)]

    Attributes
    protected
    Definition Classes
    TreeNode
  46. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging
  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 logName: String

    Attributes
    protected
    Definition Classes
    Logging
  54. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  55. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  56. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Attributes
    protected
    Definition Classes
    Logging
  57. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging
  58. def longMetric(name: String): SQLMetric

    Return a LongSQLMetric according to the name.

  59. 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
  60. def map[A](f: (SparkPlan) ⇒ A): Seq[A]

    Definition Classes
    TreeNode
  61. def mapChildren(f: (SparkPlan) ⇒ SparkPlan): SparkPlan

    Definition Classes
    TreeNode
  62. def mapExpressions(f: (Expression) ⇒ Expression): SparkPlan.this.type

    Definition Classes
    QueryPlan
  63. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

    Attributes
    protected
    Definition Classes
    TreeNode
  64. def metadata: Map[String, String]

    Return all metadata that describes more details of this SparkPlan.

  65. def metrics: Map[String, SQLMetric]

    Return all metrics containing metrics of this SparkPlan.

  66. def missingInput: AttributeSet

    Definition Classes
    QueryPlan
  67. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  68. def newMutableProjection(expressions: Seq[Expression], inputSchema: Seq[Attribute], useSubexprElimination: Boolean = false): MutableProjection

    Attributes
    protected
  69. def newNaturalAscendingOrdering(dataTypes: Seq[DataType]): Ordering[InternalRow]

    Creates a row ordering for the given schema, in natural ascending order.

    Creates a row ordering for the given schema, in natural ascending order.

    Attributes
    protected
  70. def newOrdering(order: Seq[SortOrder], inputSchema: Seq[Attribute]): Ordering[InternalRow]

    Attributes
    protected
  71. def newPredicate(expression: Expression, inputSchema: Seq[Attribute]): Predicate

    Attributes
    protected
  72. def nodeName: String

    Definition Classes
    TreeNode
  73. final def notify(): Unit

    Definition Classes
    AnyRef
  74. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  75. def numberedTreeString: String

    Definition Classes
    TreeNode
  76. val origin: Origin

    Definition Classes
    TreeNode
  77. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode
  78. def outputOrdering: Seq[SortOrder]

    Specifies how data is ordered in each partition.

  79. def outputPartitioning: Partitioning

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

  80. def outputSet: AttributeSet

    Definition Classes
    QueryPlan
  81. def p(number: Int): SparkPlan

    Definition Classes
    TreeNode
  82. def preCanonicalized: SparkPlan

    Attributes
    protected
    Definition Classes
    QueryPlan
  83. final def prepare(): Unit

    Prepare a SparkPlan for execution.

    Prepare a SparkPlan for execution. It's idempotent.

  84. 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
  85. def prettyJson: String

    Definition Classes
    TreeNode
  86. def printSchema(): Unit

    Definition Classes
    QueryPlan
  87. def producedAttributes: AttributeSet

    Definition Classes
    QueryPlan
  88. def productIterator: Iterator[Any]

    Definition Classes
    Product
  89. def productPrefix: String

    Definition Classes
    Product
  90. def references: AttributeSet

    Definition Classes
    QueryPlan
  91. def requiredChildDistribution: Seq[Distribution]

    Specifies any partition requirements on the input data for this operator.

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

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

  93. def resetMetrics(): Unit

    Reset all the metrics.

  94. final def sameResult(other: SparkPlan): Boolean

    Definition Classes
    QueryPlan
  95. lazy val schema: StructType

    Definition Classes
    QueryPlan
  96. def schemaString: String

    Definition Classes
    QueryPlan
  97. final def semanticHash(): Int

    Definition Classes
    QueryPlan
  98. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode
  99. def sparkContext: SparkContext

    Attributes
    protected
  100. 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.

  101. def statePrefix: String

    Attributes
    protected
    Definition Classes
    QueryPlan
  102. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode
  103. val subexpressionEliminationEnabled: Boolean

  104. def subqueries: Seq[SparkPlan]

    Definition Classes
    QueryPlan
  105. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  106. def toJSON: String

    Definition Classes
    TreeNode
  107. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any
  108. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

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

    Definition Classes
    QueryPlan
  110. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode
  111. def transformExpressions(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type

    Definition Classes
    QueryPlan
  112. def transformExpressionsDown(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type

    Definition Classes
    QueryPlan
  113. def transformExpressionsUp(rule: PartialFunction[Expression, Expression]): SparkPlan.this.type

    Definition Classes
    QueryPlan
  114. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode
  115. def treeString(verbose: Boolean, addSuffix: Boolean): String

    Definition Classes
    TreeNode
  116. def treeString: String

    Definition Classes
    TreeNode
  117. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan
  118. def verboseString: String

    Definition Classes
    QueryPlan → TreeNode
  119. def verboseStringWithSuffix: String

    Definition Classes
    TreeNode
  120. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  121. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  122. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  123. 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
  124. 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