Class

com.twitter.finatra.kafkastreams.transformer.stores.internal

FinatraTransformerLifecycleKeyValueStore

Related Doc: package internal

Permalink

case class FinatraTransformerLifecycleKeyValueStore[K, V](name: String, flushListener: Option[(String, K, V) ⇒ Unit] = None) extends FinatraKeyValueStore[K, V] with Logging with Product with Serializable

A FinatraKeyValueStore which allows FinatraTransformer#getKeyValueStore to retrieve a key value store in it's static constructor and then have that returned store participate in the Kafka Streams init and close lifecycle

name

State store name

flushListener

Callback that will be called every time a cached store entry is flushed into the underlying RocksDB store

Linear Supertypes
Serializable, Serializable, Product, Equals, Logging, Logging, FinatraKeyValueStore[K, V], FinatraReadOnlyKeyValueStore[K, V], KeyValueStore[K, V], ReadOnlyKeyValueStore[K, V], StateStore, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FinatraTransformerLifecycleKeyValueStore
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Logging
  7. Logging
  8. FinatraKeyValueStore
  9. FinatraReadOnlyKeyValueStore
  10. KeyValueStore
  11. ReadOnlyKeyValueStore
  12. StateStore
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FinatraTransformerLifecycleKeyValueStore(name: String, flushListener: Option[(String, K, V) ⇒ Unit] = None)

    Permalink

    name

    State store name

    flushListener

    Callback that will be called every time a cached store entry is flushed into the underlying RocksDB store

Value Members

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def all(): KeyValueIterator[K, V]

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → ReadOnlyKeyValueStore
  5. def approximateNumEntries(): Long

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → ReadOnlyKeyValueStore
  6. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def close(): Unit

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  9. def debug(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  10. def debug(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  11. def debug(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  12. def debug(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  13. def debugFutureResult[T](msg: String)(func: ⇒ Future[T]): Future[T]

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  14. def debugResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  15. def delete(k: K): V

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → KeyValueStore
  16. def deleteRange(from: K, to: K): Unit

    Permalink

    Removes the database entries in the range ["from", "to"), i.e., including "from" and excluding "to".

    Removes the database entries in the range ["from", "to"), i.e., including "from" and excluding "to". It is not an error if no keys exist in the range ["from", "to").

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
    Exceptions thrown

    InvalidStateStoreException if the store is not initialized

  17. def deleteRangeExperimentalWithNoChangelogUpdates(beginKeyInclusive: Array[Byte], endKeyExclusive: Array[Byte]): Unit

    Permalink

    Removes the database entries in the range ["begin_key", "end_key"), i.e., including "begin_key" and excluding "end_key".

    Removes the database entries in the range ["begin_key", "end_key"), i.e., including "begin_key" and excluding "end_key". Returns OK on success, and a non-OK status on error. It is not an error if no keys exist in the range ["begin_key", "end_key").

    This feature is currently an experimental performance optimization for deleting very large ranges of contiguous keys. Invoking it many times or on small ranges may severely degrade read performance; in particular, the resulting performance can be worse than calling Delete() for each key in the range. Note also the degraded read performance affects keys outside the deleted ranges, and affects database operations involving scans, like flush and compaction.

    Consider setting ReadOptions::ignore_range_deletions = true to speed up reads for key(s) that are known to be unaffected by range deletions.

    Note: Changelog entries will not be deleted, so this method is best used when relying on retention.ms to delete entries from the changelog

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
  18. def deleteWithoutGettingPriorValue(key: K): Unit

    Permalink

    Delete the value from the store (if there is one) Note: This version of delete avoids getting the prior value which keyValueStore.delete does

    Delete the value from the store (if there is one) Note: This version of delete avoids getting the prior value which keyValueStore.delete does

    key

    The key

    returns

    The old value or null if there is no such key.

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
    Exceptions thrown

    NullPointerException If null is used for key.

  19. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. def error(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  21. def error(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  22. def error(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  23. def error(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  24. def errorResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  25. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  26. def flush(): Unit

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  27. val flushListener: Option[(String, K, V) ⇒ Unit]

    Permalink

    Callback that will be called every time a cached store entry is flushed into the underlying RocksDB store

  28. def get(k: K): V

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → ReadOnlyKeyValueStore
  29. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  30. def getOrDefault(key: K, default: ⇒ V): V

    Permalink

    Get the value corresponding to this key or return the specified default value if no key is found

    Get the value corresponding to this key or return the specified default value if no key is found

    key

    The key to fetch

    default

    The default value to return if key is not found in the store

    returns

    The value associated with the key or the default value if the key is not found

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
    Exceptions thrown

    InvalidStateStoreException if the store is not initialized

    NullPointerException If null is used for key.

  31. def info(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  32. def info(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  33. def info(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  34. def info(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  35. def infoResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  36. def init(processorContext: ProcessorContext, root: StateStore): Unit

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  37. def isDebugEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  38. def isDebugEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  39. def isErrorEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  40. def isErrorEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  41. def isInfoEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  42. def isInfoEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  43. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  44. def isOpen(): Boolean

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  45. def isTraceEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  46. def isTraceEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  47. def isWarnEnabled(marker: Marker): Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  48. def isWarnEnabled: Boolean

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  49. final def logger: Logger

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  50. final def loggerName: String

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  51. val name: String

    Permalink

    State store name

    State store name

    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  52. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  55. def persistent(): Boolean

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → StateStore
  56. def put(k: K, v: V): Unit

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → KeyValueStore
  57. def putAll(list: List[KeyValue[K, V]]): Unit

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → KeyValueStore
  58. def putIfAbsent(k: K, v: V): V

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → KeyValueStore
  59. def range(k: K, k1: K): KeyValueIterator[K, V]

    Permalink
    Definition Classes
    FinatraTransformerLifecycleKeyValueStore → ReadOnlyKeyValueStore
  60. def range(fromBytesInclusive: Array[Byte], toBytesExclusive: Array[Byte]): KeyValueIterator[K, V]

    Permalink

    Get an iterator over a given range of keys.

    Get an iterator over a given range of keys. This iterator must be closed after use. The returned iterator must be safe from java.util.ConcurrentModificationExceptions and must not return null values. No ordering guarantees are provided.

    fromBytesInclusive

    Inclusive bytes to start the range scan

    toBytesExclusive

    Exclusive bytes to end the range scan

    returns

    The iterator for this range.

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
    Exceptions thrown

    InvalidStateStoreException if the store is not initialized

    NullPointerException If null is used for from or to.

  61. def range(fromBytes: Array[Byte]): KeyValueIterator[K, V]

    Permalink

    A range scan starting from bytes.

    A range scan starting from bytes.

    Note 1: This is an API for Advanced users only

    Note 2: If this RocksDB instance is configured in "prefix seek mode", than fromBytes will be used as a "prefix" and the iteration will end when the prefix is no longer part of the next element. Enabling "prefix seek mode" can be done by calling options.useFixedLengthPrefixExtractor. When enabled, prefix scans can take advantage of a prefix based bloom filter for better seek performance See: https://github.com/facebook/rocksdb/wiki/Prefix-Seek-API-Changes

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraKeyValueStore
    Exceptions thrown

    InvalidStateStoreException if the store is not initialized

  62. def range(from: K, to: K, allowStaleReads: Boolean): KeyValueIterator[K, V]

    Permalink

    Get an iterator over a given range of keys.

    Get an iterator over a given range of keys. This iterator must be closed after use. The returned iterator must be safe from java.util.ConcurrentModificationExceptions and must not return null values. No ordering guarantees are provided.

    from

    The first key that could be in the range

    to

    The last key that could be in the range

    allowStaleReads

    Allow stale reads when querying (Stale reads can occur when querying key value stores with caching enabled).

    returns

    The iterator for this range.

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraReadOnlyKeyValueStore
    Exceptions thrown

    InvalidStateStoreException if the store is not initialized

    NullPointerException If null is used for from or to.

  63. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  64. def taskId: TaskId

    Permalink

    Returns the task id of this tore

    Returns the task id of this tore

    returns

    the task id of this store

    Definition Classes
    FinatraTransformerLifecycleKeyValueStoreFinatraReadOnlyKeyValueStore
  65. def time[T](formatStr: String)(func: ⇒ T): T

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  66. def trace(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  67. def trace(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  68. def trace(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  69. def trace(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  70. def traceResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  71. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  74. def warn(marker: Marker, message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  75. def warn(message: ⇒ Any, cause: Throwable): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  76. def warn(marker: Marker, message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  77. def warn(message: ⇒ Any): Unit

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging
  78. def warnResult[T](message: ⇒ String)(fn: ⇒ T): T

    Permalink
    Attributes
    protected[this]
    Definition Classes
    Logging

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Logging

Inherited from Logging

Inherited from FinatraKeyValueStore[K, V]

Inherited from FinatraReadOnlyKeyValueStore[K, V]

Inherited from KeyValueStore[K, V]

Inherited from ReadOnlyKeyValueStore[K, V]

Inherited from StateStore

Inherited from AnyRef

Inherited from Any

Ungrouped