org.apache.spark.sql.execution.command

ExplainCommand

case class ExplainCommand(logicalPlan: LogicalPlan, extended: Boolean = false, codegen: Boolean = false, cost: Boolean = false) extends LeafNode 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

extended

whether to do extended explain or not

codegen

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

cost

whether to show cost information for operators.

Linear Supertypes
Serializable, Serializable, RunnableCommand, Command, LeafNode, 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. LeafNode
  7. LogicalPlan
  8. Logging
  9. QueryPlan
  10. TreeNode
  11. Product
  12. Equals
  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, extended: Boolean = false, codegen: Boolean = false, cost: Boolean = false)

    logicalPlan

    plan to explain

    extended

    whether to do extended explain or not

    codegen

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

    cost

    whether to show cost information for operators.

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

    Definition Classes
    QueryPlan

  7. def analyzed: Boolean

    Definition Classes
    LogicalPlan

  8. def apply(number: Int): TreeNode[_]

    Definition Classes
    TreeNode

  9. def argString: String

    Definition Classes
    TreeNode

  10. def asCode: String

    Definition Classes
    TreeNode

  11. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  12. lazy val canonicalized: LogicalPlan

    Definition Classes
    QueryPlan

  13. final def children: Seq[LogicalPlan]

    Definition Classes
    LeafNode → TreeNode

  14. def childrenResolved: Boolean

    Definition Classes
    LogicalPlan

  15. def clone(): AnyRef

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

  16. val codegen: Boolean

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

  19. def collectLeaves(): Seq[LogicalPlan]

    Definition Classes
    TreeNode

  20. def computeStats(conf: SQLConf): Statistics

    Attributes
    protected
    Definition Classes
    LogicalPlan

  21. lazy val constraints: ExpressionSet

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  23. val cost: Boolean

    whether to show cost information for operators.

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

    Definition Classes
    AnyRef

  25. final def expressions: Seq[Expression]

    Definition Classes
    QueryPlan

  26. val extended: Boolean

    whether to do extended explain or not

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

    Definition Classes
    TreeNode

  28. def finalize(): Unit

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

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    AnyRef → Any

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

    Attributes
    protected
    Definition Classes
    QueryPlan

  36. def hashCode(): Int

    Definition Classes
    TreeNode → AnyRef → Any

  37. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode

  39. def inputSet: AttributeSet

    Definition Classes
    QueryPlan

  40. final def invalidateStatsCache(): Unit

    Definition Classes
    LogicalPlan

  41. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  42. def isStreaming: Boolean

    Definition Classes
    LogicalPlan

  43. def isTraceEnabled(): Boolean

    Attributes
    protected
    Definition Classes
    Logging

  44. def jsonFields: List[(String, JValue)]

    Attributes
    protected
    Definition Classes
    TreeNode

  45. def log: Logger

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  52. def logName: String

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

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

    Attributes
    protected
    Definition Classes
    Logging

  57. val logicalPlan: LogicalPlan

    plan to explain

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

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

    Definition Classes
    TreeNode

  61. def mapExpressions(f: (Expression) ⇒ Expression): ExplainCommand.this.type

    Definition Classes
    QueryPlan

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

    Attributes
    protected
    Definition Classes
    TreeNode

  63. def maxRows: Option[Long]

    Definition Classes
    LogicalPlan

  64. def missingInput: AttributeSet

    Definition Classes
    QueryPlan

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

    Definition Classes
    AnyRef

  66. def nodeName: String

    Definition Classes
    TreeNode

  67. final def notify(): Unit

    Definition Classes
    AnyRef

  68. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  69. def numberedTreeString: String

    Definition Classes
    TreeNode

  70. val origin: Origin

    Definition Classes
    TreeNode

  71. def otherCopyArgs: Seq[AnyRef]

    Attributes
    protected
    Definition Classes
    TreeNode

  72. val output: Seq[Attribute]

    Definition Classes
    ExplainCommand → Command → QueryPlan

  73. def outputSet: AttributeSet

    Definition Classes
    QueryPlan

  74. def p(number: Int): LogicalPlan

    Definition Classes
    TreeNode

  75. def preCanonicalized: LogicalPlan

    Attributes
    protected
    Definition Classes
    QueryPlan

  76. def prettyJson: String

    Definition Classes
    TreeNode

  77. def printSchema(): Unit

    Definition Classes
    QueryPlan

  78. def producedAttributes: AttributeSet

    Definition Classes
    LeafNode → QueryPlan

  79. def references: AttributeSet

    Definition Classes
    QueryPlan

  80. def refresh(): Unit

    Definition Classes
    LogicalPlan

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

    Attributes
    protected
    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

  83. def resolve(schema: StructType, resolver: (String, String) ⇒ Boolean): Seq[Attribute]

    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

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

    Definition Classes
    LogicalPlan

  88. lazy val resolved: Boolean

    Definition Classes
    LogicalPlan

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

    Definition Classes
    ExplainCommand → RunnableCommand

  90. final def sameResult(other: LogicalPlan): Boolean

    Definition Classes
    QueryPlan

  91. lazy val schema: StructType

    Definition Classes
    QueryPlan

  92. def schemaString: String

    Definition Classes
    QueryPlan

  93. final def semanticHash(): Int

    Definition Classes
    QueryPlan

  94. def simpleString: String

    Definition Classes
    QueryPlan → TreeNode

  95. def statePrefix: String

    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  96. final def stats(conf: SQLConf): Statistics

    Definition Classes
    LogicalPlan

  97. def stringArgs: Iterator[Any]

    Attributes
    protected
    Definition Classes
    TreeNode

  98. def subqueries: Seq[LogicalPlan]

    Definition Classes
    QueryPlan

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

    Definition Classes
    AnyRef

  100. def toJSON: String

    Definition Classes
    TreeNode

  101. def toString(): String

    Definition Classes
    TreeNode → AnyRef → Any

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    QueryPlan

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

    Definition Classes
    TreeNode

  109. def treeString(verbose: Boolean, addSuffix: Boolean): String

    Definition Classes
    TreeNode

  110. def treeString: String

    Definition Classes
    TreeNode

  111. def validConstraints: Set[Expression]

    Attributes
    protected
    Definition Classes
    QueryPlan

  112. def verboseString: String

    Definition Classes
    QueryPlan → TreeNode

  113. def verboseStringWithSuffix: String

    Definition Classes
    LogicalPlan → TreeNode

  114. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    TreeNode

Inherited from Serializable

Inherited from Serializable

Inherited from RunnableCommand

Inherited from Command

Inherited from LeafNode

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