Package io.camunda.zeebe.db.impl.rocksdb.transaction

Record Class RocksDbOptions

java.lang.Object
java.lang.Record
io.camunda.zeebe.db.impl.rocksdb.transaction.RocksDbOptions
Record Components:
dbOptions - The database options used to open the RocksDB database
cfOptions - The column family options used to open the RocksDB database
public record RocksDbOptions(org.rocksdb.DBOptions dbOptions, org.rocksdb.ColumnFamilyOptions cfOptions) extends Record
RocksDB has separate options for the database and the column families. Zeebe configuration can change these depending on its own configuration. As each of the parts must be individually closed, this record allows easily passing both configurations around within Zeebe.

While each column family in RocksDB can be configured differently, Zeebe only uses a single RocksDB column family. We therefore don't have to differentiate further than a single database options and a single column family options.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RocksDbOptions(org.rocksdb.DBOptions dbOptions, org.rocksdb.ColumnFamilyOptions cfOptions)
    Creates an instance of a RocksDbOptions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.rocksdb.ColumnFamilyOptions
    cfOptions()
    Returns the value of the cfOptions record component.
    org.rocksdb.DBOptions
    dbOptions()
    Returns the value of the dbOptions record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • RocksDbOptions

      public RocksDbOptions(org.rocksdb.DBOptions dbOptions, org.rocksdb.ColumnFamilyOptions cfOptions)
      Creates an instance of a RocksDbOptions record class.
      Parameters:
      dbOptions - the value for the dbOptions record component
      cfOptions - the value for the cfOptions record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • dbOptions

      public org.rocksdb.DBOptions dbOptions()
      Returns the value of the dbOptions record component.
      Returns:
      the value of the dbOptions record component

    • cfOptions

      public org.rocksdb.ColumnFamilyOptions cfOptions()
      Returns the value of the cfOptions record component.
      Returns:
      the value of the cfOptions record component