org.apache.spark.sql.execution

ExplainCommand

case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute])(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
Serializable, Serializable, Product, Equals, Command, LeafNode, catalyst.trees.LeafNode[SparkPlan], SparkPlan, com.typesafe.scalalogging.slf4j.Logging, QueryPlan[SparkPlan], TreeNode[SparkPlan], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExplainCommand
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Command
  7. LeafNode
  8. LeafNode
  9. SparkPlan
  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])(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 buildRow(values: Seq[Any]): Row

    Attributes
    protected
    Definition Classes
    SparkPlan

  11. def children: Nil.type

    Definition Classes
    LeafNode

  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. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def execute(): RDD[Row]

    Runs this query returning the result as an RDD.

    Runs this query returning the result as an RDD.

    Definition Classes
    ExplainCommand → SparkPlan

  16. def executeCollect(): Array[Row]

    Runs this query returning the result as an array.

    Runs this query returning the result as an array.

    Definition Classes
    SparkPlan

  17. def expressions: Seq[Expression]

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  19. def finalize(): Unit

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

  22. def generateSchemaString(schema: StructType, prefix: String, builder: StringBuilder): StringBuilder

    Attributes
    protected
    Definition Classes
    QueryPlan

  23. def generateSchemaString(schema: Seq[Attribute]): String

    Attributes
    protected
    Definition Classes
    QueryPlan

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

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef → Any

  26. def getNodeNumbered(number: MutableInt): SparkPlan

    Attributes
    protected
    Definition Classes
    TreeNode

  27. val id: Long

    Definition Classes
    TreeNode

  28. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  29. lazy val logger: Logger

    Attributes
    protected
    Definition Classes
    Logging

  30. val logicalPlan: LogicalPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  35. def nodeName: String

    Definition Classes
    TreeNode

  36. final def notify(): Unit

    Definition Classes
    AnyRef

  37. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  38. def numberedTreeString: String

    Definition Classes
    TreeNode

  39. def otherCopyArgs: List[SQLContext]

    Definition Classes
    ExplainCommand → TreeNode

  40. val output: Seq[Attribute]

    Definition Classes
    ExplainCommand → QueryPlan

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

  42. def outputSet: Set[Attribute]

    Definition Classes
    QueryPlan

  43. def printSchema(): Unit

    Definition Classes
    QueryPlan

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

  45. def sameInstance(other: TreeNode[_]): Boolean

    Definition Classes
    TreeNode

  46. def schemaString: String

    Definition Classes
    QueryPlan

  47. lazy val sideEffectResult: Seq[String]

    Attributes
    protected[org.apache.spark.sql]
    Definition Classes
    ExplainCommand → Command

  48. def simpleString: String

    Definition Classes
    TreeNode

  49. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  51. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  61. def treeString: String

    Definition Classes
    TreeNode

  62. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from LeafNode

Inherited from catalyst.trees.LeafNode[SparkPlan]

Inherited from SparkPlan

Inherited from com.typesafe.scalalogging.slf4j.Logging

Inherited from QueryPlan[SparkPlan]

Inherited from TreeNode[SparkPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped