org.apache.spark.sql.execution

ExplainCommand

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, Product, Equals, RunnableCommand, Command, LogicalPlan, Logging, QueryPlan[LogicalPlan], TreeNode[LogicalPlan], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ExplainCommand
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. RunnableCommand
  7. Command
  8. LogicalPlan
  9. Logging
  10. QueryPlan
  11. TreeNode
  12. AnyRef
  13. 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 = false)

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): LogicalPlan

    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: Seq[LogicalPlan]

    Definition Classes
    RunnableCommand → TreeNode

  11. def childrenResolved: Boolean

    Definition Classes
    LogicalPlan

  12. lazy val cleanArgs: Seq[Any]

    Attributes
    protected
    Definition Classes
    LogicalPlan

  13. def clone(): AnyRef

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  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 find(f: (LogicalPlan) ⇒ Boolean): Option[LogicalPlan]

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef → Any

  27. def getNodeNumbered(number: MutableInt): LogicalPlan

    Attributes
    protected
    Definition Classes
    TreeNode

  28. def inputSet: AttributeSet

    Definition Classes
    QueryPlan

  29. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  30. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  31. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  38. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  43. val logicalPlan: LogicalPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

  46. def mapChildren(f: (LogicalPlan) ⇒ LogicalPlan): ExplainCommand.this.type

    Definition Classes
    TreeNode

  47. def missingInput: AttributeSet

    Definition Classes
    QueryPlan

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

    Definition Classes
    AnyRef

  49. def nodeName: String

    Definition Classes
    TreeNode

  50. final def notify(): Unit

    Definition Classes
    AnyRef

  51. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  52. def numberedTreeString: String

    Definition Classes
    TreeNode

  53. val origin: Origin

    Definition Classes
    TreeNode

  54. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode

  55. val output: Seq[Attribute]

    Definition Classes
    ExplainCommand → RunnableCommand → QueryPlan

  56. def outputSet: AttributeSet

    Definition Classes
    QueryPlan

  57. def printSchema(): Unit

    Definition Classes
    QueryPlan

  58. def references: AttributeSet

    Definition Classes
    QueryPlan

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

    Attributes
    protected
    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

  62. def resolveQuoted(name: String, resolver: (String, String) ⇒ Boolean): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  63. lazy val resolved: Boolean

    Definition Classes
    LogicalPlan

  64. def run(sqlContext: SQLContext): Seq[catalyst.expressions.Row]

    Definition Classes
    ExplainCommand → RunnableCommand

  65. def sameResult(plan: LogicalPlan): Boolean

    Definition Classes
    LogicalPlan

  66. lazy val schema: StructType

    Definition Classes
    QueryPlan

  67. def schemaString: String

    Definition Classes
    QueryPlan

  68. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode

  69. def statePrefix: String

    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  70. def statistics: Statistics

    Definition Classes
    LogicalPlan

  71. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  73. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

  76. def transformChildrenDown(rule: PartialFunction[LogicalPlan, LogicalPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

  77. def transformChildrenUp(rule: PartialFunction[LogicalPlan, LogicalPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  83. def treeString: String

    Definition Classes
    TreeNode

  84. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  87. def withNewChildren(newChildren: Seq[LogicalPlan]): ExplainCommand.this.type

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from RunnableCommand

Inherited from Command

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped