Packages

c

org.apache.spark.sql.execution.streaming

CompositeKeyStateEncoder

class CompositeKeyStateEncoder[K, V] extends StateTypesEncoder[V]

Linear Supertypes
StateTypesEncoder[V], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CompositeKeyStateEncoder
  2. StateTypesEncoder
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new CompositeKeyStateEncoder(keyEncoder: ExpressionEncoder[Any], userKeyEnc: Encoder[K], valEncoder: Encoder[V], stateName: String, hasTtl: Boolean = false)

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  6. def decodeCompositeKey(row: UnsafeRow): K

    The input row is of composite Key schema.

    The input row is of composite Key schema. Only user key is returned though grouping key also exist in the row.

  7. def decodeTtlExpirationMs(row: UnsafeRow): Option[Long]

    Decode the ttl information out of Value row.

    Decode the ttl information out of Value row. If the ttl has not been set (-1L specifies no user defined value), the API will return None.

    Definition Classes
    StateTypesEncoder
  8. def decodeUserKey(row: UnsafeRow): K
  9. def decodeValue(row: UnsafeRow): V
    Definition Classes
    StateTypesEncoder
  10. def encodeCompositeKey(groupingKey: UnsafeRow, userKey: UnsafeRow): UnsafeRow
  11. def encodeCompositeKey(userKey: K): UnsafeRow

    Grouping key and user key are encoded as a row of schemaForCompositeKeyRow schema.

    Grouping key and user key are encoded as a row of schemaForCompositeKeyRow schema. Grouping key will be encoded in RocksDBStateEncoder as the prefix column.

  12. def encodeGroupingKey(): UnsafeRow
  13. def encodeUserKey(userKey: K): UnsafeRow
  14. def encodeValue(value: V, expirationMs: Long): UnsafeRow

    Encode the specified value in Spark UnsafeRow with provided ttl expiration.

    Encode the specified value in Spark UnsafeRow with provided ttl expiration.

    Definition Classes
    StateTypesEncoder
  15. def encodeValue(value: V): UnsafeRow

    Encode the specified value in Spark UnsafeRow with no ttl.

    Encode the specified value in Spark UnsafeRow with no ttl.

    Definition Classes
    StateTypesEncoder
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  20. def isExpired(row: UnsafeRow, batchTimestampMs: Long): Boolean
    Definition Classes
    StateTypesEncoder
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  25. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. 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 StateTypesEncoder[V]

Inherited from AnyRef

Inherited from Any

Ungrouped