Packages

c

org.apache.spark.sql.execution.streaming

CompositeKeyTTLStateImpl

abstract class CompositeKeyTTLStateImpl extends TTLState

Manages the ttl information for user state keyed with a single key (grouping key).

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

Instance Constructors

  1. new CompositeKeyTTLStateImpl(stateName: String, store: StateStore, ttlExpirationMs: Long)

Abstract Value Members

  1. abstract def clearIfExpired(groupingKey: Array[Byte], userKey: Array[Byte]): Long

    Clears the user state associated with this grouping key if it has expired.

    Clears the user state associated with this grouping key if it has expired. This function is called by Spark to perform cleanup at the end of transformWithState processing.

    Spark uses a secondary index to determine if the user state for this grouping key has expired. However, its possible that the user has updated the TTL and secondary index is out of date. Implementations must validate that the user State has actually expired before cleanup based on their own State data.

    groupingKey

    grouping key for which cleanup should be performed.

    userKey

    user key for which cleanup should be performed.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clearExpiredState(): Long

    Clears any state which has ttl older than ttlExpirationMs.

    Clears any state which has ttl older than ttlExpirationMs.

    returns

    number of values cleaned up.

    Definition Classes
    CompositeKeyTTLStateImplTTLState
  6. def clearTTLState(): Unit
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  16. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  17. def toString(): String
    Definition Classes
    AnyRef → Any
  18. def upsertTTLForStateKey(expirationMs: Long, groupingKey: Array[Byte], userKey: Array[Byte]): Unit
  19. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  20. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  21. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 TTLState

Inherited from AnyRef

Inherited from Any

Ungrouped