Uses of Package
org.rocksdb

Packages that use org.rocksdb

Package	Description
org.rocksdb	The RocksDB Java driver
org.rocksdb.util	RocksDB Java driver utilities

Classes in org.rocksdb used by org.rocksdb

Class and Description
AbstractCompactionFilter A CompactionFilter allows an application to modify/delete a key-value at the time of compaction.
AbstractCompactionFilter.Context
AbstractCompactionFilterFactory Each compaction will create a new AbstractCompactionFilter allowing the application to know about different compactions
AbstractComparator Comparators are used by RocksDB to determine the ordering of keys.
AbstractEventListener Base class for Event Listeners.
AbstractEventListener.EnabledEventCallback
AbstractImmutableNativeReference Offers functionality for implementations of AbstractNativeReference which have an immutable reference to the underlying native C++ object
AbstractMutableOptions
AbstractMutableOptions.AbstractMutableOptionsBuilder
AbstractNativeReference AbstractNativeReference is the base-class of all RocksDB classes that have a pointer to a native C++ rocksdb object.
AbstractRocksIterator Base class implementation for Rocks Iterators in the Java API Multiple threads can invoke const methods on an RocksIterator without external synchronization, but if any of the threads may call a non-const method, all threads accessing the same RocksIterator must use external synchronization.
AbstractSlice Slices are used by RocksDB to provide efficient access to keys and values.
AbstractTableFilter Base class for Table Filters.
AbstractTraceWriter Base class for TraceWriters.
AbstractTransactionNotifier Provides notification to the caller of SetSnapshotOnNextOperation when the actual snapshot gets created
AbstractWalFilter Base class for WAL Filters.
AbstractWriteBatch
AccessHint File access pattern once a compaction has started
AdvancedColumnFamilyOptionsInterface Advanced Column Family Options which are not mutable (i.e. present in AdvancedMutableColumnFamilyOptionsInterface Taken from include/rocksdb/advanced_options.h
AdvancedMutableColumnFamilyOptionsInterface Advanced Column Family Options which are mutable Taken from include/rocksdb/advanced_options.h and MutableCFOptions in util/cf_options.h
BackgroundErrorReason
BackupEngine BackupEngine allows you to backup and restore the database Be aware, that `new BackupEngine` takes time proportional to the amount of backups.
BackupEngineOptions BackupEngineOptions controls the behavior of a BackupEngine.
BackupInfo Instances of this class describe a Backup made by BackupEngine.
BlockBasedTableConfig The config for plain table sst format.
BuiltinComparator Builtin RocksDB comparators BYTEWISE_COMPARATOR - Sorts all keys in ascending bytewise order.
ByteBufferGetStatus A ByteBuffer containing fetched data, together with a result for the fetch and the total size of the object fetched.
Cache
Checkpoint Provides Checkpoint functionality.
ChecksumType Checksum types used in conjunction with BlockBasedTable.
ColumnFamilyDescriptor Describes a column family with a name and respective Options.
ColumnFamilyHandle ColumnFamilyHandle class to hold handles to underlying rocksdb ColumnFamily Pointers.
ColumnFamilyMetaData The metadata that describes a column family.
ColumnFamilyOptions ColumnFamilyOptions to control the behavior of a database.
ColumnFamilyOptionsInterface
CompactionJobInfo
CompactionJobStats
CompactionOptions CompactionOptions are used in RocksDB.compactFiles(CompactionOptions, ColumnFamilyHandle, List, int, int, CompactionJobInfo) calls.
CompactionOptionsFIFO Options for FIFO Compaction
CompactionOptionsUniversal Options for Universal Compaction
CompactionPriority Compaction Priorities
CompactionReason
CompactionStopStyle Algorithm used to make a compaction request stop picking new files into a single compaction run
CompactionStyle Enum CompactionStyle RocksDB supports different styles of compaction.
CompactRangeOptions CompactRangeOptions is used by CompactRange() call.
CompactRangeOptions.BottommostLevelCompaction
ComparatorOptions This class controls the behaviour of Java implementations of AbstractComparator Note that dispose() must be called before a ComparatorOptions instance becomes out-of-scope to release the allocated memory in C++.
CompressionOptions Options for Compression
CompressionType Enum CompressionType DB contents are stored in a set of blocks, each of which holds a sequence of key,value pairs.
ConcurrentTaskLimiter
ConfigOptions
DataBlockIndexType DataBlockIndexType used in conjunction with BlockBasedTable.
DBOptions DBOptions to control the behavior of a database.
DBOptionsInterface
DbPath Tuple of database path and target size
DirectSlice Base class for slices which will receive direct ByteBuffer based access to the underlying data.
EncodingType EncodingType The value will determine how to encode keys when writing to a new SST file.
Env Base class for all Env implementations in RocksDB.
EnvOptions Options while opening a file to read/write
EventListener EventListener class contains a set of callback functions that will be called when specific RocksDB event happens such as flush.
Experimental Marks a feature as experimental, meaning that it is likely to change or even be removed/re-engineered in the future
ExternalFileIngestionInfo
FileOperationInfo Java representation of FileOperationInfo struct from include/rocksdb/listener.h
Filter Filters are stored in rocksdb and are consulted automatically by rocksdb to decide whether or not to read some information from disk.
FlushJobInfo
FlushOptions FlushOptions to be passed to flush operations of RocksDB.
FlushReason
HashLinkedListMemTableConfig The config for hash linked list memtable representation Such memtable contains a fix-sized array of buckets, where each bucket points to a sorted singly-linked list (or null if the bucket is empty).
HashSkipListMemTableConfig The config for hash skip-list mem-table representation.
HistogramData
HistogramType
Holder Simple instance reference wrapper.
IndexShorteningMode This enum allows trading off increased index size for improved iterator seek performance in some situations, particularly when block cache is disabled (ReadOptions.fillCache() == false and direct IO is enabled (DBOptions.useDirectReads() == true).
IndexType IndexType used in conjunction with BlockBasedTable.
InfoLogLevel RocksDB log levels.
IngestExternalFileOptions IngestExternalFileOptions is used by RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions).
KeyMayExist
KeyMayExist.KeyMayExistEnum
LevelMetaData The metadata that describes a level.
LiveFileMetaData The full set of metadata associated with each SST file.
LogFile
Logger This class provides a custom logger functionality in Java which wraps RocksDB logging facilities.
MemoryUsageType MemoryUsageType The value will be used as a key to indicate the type of memory usage described
MemTableConfig MemTableConfig is used to config the internal mem-table of a RocksDB.
MemTableInfo
MergeOperator MergeOperator holds an operator to be applied when compacting two merge operands held under the same key in order to obtain a single value.
MutableColumnFamilyOptions
MutableColumnFamilyOptions.BlobOption
MutableColumnFamilyOptions.CompactionOption
MutableColumnFamilyOptions.MemtableOption
MutableColumnFamilyOptions.MiscOption
MutableColumnFamilyOptions.MutableColumnFamilyOptionsBuilder
MutableColumnFamilyOptionsInterface
MutableDBOptions
MutableDBOptions.DBOption
MutableDBOptions.MutableDBOptionsBuilder
MutableDBOptionsInterface
MutableOptionKey
MutableOptionKey.ValueType
NativeLibraryLoader This class is used to load the RocksDB shared library from within the jar.
OperationStage The operation stage.
OperationType The type used to refer to a thread operation.
OptimisticTransactionDB Database with Transaction support.
OptimisticTransactionOptions
Options Options to control the behavior of a database.
PersistentCache Persistent cache for caching IO pages on a persistent medium.
PlainTableConfig The config for plain table sst format.
Priority The Thread Pool priority.
Range Range from start to limit.
RateLimiter RateLimiter, which is used to control write rate of flush and compaction.
RateLimiterMode Mode for RateLimiter.RateLimiter(long, long, int, RateLimiterMode).
ReadOptions The class that controls the get behavior.
ReadTier RocksDB ReadOptions read tiers.
RestoreOptions RestoreOptions to control the behavior of restore.
ReusedSynchronisationType Determines the type of synchronisation primitive used in native code.
RocksCallbackObject RocksCallbackObject is similar to RocksObject but varies in its construction as it is designed for Java objects which have functions which are called from C++ via JNI.
RocksDB A RocksDB is a persistent ordered map from keys to values.
RocksDB.CountAndSize
RocksDB.LiveFiles
RocksDB.Version
RocksDBException A RocksDBException encapsulates the error of an operation.
RocksIterator An iterator that yields a sequence of key/value pairs from a source.
RocksIteratorInterface Defines the interface for an Iterator which provides access to data one entry at a time.
RocksMutableObject RocksMutableObject is an implementation of AbstractNativeReference whose reference to the underlying native C++ object can change.
RocksObject RocksObject is an implementation of AbstractNativeReference which has an immutable and therefore thread-safe reference to the underlying native C++ RocksDB object.
SanityLevel
SizeApproximationFlag Flags for RocksDB.getApproximateSizes(ColumnFamilyHandle, List, SizeApproximationFlag...)
SkipListMemTableConfig The config for skip-list memtable representation.
Slice Base class for slices which will receive byte[] based access to the underlying data.
Snapshot Snapshot of database
SstFileManager SstFileManager is used to track SST files in the DB and control their deletion rate.
SstFileMetaData The metadata that describes a SST file.
SstFileReader
SstFileReaderIterator An iterator that yields a sequence of key/value pairs from a source.
SstPartitionerFactory Handle to factory for SstPartitioner.
StateType The type used to refer to a thread state.
Statistics Statistics to analyze the performance of a db.
StatisticsCollectorCallback Callback interface provided to StatisticsCollector.
StatsCollectorInput Contains all information necessary to collect statistics from one instance of DB statistics.
StatsLevel The level of Statistics to report.
Status Represents the status returned by a function call in RocksDB.
Status.Code
Status.SubCode
TableFileCreationBriefInfo
TableFileCreationInfo
TableFileCreationReason
TableFileDeletionInfo
TableFilter Filter for iterating a table.
TableFormatConfig TableFormatConfig is used to config the internal Table format of a RocksDB.
TableProperties TableProperties contains read-only properties of its associated table.
ThreadStatus
ThreadType The type of a thread.
TickerType The logical mapping of tickers defined in rocksdb::Tickers.
TraceOptions TraceOptions is used for RocksDB.startTrace(TraceOptions, AbstractTraceWriter).
TraceWriter TraceWriter allows exporting RocksDB traces to any system, one operation at a time.
Transaction Provides BEGIN/COMMIT/ROLLBACK transactions.
Transaction.TransactionState
Transaction.WaitingTransactions
TransactionDB Database with Transaction support
TransactionDB.DeadlockInfo
TransactionDB.DeadlockPath
TransactionDB.KeyLockInfo
TransactionDBOptions
TransactionLogIterator A TransactionLogIterator is used to iterate over the transactions in a db.
TransactionLogIterator.BatchResult BatchResult represents a data structure returned by a TransactionLogIterator containing a sequence number and a WriteBatch instance.
TransactionOptions
TtlDB Database with TTL support.
TxnDBWritePolicy The transaction db write policy.
VectorMemTableConfig The config for vector memtable representation.
WalFileType
WalFilter WALFilter allows an application to inspect write-ahead-log (WAL) records or modify their processing on recovery.
WalFilter.LogRecordFoundResult
WalProcessingOption
WALRecoveryMode The WAL Recover Mode
WBWIRocksIterator
WBWIRocksIterator.WriteEntry Represents an entry returned by WBWIRocksIterator.entry() It is worth noting that a WriteEntry with the type WBWIRocksIterator.WriteType.DELETE or WBWIRocksIterator.WriteType.LOG will not have a value.
WBWIRocksIterator.WriteType Enumeration of the Write operation that created the record in the Write Batch
WriteBatch WriteBatch holds a collection of updates to apply atomically to a DB.
WriteBatch.Handler Handler callback for iterating over the contents of a batch.
WriteBatch.SavePoint A structure for describing the save point in the Write Batch.
WriteBatchInterface Defines the interface for a Write Batch which holds a collection of updates to apply atomically to a DB.
WriteBatchWithIndex Similar to WriteBatch but with a binary searchable index built for all the keys inserted.
WriteBufferManager Java wrapper over native write_buffer_manager class
WriteOptions Options that control write operations.
WriteStallCondition
WriteStallInfo

Classes in org.rocksdb used by org.rocksdb.util

Class and Description
AbstractComparator Comparators are used by RocksDB to determine the ordering of keys.
AbstractImmutableNativeReference Offers functionality for implementations of AbstractNativeReference which have an immutable reference to the underlying native C++ object
AbstractNativeReference AbstractNativeReference is the base-class of all RocksDB classes that have a pointer to a native C++ rocksdb object.
ComparatorOptions This class controls the behaviour of Java implementations of AbstractComparator Note that dispose() must be called before a ComparatorOptions instance becomes out-of-scope to release the allocated memory in C++.
RocksCallbackObject RocksCallbackObject is similar to RocksObject but varies in its construction as it is designed for Java objects which have functions which are called from C++ via JNI.