org.apache.spark.sql.execution

ExplainCommand

case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute] = ..., extended: Boolean = false) extends Command 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, catalyst.plans.logical.LeafNode, catalyst.trees.LeafNode[LogicalPlan], 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. LeafNode
  9. LeafNode
  10. LogicalPlan
  11. Logging
  12. QueryPlan
  13. TreeNode
  14. AnyRef
  15. 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: Any): Boolean

    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Definition Classes
    AnyRef → Any

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

    Definition Classes
    AnyRef → Any

  4. def apply(number: Int): LogicalPlan

    Definition Classes
    TreeNode

  5. def argString: String

    Definition Classes
    TreeNode

  6. def asCode: String

    Definition Classes
    TreeNode

  7. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  8. def children: Nil.type

    Definition Classes
    LeafNode

  9. def childrenResolved: Boolean

    Definition Classes
    LogicalPlan

  10. lazy val cleanArgs: Seq[Any]

    Attributes
    protected
    Definition Classes
    LogicalPlan

  11. def clone(): AnyRef

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  14. def expressions: Seq[Expression]

    Definition Classes
    QueryPlan

  15. val extended: Boolean

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

    Definition Classes
    TreeNode

  17. def finalize(): Unit

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef → Any

  23. def getNodeNumbered(number: MutableInt): LogicalPlan

    Attributes
    protected
    Definition Classes
    TreeNode

  24. def inputSet: AttributeSet

    Definition Classes
    QueryPlan

  25. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  26. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  27. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  34. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  39. val logicalPlan: LogicalPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

  43. def missingInput: AttributeSet

    Definition Classes
    QueryPlan

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

    Definition Classes
    AnyRef

  45. def nodeName: String

    Definition Classes
    TreeNode

  46. final def notify(): Unit

    Definition Classes
    AnyRef

  47. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  48. def numberedTreeString: String

    Definition Classes
    TreeNode

  49. val origin: Origin

    Definition Classes
    TreeNode

  50. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode

  51. val output: Seq[Attribute]

    Definition Classes
    ExplainCommand → Command → QueryPlan

  52. def outputSet: AttributeSet

    Definition Classes
    QueryPlan

  53. def printSchema(): Unit

    Definition Classes
    QueryPlan

  54. def references: AttributeSet

    Definition Classes
    QueryPlan

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

    Attributes
    protected
    Definition Classes
    LogicalPlan

  56. def resolve(name: String, resolver: Resolver): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  57. def resolveChildren(name: String, resolver: Resolver): Option[NamedExpression]

    Definition Classes
    LogicalPlan

  58. lazy val resolved: Boolean

    Definition Classes
    LogicalPlan

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

    Definition Classes
    ExplainCommand → RunnableCommand

  60. def sameResult(plan: LogicalPlan): Boolean

    Definition Classes
    LogicalPlan

  61. def schema: StructType

    Definition Classes
    QueryPlan

  62. def schemaString: String

    Definition Classes
    QueryPlan

  63. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode

  64. def statePrefix: String

    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  65. def statistics: Statistics

    Definition Classes
    LogicalPlan

  66. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef

  68. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  78. def treeString: String

    Definition Classes
    TreeNode

  79. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  82. 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 catalyst.plans.logical.LeafNode

Inherited from catalyst.trees.LeafNode[LogicalPlan]

Inherited from LogicalPlan

Inherited from Logging

Inherited from QueryPlan[LogicalPlan]

Inherited from TreeNode[LogicalPlan]

Inherited from AnyRef

Inherited from Any

Ungrouped