Class

org.apache.spark.sql.execution

ExplainCommand

Related Doc: package execution

Permalink

case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute] = ..., extended: Boolean = false) extends LogicalPlan with RunnableCommand 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, RunnableCommand, Command, LogicalPlan, Logging, QueryPlan[LogicalPlan], TreeNode[LogicalPlan], Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExplainCommand
  2. Serializable
  3. Serializable
  4. RunnableCommand
  5. Command
  6. LogicalPlan
  7. Logging
  8. QueryPlan
  9. TreeNode
  10. Product
  11. Equals
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. def analyzed: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  5. def apply(number: Int): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

  6. def argString: String

    Permalink
    Definition Classes
    TreeNode

  7. def asCode: String

    Permalink
    Definition Classes
    TreeNode

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def children: Seq[LogicalPlan]

    Permalink
    Definition Classes
    RunnableCommand → TreeNode

  10. def childrenResolved: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  11. lazy val cleanArgs: Seq[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan

  12. def clone(): AnyRef

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

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

    Permalink
    Definition Classes
    TreeNode

  14. def collectFirst[B](pf: PartialFunction[LogicalPlan, B]): Option[B]

    Permalink
    Definition Classes
    TreeNode

  15. lazy val containsChild: Set[TreeNode[_]]

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef

  17. def expressions: Seq[Expression]

    Permalink
    Definition Classes
    QueryPlan

  18. val extended: Boolean

    Permalink

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

    Permalink
    Definition Classes
    TreeNode

  20. def finalize(): Unit

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

  21. def find(f: (LogicalPlan) ⇒ Boolean): Option[LogicalPlan]

    Permalink
    Definition Classes
    TreeNode

  22. def flatMap[A](f: (LogicalPlan) ⇒ TraversableOnce[A]): Seq[A]

    Permalink
    Definition Classes
    TreeNode

  23. def foreach(f: (LogicalPlan) ⇒ Unit): Unit

    Permalink
    Definition Classes
    TreeNode

  24. def foreachUp(f: (LogicalPlan) ⇒ Unit): Unit

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef → Any

  27. def getNodeNumbered(number: MutableInt): LogicalPlan

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  28. def inputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  30. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  31. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  38. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  43. val logicalPlan: LogicalPlan

    Permalink

  44. def makeCopy(newArgs: Array[AnyRef]): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

  45. def map[A](f: (LogicalPlan) ⇒ A): Seq[A]

    Permalink
    Definition Classes
    TreeNode

  46. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

  47. def missingInput: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    AnyRef

  49. def nodeName: String

    Permalink
    Definition Classes
    TreeNode

  50. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  51. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  52. def numberedTreeString: String

    Permalink
    Definition Classes
    TreeNode

  53. val origin: Origin

    Permalink
    Definition Classes
    TreeNode

  54. def otherCopyArgs: Seq[AnyRef]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  55. val output: Seq[Attribute]

    Permalink
    Definition Classes
    ExplainCommand → RunnableCommand → QueryPlan

  56. def outputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  57. def printSchema(): Unit

    Permalink
    Definition Classes
    QueryPlan

  58. def references: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  59. def resolve(nameParts: Seq[String], input: Seq[Attribute], resolver: Resolver): Option[NamedExpression]

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan

  60. def resolve(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

    Permalink
    Definition Classes
    LogicalPlan

  61. def resolveChildren(nameParts: Seq[String], resolver: Resolver): Option[NamedExpression]

    Permalink
    Definition Classes
    LogicalPlan

  62. def resolveExpressions(r: PartialFunction[Expression, Expression]): LogicalPlan

    Permalink
    Definition Classes
    LogicalPlan

  63. def resolveOperators(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink
    Definition Classes
    LogicalPlan

  64. def resolveQuoted(name: String, resolver: Resolver): Option[NamedExpression]

    Permalink
    Definition Classes
    LogicalPlan

  65. lazy val resolved: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  66. def run(sqlContext: SQLContext): Seq[Row]

    Permalink
    Definition Classes
    ExplainCommand → RunnableCommand

  67. def sameResult(plan: LogicalPlan): Boolean

    Permalink
    Definition Classes
    LogicalPlan

  68. lazy val schema: StructType

    Permalink
    Definition Classes
    QueryPlan

  69. def schemaString: String

    Permalink
    Definition Classes
    QueryPlan

  70. def simpleString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode

  71. def statePrefix: String

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  72. def statistics: Statistics

    Permalink
    Definition Classes
    LogicalPlan

  73. def stringArgs: Iterator[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef

  75. def toString(): String

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any

  76. def transform(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

  78. def transformChildren(rule: PartialFunction[LogicalPlan, LogicalPlan], nextOperation: (LogicalPlan, PartialFunction[LogicalPlan, LogicalPlan]) ⇒ LogicalPlan): LogicalPlan

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  79. def transformDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

  83. def transformUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

  84. def treeString: String

    Permalink
    Definition Classes
    TreeNode

  85. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  88. def withNewChildren(newChildren: Seq[LogicalPlan]): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from RunnableCommand

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped