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.
- Alphabetic
- By Inheritance
- ReadStateStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def abort(): Unit
Clean up the resource.
Clean up the resource.
The method name is to respect backward compatibility on StateStore.
- 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.
- abstract def id: StateStoreId
Unique identifier of the store
- abstract def iterator(): Iterator[UnsafeRowPair]
Return an iterator containing all the key-value pairs in the StateStore.
- 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
numColsPrefixKeycolumns of the key schema.It is expected to throw exception if Spark calls this method without setting numColsPrefixKey to the greater than 0.
- abstract def version: Long
Version of the data in this store before committing updates.
Concrete Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()