org.apache.spark.sql.execution

ExplainCommand

case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute], extended: Boolean)(context: SQLContext) extends SparkPlan with LeafNode with Command with Product with Serializable

An explain command for users to see how a command will be executed.

Note that this command takes in a logical plan, runs the optimizer on the logical plan (but do NOT actually execute it).

:: DeveloperApi ::

Annotations
@DeveloperApi()
Linear Supertypes
Product, Equals, Command, LeafNode, catalyst.trees.LeafNode[SparkPlan], SparkPlan, Serializable, Serializable, Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExplainCommand
  2. Product
  3. Equals
  4. Command
  5. LeafNode
  6. LeafNode
  7. SparkPlan
  8. Serializable
  9. Serializable
  10. Logging
  11. QueryPlan
  12. TreeNode
  13. AnyRef
  14. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute], extended: Boolean)(context: SQLContext)

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. def apply(number: Int): SparkPlan

    Definition Classes
    TreeNode

  7. def argString: String

    Definition Classes
    TreeNode

  8. def asCode: String

    Definition Classes
    TreeNode

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. def children: Nil.type

    Definition Classes
    LeafNode

  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  12. val codegenEnabled: Boolean

    Definition Classes
    SparkPlan

  13. def collect[B](pf: PartialFunction[SparkPlan, B]): Seq[B]

    Definition Classes
    TreeNode

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def execute(): RDD[catalyst.expressions.Row]

    Definition Classes
    Command

  16. def executeCollect(): Array[catalyst.expressions.Row]

    Definition Classes
    Command

  17. def expressions: Seq[Expression]

    Definition Classes
    QueryPlan

  18. val extended: Boolean

  19. def fastEquals(other: TreeNode[_]): Boolean

    Definition Classes
    TreeNode

  20. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  21. def flatMap[A](f: (SparkPlan) ⇒ TraversableOnce[A]): Seq[A]

    Definition Classes
    TreeNode

  22. def foreach(f: (SparkPlan) ⇒ Unit): Unit

    Definition Classes
    TreeNode

  23. def generateTreeString(depth: Int, builder: StringBuilder): StringBuilder

    Attributes
    protected
    Definition Classes
    TreeNode

  24. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  25. def getNodeNumbered(number: MutableInt): SparkPlan

    Attributes
    protected
    Definition Classes
    TreeNode

  26. def inputSet: AttributeSet

    Definition Classes
    QueryPlan

  27. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  28. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  29. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  31. def logDebug(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  33. def logError(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  35. def logInfo(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  36. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  38. def logTrace(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  40. def logWarning(msg: ⇒ String): Unit

    Attributes
    protected
    Definition Classes
    Logging

  41. val logicalPlan: LogicalPlan

  42. def makeCopy(newArgs: Array[AnyRef]): ExplainCommand.this.type

    Overridden make copy also propogates sqlContext to copied plan.

    Overridden make copy also propogates sqlContext to copied plan.

    Definition Classes
    SparkPlan → TreeNode

  43. def map[A](f: (SparkPlan) ⇒ A): Seq[A]

    Definition Classes
    TreeNode

  44. def mapChildren(f: (SparkPlan) ⇒ SparkPlan): ExplainCommand.this.type

    Definition Classes
    TreeNode

  45. def missingInput: AttributeSet

    Definition Classes
    QueryPlan

  46. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  47. def newMutableProjection(expressions: Seq[Expression], inputSchema: Seq[Attribute]): () ⇒ MutableProjection

    Attributes
    protected
    Definition Classes
    SparkPlan

  48. def newOrdering(order: Seq[SortOrder], inputSchema: Seq[Attribute]): Ordering[catalyst.expressions.Row]

    Attributes
    protected
    Definition Classes
    SparkPlan

  49. def newPredicate(expression: Expression, inputSchema: Seq[Attribute]): (catalyst.expressions.Row) ⇒ Boolean

    Attributes
    protected
    Definition Classes
    SparkPlan

  50. def newProjection(expressions: Seq[Expression], inputSchema: Seq[Attribute]): Projection

    Attributes
    protected
    Definition Classes
    SparkPlan

  51. def nodeName: String

    Definition Classes
    TreeNode

  52. final def notify(): Unit

    Definition Classes
    AnyRef

  53. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  54. def numberedTreeString: String

    Definition Classes
    TreeNode

  55. def otherCopyArgs: List[SQLContext]

    Definition Classes
    ExplainCommand → TreeNode

  56. val output: Seq[Attribute]

    Definition Classes
    ExplainCommand → QueryPlan

  57. def outputPartitioning: Partitioning

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

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

    Definition Classes
    SparkPlan

  58. def outputSet: AttributeSet

    Definition Classes
    QueryPlan

  59. def printSchema(): Unit

    Definition Classes
    QueryPlan

  60. def references: AttributeSet

    Definition Classes
    QueryPlan

  61. def requiredChildDistribution: Seq[Distribution]

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

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

    Definition Classes
    SparkPlan

  62. def schema: catalyst.types.StructType

    Definition Classes
    QueryPlan

  63. def schemaString: String

    Definition Classes
    QueryPlan

  64. lazy val sideEffectResult: Seq[catalyst.expressions.Row]

    Attributes
    protected
    Definition Classes
    ExplainCommand → Command

  65. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode

  66. def sparkContext: SparkContext

    Attributes
    protected
    Definition Classes
    SparkPlan

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

    Attributes
    protected[org.apache.spark]
    Definition Classes
    SparkPlan

  68. def statePrefix: String

    Attributes
    protected
    Definition Classes
    QueryPlan

  69. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  71. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

  72. def transform(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

  73. def transformAllExpressions(rule: PartialFunction[Expression, Expression]): ExplainCommand.this.type

    Definition Classes
    QueryPlan

  74. def transformChildrenDown(rule: PartialFunction[SparkPlan, SparkPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

  75. def transformChildrenUp(rule: PartialFunction[SparkPlan, SparkPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

  76. def transformDown(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

  80. def transformUp(rule: PartialFunction[SparkPlan, SparkPlan]): SparkPlan

    Definition Classes
    TreeNode

  81. def treeString: String

    Definition Classes
    TreeNode

  82. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  83. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  84. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  85. def withNewChildren(newChildren: Seq[SparkPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from LeafNode

Inherited from catalyst.trees.LeafNode[SparkPlan]

Inherited from SparkPlan

Inherited from Serializable

Inherited from Serializable

Inherited from Logging

Inherited from QueryPlan[SparkPlan]

Inherited from TreeNode[SparkPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped