Packages

class RocksDB extends Logging

Class representing a RocksDB instance that checkpoints version of data to DFS. After a set of updates, a new version can be committed by calling commit(). Any past version can be loaded by calling load(version).

Note

This class is not thread-safe, so use it only from one thread.

See also

RocksDBFileManager to see how the files are laid out in local disk and DFS.

Linear Supertypes
Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. RocksDB
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new RocksDB(dfsRootDir: String, conf: RocksDBConf, localRootDir: File = Utils.createTempDir(), hadoopConf: Configuration = new Configuration, loggingId: String = "", useColumnFamilies: Boolean = false, enableStateStoreCheckpointIds: Boolean = false, partitionId: Int = 0, eventForwarder: Option[RocksDBEventForwarder] = None, uniqueId: Option[String] = None)

    conf

    Configuration for RocksDB

    localRootDir

    Root directory in local disk that is used to working and checkpointing dirs

    hadoopConf

    Hadoop configuration for talking to the remote file system

    eventForwarder

    The RocksDBEventForwarder object for reporting events to the coordinator

Type Members

  1. implicit class LogStringContext extends AnyRef
    Definition Classes
    Logging

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. def MDC(key: LogKey, value: Any): MDC
    Attributes
    protected
    Definition Classes
    Logging
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def checkColFamilyExists(colFamilyName: String): Boolean

    Function to check if the column family exists in the state store instance.

    Function to check if the column family exists in the state store instance.

    colFamilyName

    - name of the column family

    returns

    - true if the column family exists, false otherwise

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  8. def close(): Unit

    Release all resources

  9. def commit(): (Long, StateStoreCheckpointInfo)

    Commit all the updates made as a version to DFS.

    Commit all the updates made as a version to DFS. The steps it needs to do to commits are: - Flush all changes to disk - Create a RocksDB checkpoint in a new local dir - Sync the checkpoint dir files to DFS

  10. val conf: RocksDBConf
  11. def createColFamilyIfAbsent(colFamilyName: String, isInternal: Boolean): Short

    Check if the column family exists with given name and create one if it doesn't.

    Check if the column family exists with given name and create one if it doesn't. Users can create external column families storing user facing data as well as internal column families such as secondary indexes. Metrics for both of these types are tracked separately.

    colFamilyName

    - column family name

    isInternal

    - whether the column family is for internal use or not

    returns

    - virtual column family id

  12. def createFileManager(dfsRootDir: String, localTempDir: File, hadoopConf: Configuration, codecName: String, loggingId: String, storeConf: StateStoreConf): RocksDBFileManager
    Attributes
    protected
  13. def doMaintenance(): Unit
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. val fileChecksumThreadPoolSize: Option[Int]
    Attributes
    protected
  17. def get(key: Array[Byte], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME): Array[Byte]

    Get the value for the given key if present, or null.

    Get the value for the given key if present, or null.

    Note

    This will return the last written value even if it was uncommitted.

  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  19. def getColFamilyCount(isInternal: Boolean): Long
  20. def getFullLineage(startVersion: Long, endVersion: Long, endVersionStateStoreCkptId: Option[String]): Array[LineageItem]

    Construct the full lineage from startVersion to endVersion (inclusive) by walking backwards using lineage information embedded in changelog files.

  21. def getLatestVersion(): Long

    Get the latest version available in the DFS

  22. def getMemoryUsage: Long

    Returns the current memory usage of this RocksDB instance in bytes.

    Returns the current memory usage of this RocksDB instance in bytes. WARNING: This method should only be called from the task thread when RocksDB is in a safe state.

    This includes memory from all major RocksDB components: - Table readers (indexes and filters in memory) - Memtables (write buffers) - Block cache (cached data blocks) - Block cache pinned usage (blocks pinned in cache)

    returns

    Total memory usage in bytes across all tracked components

  23. def getWriteBufferManagerAndCache(): (WriteBufferManager, Cache)

    Get the write buffer manager and cache

  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  25. def initializeLogIfNecessary(isInterpreter: Boolean, silent: Boolean): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  26. def initializeLogIfNecessary(isInterpreter: Boolean): Unit
    Attributes
    protected
    Definition Classes
    Logging
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isTraceEnabled(): Boolean
    Attributes
    protected
    Definition Classes
    Logging
  29. def iterator(cfName: String): NextIterator[ByteArrayPair]

    Get an iterator of all committed and uncommitted key-value pairs for the given column family.

  30. def iterator(): NextIterator[ByteArrayPair]

    Get an iterator of all committed and uncommitted key-value pairs.

  31. var lastCommitBasedStateStoreCkptId: Option[String]
    Attributes
    protected
  32. var lastCommittedStateStoreCkptId: Option[String]
    Attributes
    protected
  33. val lastUploadedSnapshotVersion: AtomicLong
    Attributes
    protected
  34. val lineageManager: RocksDBLineageManager
    Attributes
    protected[sql]
  35. def load(version: Long, stateStoreCkptId: Option[String] = None, readOnly: Boolean = false): RocksDB
  36. def loadFromSnapshot(snapshotVersion: Long, endVersion: Long, snapshotVersionStateStoreCkptId: Option[String] = None, endVersionStateStoreCkptId: Option[String] = None): RocksDB

    Load from the start snapshot version and apply all the changelog records to reach the end version.

    Load from the start snapshot version and apply all the changelog records to reach the end version. Note that this will copy all the necessary files from DFS to local disk as needed, and possibly restart the native RocksDB instance.

    snapshotVersion

    version of the snapshot to start with

    endVersion

    end version

    snapshotVersionStateStoreCkptId

    state store checkpoint ID of the snapshot version

    endVersionStateStoreCkptId

    state store checkpoint ID of the end version

    returns

    A RocksDB instance loaded with the state endVersion replayed from snapshotVersion. Note that the instance will be read-only since this method is only used in State Data Source.

  37. var loadedStateStoreCkptId: Option[String]
    Attributes
    protected
  38. var loadedVersion: Long
    Attributes
    protected
  39. val localRootDir: File
  40. def log: Logger
    Attributes
    protected
    Definition Classes
    Logging
  41. def logBasedOnLevel(level: Level)(f: => MessageWithContext): Unit
    Attributes
    protected
    Definition Classes
    Logging
  42. def logDebug(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  43. def logDebug(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  44. def logDebug(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  45. def logDebug(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  46. def logError(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  47. def logError(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  48. def logError(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  49. def logError(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  50. def logInfo(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  51. def logInfo(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  52. def logInfo(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  53. def logInfo(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  54. def logName: String
    Attributes
    protected
    Definition Classes
    RocksDB → Logging
  55. def logTrace(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  56. def logTrace(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  57. def logTrace(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  58. def logTrace(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  59. def logWarning(msg: => String, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  60. def logWarning(entry: LogEntry, throwable: Throwable): Unit
    Attributes
    protected
    Definition Classes
    Logging
  61. def logWarning(entry: LogEntry): Unit
    Attributes
    protected
    Definition Classes
    Logging
  62. def logWarning(msg: => String): Unit
    Attributes
    protected
    Definition Classes
    Logging
  63. def merge(key: Array[Byte], value: Array[Byte], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME, includesPrefix: Boolean = false, deriveCfName: Boolean = false): Unit

    Merge the given value for the given key.

    Merge the given value for the given key. This is equivalent to the Atomic Read-Modify-Write operation in RocksDB, known as the "Merge" operation. The modification is appending the provided value to current list of values for the given key.

    Note

    This operation requires that the encoder used can decode multiple values for a key from the values byte array.

    ,

    This update is not committed to disk until commit() is called.

  64. def mergeList(key: Array[Byte], values: List[Array[Byte]], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME, includesPrefix: Boolean = false, deriveCfName: Boolean = false): Unit

    Merge the given list of values for the given key.

    Merge the given list of values for the given key.

    This is similar to the merge() function, but allows merging multiple values at once. The provided values will be appended to the current list of values for the given key.

  65. def metricsOpt: Option[RocksDBMetrics]

    Function to return RocksDB metrics if the recorded metrics are available and the operator has reached the commit stage for this state store instance and version.

    Function to return RocksDB metrics if the recorded metrics are available and the operator has reached the commit stage for this state store instance and version. If not, we return None

    returns

    - Return RocksDBMetrics if available and None otherwise

  66. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  67. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  68. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  69. def prefixScan(prefix: Array[Byte], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME): NextIterator[ByteArrayPair]
  70. def put(key: Array[Byte], value: Array[Byte], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME, includesPrefix: Boolean = false, deriveCfName: Boolean = false): Unit

    Put the given value for the given key.

    Put the given value for the given key.

    Note

    This update is not committed to disk until commit() is called.

  71. def putList(key: Array[Byte], values: List[Array[Byte]], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME, includesPrefix: Boolean = false, deriveCfName: Boolean = false): Unit

    Put the given list of values for the given key.

    Put the given list of values for the given key.

    Note

    This update is not committed to disk until commit() is called.

  72. def release(): Unit
  73. def remove(key: Array[Byte], cfName: String = StateStore.DEFAULT_COL_FAMILY_NAME, includesPrefix: Boolean = false, deriveCfName: Boolean = false): Unit

    Remove the key if present.

    Remove the key if present.

    Note

    This update is not committed to disk until commit() is called.

  74. def removeColFamilyIfExists(colFamilyName: String): Boolean

    Remove RocksDB column family, if exists

    Remove RocksDB column family, if exists

    returns

    columnFamilyId if it exists, else None

  75. def rollback(): Unit

    Drop uncommitted changes, and roll back to previous version.

  76. var sessionStateStoreCkptId: Option[String]
    Attributes
    protected
  77. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  78. def toString(): String
    Definition Classes
    AnyRef → Any
  79. def updateMemoryUsageIfNeeded(): Unit

    Updates the cached memory usage if enough time has passed.

    Updates the cached memory usage if enough time has passed. This is called from task thread operations, so it's already thread-safe.

  80. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  82. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  83. def withLogContext(context: Map[String, String])(body: => Unit): Unit
    Attributes
    protected
    Definition Classes
    Logging

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 Logging

Inherited from AnyRef

Inherited from Any

Ungrouped