Class

org.apache.spark.sql.execution.command

ExplainCommand

Related Doc: package command

Permalink

case class ExplainCommand(logicalPlan: LogicalPlan, output: Seq[Attribute] = ..., extended: Boolean = false, codegen: 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).

EXPLAIN (EXTENDED | CODEGEN) SELECT * FROM ...
logicalPlan

plan to explain

output

output schema

extended

whether to do extended explain or not

codegen

whether to output generated code from whole-stage codegen or not

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, codegen: Boolean = false)

    Permalink

    logicalPlan

    plan to explain

    output

    output schema

    extended

    whether to do extended explain or not

    codegen

    whether to output generated code from whole-stage codegen or not

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. lazy val allAttributes: AttributeSeq

    Permalink
    Definition Classes
    QueryPlan

  5. def analyzed: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  6. def apply(number: Int): LogicalPlan

    Permalink
    Definition Classes
    TreeNode

  7. def argString: String

    Permalink
    Definition Classes
    TreeNode

  8. def asCode: String

    Permalink
    Definition Classes
    TreeNode

  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  10. lazy val canonicalized: LogicalPlan

    Permalink
    Definition Classes
    LogicalPlan → QueryPlan

  11. final def children: Seq[LogicalPlan]

    Permalink
    Definition Classes
    RunnableCommand → TreeNode

  12. def childrenResolved: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  13. lazy val cleanArgs: Seq[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan

  14. def clone(): AnyRef

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

  15. val codegen: Boolean

    Permalink

    whether to output generated code from whole-stage codegen or not

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

  18. lazy val constraints: ExpressionSet

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef

  21. final def expressions: Seq[Expression]

    Permalink
    Definition Classes
    QueryPlan

  22. val extended: Boolean

    Permalink

    whether to do extended explain or not

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

    Permalink
    Definition Classes
    TreeNode

  24. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

  29. def generateTreeString(depth: Int, lastChildren: Seq[Boolean], builder: StringBuilder, verbose: Boolean, prefix: String): StringBuilder

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef → Any

  31. def getNodeNumbered(number: MutableInt): LogicalPlan

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  32. def getRelevantConstraints(constraints: Set[Expression]): Set[Expression]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan

  33. def hashCode(): Int

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any

  34. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  35. def innerChildren: Seq[QueryPlan[_]]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode

  36. def inputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  38. def isStreaming: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  39. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  40. def jsonFields: List[JField]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  41. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  48. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  53. val logicalPlan: LogicalPlan

    Permalink

    plan to explain

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

  57. def mapProductIterator[B](f: (Any) ⇒ B)(implicit arg0: ClassTag[B]): Array[B]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  58. def maxRows: Option[Long]

    Permalink
    Definition Classes
    LogicalPlan

  59. def missingInput: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    AnyRef

  61. def nodeName: String

    Permalink
    Definition Classes
    TreeNode

  62. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  63. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  64. def numberedTreeString: String

    Permalink
    Definition Classes
    TreeNode

  65. val origin: Origin

    Permalink
    Definition Classes
    TreeNode

  66. def otherCopyArgs: Seq[AnyRef]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  67. val output: Seq[Attribute]

    Permalink

    output schema

    output schema

    Definition Classes
    ExplainCommand → RunnableCommand → QueryPlan

  68. def outputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  69. def prettyJson: String

    Permalink
    Definition Classes
    TreeNode

  70. def printSchema(): Unit

    Permalink
    Definition Classes
    QueryPlan

  71. def producedAttributes: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  72. def references: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  73. def refresh(): Unit

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

  76. def resolve(schema: StructType, resolver: Resolver): Seq[Attribute]

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

  81. lazy val resolved: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  82. def run(sparkSession: SparkSession): Seq[Row]

    Permalink
    Definition Classes
    ExplainCommand → RunnableCommand

  83. def sameResult(plan: LogicalPlan): Boolean

    Permalink
    Definition Classes
    QueryPlan

  84. lazy val schema: StructType

    Permalink
    Definition Classes
    QueryPlan

  85. def schemaString: String

    Permalink
    Definition Classes
    QueryPlan

  86. def simpleString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode

  87. def statePrefix: String

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  88. def statistics: Statistics

    Permalink
    Definition Classes
    LogicalPlan

  89. def stringArgs: Iterator[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  90. def subqueries: Seq[LogicalPlan]

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    AnyRef

  92. def toJSON: String

    Permalink
    Definition Classes
    TreeNode

  93. def toString(): String

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    TreeNode

  102. def treeString(verbose: Boolean): String

    Permalink
    Definition Classes
    TreeNode

  103. def treeString: String

    Permalink
    Definition Classes
    TreeNode

  104. def validConstraints: Set[Expression]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan

  105. def verboseString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode

  106. final def wait(): Unit

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

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

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

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

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

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