Package org.rocksdb

The RocksDB Java driver

See: Description

Interface Summary

Interface	Description
AdvancedColumnFamilyOptionsInterface<T extends AdvancedColumnFamilyOptionsInterface<T>>	Advanced Column Family Options which are not mutable (i.e. present in AdvancedMutableColumnFamilyOptionsInterface Taken from include/rocksdb/advanced_options.h
AdvancedMutableColumnFamilyOptionsInterface<T extends AdvancedMutableColumnFamilyOptionsInterface<T>>	Advanced Column Family Options which are mutable Taken from include/rocksdb/advanced_options.h and MutableCFOptions in util/cf_options.h
ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInterface<T>>
DBOptionsInterface<T extends DBOptionsInterface<T>>
EventListener	EventListener class contains a set of callback functions that will be called when specific RocksDB event happens such as flush.
MutableColumnFamilyOptionsInterface<T extends MutableColumnFamilyOptionsInterface<T>>
MutableDBOptionsInterface<T extends MutableDBOptionsInterface<T>>
MutableOptionKey
RocksIteratorInterface	Defines the interface for an Iterator which provides access to data one entry at a time.
StatisticsCollectorCallback	Callback interface provided to StatisticsCollector.
TableFilter	Filter for iterating a table.
TraceWriter	TraceWriter allows exporting RocksDB traces to any system, one operation at a time.
WalFilter	WALFilter allows an application to inspect write-ahead-log (WAL) records or modify their processing on recovery.
WriteBatchInterface	Defines the interface for a Write Batch which holds a collection of updates to apply atomically to a DB.

Class Summary

Class	Description
AbstractCompactionFilter<T extends AbstractSlice<?>>	A CompactionFilter allows an application to modify/delete a key-value at the time of compaction.
AbstractCompactionFilter.Context
AbstractCompactionFilterFactory<T extends AbstractCompactionFilter<?>>	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.
AbstractImmutableNativeReference	Offers functionality for implementations of AbstractNativeReference which have an immutable reference to the underlying native C++ object
AbstractMutableOptions
AbstractMutableOptions.AbstractMutableOptionsBuilder<T extends AbstractMutableOptions,U extends AbstractMutableOptions.AbstractMutableOptionsBuilder<T,U,K>,K extends MutableOptionKey>
AbstractNativeReference	AbstractNativeReference is the base-class of all RocksDB classes that have a pointer to a native C++ rocksdb object.
AbstractRocksIterator<P extends RocksObject>	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<T>	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
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.
BloomFilter	Bloom filter policy that uses a bloom filter with approximately the specified number of bits per key.
ByteBufferGetStatus	A ByteBuffer containing fetched data, together with a result for the fetch and the total size of the object fetched.
Cache
CassandraCompactionFilter	Just a Java wrapper around CassandraCompactionFilter implemented in C++
CassandraValueMergeOperator	CassandraValueMergeOperator is a merge operator that merges two cassandra wide column values.
Checkpoint	Provides Checkpoint functionality.
ClockCache	Similar to LRUCache, but based on the CLOCK algorithm with better concurrent performance in some cases
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.
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
CompactRangeOptions	CompactRangeOptions is used by CompactRange() call.
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
ConcurrentTaskLimiter
ConcurrentTaskLimiterImpl
ConfigOptions
DBOptions	DBOptions to control the behavior of a database.
DbPath	Tuple of database path and target size
DirectSlice	Base class for slices which will receive direct ByteBuffer based access to the underlying data.
Env	Base class for all Env implementations in RocksDB.
EnvOptions	Options while opening a file to read/write
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.
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
Holder<T>	Simple instance reference wrapper.
IngestExternalFileOptions	IngestExternalFileOptions is used by RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions).
KeyMayExist
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.
LRUCache	Least Recently Used Cache
MemoryUtil	JNI passthrough for MemoryUtil.
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.MutableColumnFamilyOptionsBuilder
MutableDBOptions
MutableDBOptions.MutableDBOptionsBuilder
MutableOptionValue<T>
NativeComparatorWrapper	A simple abstraction to allow a Java class to wrap a custom comparator implemented in C++.
NativeLibraryLoader	This class is used to load the RocksDB shared library from within the jar.
OptimisticTransactionDB	Database with Transaction support.
OptimisticTransactionOptions
Options	Options to control the behavior of a database.
OptionString
OptionsUtil
PersistentCache	Persistent cache for caching IO pages on a persistent medium.
PlainTableConfig	The config for plain table sst format.
Range	Range from start to limit.
RateLimiter	RateLimiter, which is used to control write rate of flush and compaction.
ReadOptions	The class that controls the get behavior.
RemoveEmptyValueCompactionFilter	Just a Java wrapper around EmptyValueCompactionFilter implemented in C++
RestoreOptions	RestoreOptions to control the behavior of restore.
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
RocksEnv	A RocksEnv is an interface used by the rocksdb implementation to access operating system functionality like the filesystem etc.
RocksIterator	An iterator that yields a sequence of key/value pairs from a source.
RocksMemEnv	Memory environment.
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.
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.
SstFileWriter	SstFileWriter is used to create sst files that can be added to the database later.
SstPartitionerFactory	Handle to factory for SstPartitioner.
SstPartitionerFixedPrefixFactory	Fixed prefix factory.
Statistics	Statistics to analyze the performance of a db.
StatisticsCollector	Helper class to collect DB statistics periodically at a period specified in constructor.
StatsCollectorInput	Contains all information necessary to collect statistics from one instance of DB statistics.
Status	Represents the status returned by a function call in RocksDB.
StringAppendOperator	StringAppendOperator is a merge operator that concatenates two strings.
TableFileCreationBriefInfo
TableFileCreationInfo
TableFileDeletionInfo
TableFormatConfig	TableFormatConfig is used to config the internal Table format of a RocksDB.
TableProperties	TableProperties contains read-only properties of its associated table.
ThreadStatus
TimedEnv	Timed environment.
TraceOptions	TraceOptions is used for RocksDB.startTrace(TraceOptions, AbstractTraceWriter).
Transaction	Provides BEGIN/COMMIT/ROLLBACK transactions.
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.
UInt64AddOperator	Uint64AddOperator is a merge operator that accumlates a long integer value.
VectorMemTableConfig	The config for vector memtable representation.
WalFilter.LogRecordFoundResult
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.
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.
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.
WriteStallInfo

Enum Summary

Enum	Description
AbstractEventListener.EnabledEventCallback
AccessHint	File access pattern once a compaction has started
BackgroundErrorReason
BuiltinComparator	Builtin RocksDB comparators BYTEWISE_COMPARATOR - Sorts all keys in ascending bytewise order.
ChecksumType	Checksum types used in conjunction with BlockBasedTable.
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.BottommostLevelCompaction
CompressionType	Enum CompressionType DB contents are stored in a set of blocks, each of which holds a sequence of key,value pairs.
DataBlockIndexType	DataBlockIndexType used in conjunction with BlockBasedTable.
EncodingType	EncodingType The value will determine how to encode keys when writing to a new SST file.
FlushReason
HistogramType
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.
KeyMayExist.KeyMayExistEnum
MemoryUsageType	MemoryUsageType The value will be used as a key to indicate the type of memory usage described
MutableColumnFamilyOptions.BlobOption
MutableColumnFamilyOptions.CompactionOption
MutableColumnFamilyOptions.MemtableOption
MutableColumnFamilyOptions.MiscOption
MutableDBOptions.DBOption
MutableOptionKey.ValueType
OperationStage	The operation stage.
OperationType	The type used to refer to a thread operation.
Priority	The Thread Pool priority.
RateLimiterMode	Mode for RateLimiter.RateLimiter(long, long, int, RateLimiterMode).
ReadTier	RocksDB ReadOptions read tiers.
ReusedSynchronisationType	Determines the type of synchronisation primitive used in native code.
SanityLevel
SizeApproximationFlag	Flags for RocksDB.getApproximateSizes(ColumnFamilyHandle, List, SizeApproximationFlag...)
StateType	The type used to refer to a thread state.
StatsLevel	The level of Statistics to report.
Status.Code
Status.SubCode
TableFileCreationReason
ThreadType	The type of a thread.
TickerType	The logical mapping of tickers defined in rocksdb::Tickers.
Transaction.TransactionState
TxnDBWritePolicy	The transaction db write policy.
WalFileType
WalProcessingOption
WALRecoveryMode	The WAL Recover Mode
WBWIRocksIterator.WriteType	Enumeration of the Write operation that created the record in the Write Batch
WriteStallCondition

Exception Summary

Exception	Description
RocksDBException	A RocksDBException encapsulates the error of an operation.

Annotation Types Summary

Annotation Type	Description
Experimental	Marks a feature as experimental, meaning that it is likely to change or even be removed/re-engineered in the future

Package org.rocksdb Description

The RocksDB Java driver