Packages

trait ReadStateStore extends AnyRef

Base trait for a versioned key-value store which provides read operations. Each instance of a ReadStateStore represents a specific version of state data, and such instances are created through a StateStoreProvider.

abort method will be called when the task is completed - please clean up the resources in the method.

IMPLEMENTATION NOTES: * The implementation can throw exception on calling prefixScan method if the functionality is not supported yet from the implementation. Note that some stateful operations would not work on disabling prefixScan functionality.

Linear Supertypes
AnyRef, Any
Known Subclasses
StateStore, WrappedReadStateStore
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ReadStateStore
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def abort(): Unit

    Clean up the resource.

    Clean up the resource.

    The method name is to respect backward compatibility on StateStore.

  2. abstract def get(key: UnsafeRow): UnsafeRow

    Get the current value of a non-null key.

    Get the current value of a non-null key.

    returns

    a non-null row if the key exists in the store, otherwise null.

  3. abstract def id: StateStoreId

    Unique identifier of the store

  4. abstract def iterator(): Iterator[UnsafeRowPair]

    Return an iterator containing all the key-value pairs in the StateStore.

  5. abstract def prefixScan(prefixKey: UnsafeRow): Iterator[UnsafeRowPair]

    Return an iterator containing all the key-value pairs which are matched with the given prefix key.

    Return an iterator containing all the key-value pairs which are matched with the given prefix key.

    The operator will provide numColsPrefixKey greater than 0 in StateStoreProvider.init method if the operator needs to leverage the "prefix scan" feature. The schema of the prefix key should be same with the leftmost numColsPrefixKey columns of the key schema.

    It is expected to throw exception if Spark calls this method without setting numColsPrefixKey to the greater than 0.

  6. abstract def version: Long

    Version of the data in this store before committing updates.

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped