Class

org.apache.spark.sql.execution.metric

SQLMetric

Related Doc: package metric

Permalink

final class SQLMetric extends AccumulatorV2Kryo[Long, Long] with KryoSerializable

A metric used in a SQL query plan. This is implemented as an AccumulatorV2. Updates on the executor side are automatically propagated and shown in the SQL UI through metrics. Updates on the driver side must be explicitly posted using SQLMetrics.postDriverMetricUpdates().

Linear Supertypes
AccumulatorV2Kryo[Long, Long], KryoSerializable, AccumulatorV2[Long, Long], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SQLMetric
  2. AccumulatorV2Kryo
  3. KryoSerializable
  4. AccumulatorV2
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SQLMetric(metricType: String, initValue: Long = 0L)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +=(v: Long): Unit

    Permalink
  4. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  5. def add(v: Long): Unit

    Permalink

    Takes the inputs and accumulates.

    Takes the inputs and accumulates.

    Definition Classes
    SQLMetricAccumulatorV2
  6. final def addLong(v: Long): Unit

    Permalink
  7. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. def copy(): SQLMetric

    Permalink

    Creates a new copy of this accumulator.

    Creates a new copy of this accumulator.

    Definition Classes
    SQLMetricAccumulatorV2
  10. def copyAndReset(): AccumulatorV2[Long, Long]

    Permalink

    Creates a new copy of this accumulator, which is zero value.

    Creates a new copy of this accumulator, which is zero value. i.e. call isZero on the copy must return true.

    Definition Classes
    AccumulatorV2
  11. final def eq(arg0: AnyRef): Boolean

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  16. final def id: Long

    Permalink

    Returns the id of this accumulator, can only be called after registration.

    Returns the id of this accumulator, can only be called after registration.

    Definition Classes
    AccumulatorV2
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. final def isRegistered: Boolean

    Permalink

    Returns true if this accumulator has been registered.

    Returns true if this accumulator has been registered.

    Definition Classes
    AccumulatorV2
    Note

    All accumulators must be registered before use, or it will throw exception.

  19. def isZero(): Boolean

    Permalink

    Returns if this accumulator is zero value or not.

    Returns if this accumulator is zero value or not. e.g. for a counter accumulator, 0 is zero value; for a list accumulator, Nil is zero value.

    Definition Classes
    SQLMetricAccumulatorV2
  20. final def longValue: Long

    Permalink
  21. def merge(other: AccumulatorV2[Long, Long]): Unit

    Permalink

    Merges another same-type accumulator into this one and update its state, i.e.

    Merges another same-type accumulator into this one and update its state, i.e. this should be merge-in-place.

    Definition Classes
    SQLMetricAccumulatorV2
  22. var metricType: String

    Permalink
  23. final def name: Option[String]

    Permalink

    Returns the name of this accumulator, can only be called after registration.

    Returns the name of this accumulator, can only be called after registration.

    Definition Classes
    AccumulatorV2
  24. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  27. final def read(kryo: Kryo, input: Input, context: TaskContext): Unit

    Permalink
    Definition Classes
    AccumulatorV2Kryo
  28. final def read(kryo: Kryo, input: Input): Unit

    Permalink

    Child classes must implement readKryo() and cannot override this.

    Child classes must implement readKryo() and cannot override this.

    Definition Classes
    AccumulatorV2Kryo → KryoSerializable
  29. def readKryo(kryo: Kryo, input: Input): Unit

    Permalink
    Definition Classes
    SQLMetricAccumulatorV2Kryo
  30. def reset(): Unit

    Permalink

    Resets this accumulator, which is zero value.

    Resets this accumulator, which is zero value. i.e. call isZero must return true.

    Definition Classes
    SQLMetricAccumulatorV2
  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  32. def toInfo(update: Option[Any], value: Option[Any]): AccumulableInfo

    Permalink

    Creates an AccumulableInfo representation of this AccumulatorV2 with the provided values.

    Creates an AccumulableInfo representation of this AccumulatorV2 with the provided values.

    Definition Classes
    SQLMetricAccumulatorV2
  33. def toString(): String

    Permalink
    Definition Classes
    AccumulatorV2 → AnyRef → Any
  34. def value: Long

    Permalink

    Defines the current value of this accumulator

    Defines the current value of this accumulator

    Definition Classes
    SQLMetricAccumulatorV2
  35. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def write(kryo: Kryo, output: Output): Unit

    Permalink

    Child classes cannot override this and must instead implement writeKryo/readKryo for consistent writeReplace() behavior.

    Child classes cannot override this and must instead implement writeKryo/readKryo for consistent writeReplace() behavior.

    Definition Classes
    AccumulatorV2Kryo → KryoSerializable
  39. def writeKryo(kryo: Kryo, output: Output): Unit

    Permalink
    Definition Classes
    SQLMetricAccumulatorV2Kryo
  40. final def writeReplace(): Any

    Permalink
    Attributes
    protected
    Definition Classes
    AccumulatorV2

Inherited from AccumulatorV2Kryo[Long, Long]

Inherited from KryoSerializable

Inherited from AccumulatorV2[Long, Long]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped