Trait

org.apache.spark.sql.util

QueryExecutionListener

Related Doc: package util

Permalink

trait QueryExecutionListener extends AnyRef

:: Experimental :: The interface of query execution listener that can be used to analyze execution metrics.

Annotations
@Experimental() @Evolving()
Source
QueryExecutionListener.scala
Note

Implementations should guarantee thread-safety as they can be invoked by multiple different threads.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. QueryExecutionListener
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def onFailure(funcName: String, qe: QueryExecution, exception: Exception): Unit

    Permalink

    A callback function that will be called when a query execution failed.

    A callback function that will be called when a query execution failed.

    funcName

    the name of the action that triggered this query.

    qe

    the QueryExecution object that carries detail information like logical plan, physical plan, etc.

    exception

    the exception that failed this query.

    Annotations
    @DeveloperApi()
    Note

    This can be invoked by multiple different threads.

  2. abstract def onSuccess(funcName: String, qe: QueryExecution, durationNs: Long): Unit

    Permalink

    A callback function that will be called when a query executed successfully.

    A callback function that will be called when a query executed successfully.

    funcName

    name of the action that triggered this query.

    qe

    the QueryExecution object that carries detail information like logical plan, physical plan, etc.

    durationNs

    the execution time for this query in nanoseconds.

    Annotations
    @DeveloperApi()
    Note

    This can be invoked by multiple different threads.

Concrete 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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  14. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  15. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  16. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped