Packages

class QueryExecution extends Logging

The primary workflow for executing relational queries using Spark. Designed to allow easy access to the intermediate phases of query execution for developers.

While this is not a public class, we should avoid changing the function names for the sake of changing them, because a lot of developers use the feature for debugging.

Linear Supertypes
Logging, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryExecution
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new QueryExecution(sparkSession: classic.SparkSession, logical: LogicalPlan, tracker: QueryPlanningTracker = new QueryPlanningTracker, mode: CommandExecutionMode.Value = CommandExecutionMode.ALL, shuffleCleanupMode: ShuffleCleanupMode = DoNotCleanup)

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

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 MDC(key: LogKey, value: Any): MDC
    Attributes
    protected
    Definition Classes
    Logging
  5. def analyzed: LogicalPlan
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def assertAnalyzed(): Unit
  8. def assertCommandExecuted(): Unit
  9. def assertExecutedPlanPrepared(): Unit
  10. def assertOptimized(): Unit
  11. def assertSparkPlanPrepared(): Unit
  12. def assertSupported(): Unit
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  14. def commandExecuted: LogicalPlan
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. def executePhase[T](phase: String)(block: => T): T
    Attributes
    protected
  18. def executedPlan: SparkPlan
  19. def explainString(mode: ExplainMode): String
  20. def extendedExplainInfo(append: (String) => Unit, plan: SparkPlan): Unit
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. val id: Long
  24. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  25. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. lazy val isLazyAnalysis: Boolean
  28. def isSqlScript: Boolean

    Check whether the query represented by this QueryExecution is a SQL script.

    Check whether the query represented by this QueryExecution is a SQL script.

    returns

    True if the query is a SQL script, False otherwise.

  29. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  30. val lazyToRdd: LazyTry[SQLExecutionRDD]
  31. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  32. def logBasedOnLevel(level: Level)(f: => MessageWithContext): Unit
    Attributes
    protected
    Definition Classes
    Logging
  33. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  34. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  35. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  36. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  37. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  38. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  39. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  40. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  41. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logName: String
    Attributes
    protected
    Definition Classes
    Logging
  46. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. val logical: LogicalPlan
  55. val mode: CommandExecutionMode.Value
  56. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  57. def normalized: LogicalPlan
  58. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  59. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  60. def observedMetrics: Map[String, Row]

    Get the metrics observed during the execution of the query plan.

    Get the metrics observed during the execution of the query plan.

    Annotations
    @GuardedBy()
  61. def optimizedPlan: LogicalPlan
  62. def planner: SparkPlanner
    Attributes
    protected
  63. def preparations: Seq[Rule[SparkPlan]]
    Attributes
    protected
  64. val shuffleCleanupMode: ShuffleCleanupMode
  65. def simpleString: String
  66. def sparkPlan: SparkPlan
  67. val sparkSession: classic.SparkSession
  68. def stringWithStats: String
  69. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  70. def toRdd: RDD[InternalRow]

    Internal version of the RDD.

    Internal version of the RDD. Avoids copies and has no schema. Note for callers: Spark may apply various optimization including reusing object: this means the row is valid only for the iteration it is retrieved. You should avoid storing row and accessing after iteration. (Calling collect() is one of known bad usage.) If you want to store these rows into collection, please apply some converter or copy row which produces new object per iteration. Given QueryExecution is not a public class, end users are discouraged to use this: please use Dataset.rdd instead where conversion will be applied.

  71. def toString(): String
    Definition Classes
    QueryExecution → AnyRef → Any
  72. val tracker: QueryPlanningTracker
  73. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  74. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  75. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  76. def withCachedData: LogicalPlan
  77. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging
  78. object debug

    A special namespace for commands that can be used to debug query execution.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped