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

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, 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
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
    Command → LeafNode → 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. def collectLeaves(): Seq[LogicalPlan]

    Permalink
    Definition Classes
    TreeNode

  19. lazy val constraints: ExpressionSet

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef

  22. final def expressions: Seq[Expression]

    Permalink
    Definition Classes
    QueryPlan

  23. val extended: Boolean

    Permalink

    whether to do extended explain or not

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

    Permalink
    Definition Classes
    TreeNode

  25. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    AnyRef → Any

  32. def getNodeNumbered(number: MutableInt): LogicalPlan

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

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

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan

  34. def hashCode(): Int

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any

  35. def initializeLogIfNecessary(isInterpreter: Boolean): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan → TreeNode

  37. def inputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  38. final def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  39. final def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  40. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  41. def isStreaming: Boolean

    Permalink
    Definition Classes
    LogicalPlan

  42. final def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  43. def jsonFields: List[JField]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  44. def log: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  51. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

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

    Permalink
    Attributes
    protected
    Definition Classes
    Logging

  56. val logicalPlan: LogicalPlan

    Permalink

    plan to explain

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  61. def maxRows: Option[Long]

    Permalink
    Definition Classes
    LogicalPlan

  62. def missingInput: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    AnyRef

  64. def nodeName: String

    Permalink
    Definition Classes
    TreeNode

  65. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  66. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  67. def numberedTreeString: String

    Permalink
    Definition Classes
    TreeNode

  68. val origin: Origin

    Permalink
    Definition Classes
    TreeNode

  69. def otherCopyArgs: Seq[AnyRef]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  70. val output: Seq[Attribute]

    Permalink

    output schema

    output schema

    Definition Classes
    ExplainCommand → Command → QueryPlan

  71. def outputSet: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  72. def prettyJson: String

    Permalink
    Definition Classes
    TreeNode

  73. def printSchema(): Unit

    Permalink
    Definition Classes
    QueryPlan

  74. def producedAttributes: AttributeSet

    Permalink
    Definition Classes
    LeafNode → QueryPlan

  75. def references: AttributeSet

    Permalink
    Definition Classes
    QueryPlan

  76. def refresh(): Unit

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    LogicalPlan

  84. lazy val resolved: Boolean

    Permalink
    Definition Classes
    LogicalPlan

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

    Permalink
    Definition Classes
    ExplainCommand → RunnableCommand

  86. def sameResult(plan: LogicalPlan): Boolean

    Permalink
    Definition Classes
    QueryPlan

  87. lazy val schema: StructType

    Permalink
    Definition Classes
    QueryPlan

  88. def schemaString: String

    Permalink
    Definition Classes
    QueryPlan

  89. def simpleString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode

  90. def statePrefix: String

    Permalink
    Attributes
    protected
    Definition Classes
    LogicalPlan → QueryPlan

  91. def statistics: Statistics

    Permalink
    Definition Classes
    LogicalPlan

  92. def stringArgs: Iterator[Any]

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

  93. def subqueries: Seq[LogicalPlan]

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    AnyRef

  95. def toJSON: String

    Permalink
    Definition Classes
    TreeNode

  96. def toString(): String

    Permalink
    Definition Classes
    TreeNode → AnyRef → Any

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Attributes
    protected
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    TreeNode

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    QueryPlan

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

    Permalink
    Definition Classes
    TreeNode

  105. def treeString(verbose: Boolean): String

    Permalink
    Definition Classes
    TreeNode

  106. def treeString: String

    Permalink
    Definition Classes
    TreeNode

  107. def validConstraints: Set[Expression]

    Permalink
    Attributes
    protected
    Definition Classes
    QueryPlan

  108. def verboseString: String

    Permalink
    Definition Classes
    QueryPlan → TreeNode

  109. final def wait(): Unit

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

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

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

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

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

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

    Permalink
    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