Package org.rocksdb

Interface Summary

Interface	Description
AdvancedColumnFamilyOptionsInterface<T extends AdvancedColumnFamilyOptionsInterface>	Advanced Column Family Options which are not mutable (i.e.
AdvancedMutableColumnFamilyOptionsInterface<T extends AdvancedMutableColumnFamilyOptionsInterface>	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>
DBOptionsInterface<T extends DBOptionsInterface>
MutableColumnFamilyOptionsInterface<T extends MutableColumnFamilyOptionsInterface>
RocksIteratorInterface	Defines the interface for an Iterator which provides access to data one entry at a time.
StatisticsCollectorCallback	Callback interface provided to StatisticsCollector.
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<T extends AbstractSlice<?>>	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.
AbstractRocksIterator<P extends RocksObject>	Base class implementation for Rocks Iterators in the Java API
AbstractSlice<T>	Slices are used by RocksDB to provide efficient access to keys and values.
AbstractWriteBatch
BackupableDBOptions	BackupableDBOptions to control the behavior of a backupable database.
BackupEngine	BackupEngine allows you to backup and restore the database Be aware, that `new BackupEngine` takes time proportional to the amount of backups.
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.
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.
ColumnFamilyOptions	ColumnFamilyOptions to control the behavior of a database.
CompactionOptionsFIFO	Options for FIFO Compaction
CompactionOptionsUniversal	Options for Universal Compaction
Comparator	Base class for comparators which will receive byte[] based access via org.rocksdb.Slice in their compare method implementation.
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
DBOptions	DBOptions to control the behavior of a database.
DbPath	Tuple of database path and target size
DirectComparator	Base class for comparators which will receive ByteBuffer based access via org.rocksdb.DirectSlice in their compare method implementation.
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
Filter	Filters are stored in rocksdb and are consulted automatically by rocksdb to decide whether or not to read some information from disk.
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
IngestExternalFileOptions	IngestExternalFileOptions is used by RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions)
Logger	This class provides a custom logger functionality in Java which wraps RocksDB logging facilities.
LRUCache	Least Recently Used Cache
MemTableConfig	MemTableConfig is used to config the internal mem-table of a RocksDB.
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
NativeLibraryLoader	This class is used to load the RocksDB shared library from within the jar.
Options	Options to control the behavior of a database.
OptionsUtil
PlainTableConfig	The config for plain table sst format.
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.
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	RocksDB 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
SstFileWriter	SstFileWriter is used to create sst files that can be added to the database later.
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.
TableFormatConfig	TableFormatConfig is used to config the internal Table format of a RocksDB.
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.
TtlDB	Database with TTL support.
VectorMemTableConfig	The config for vector memtable representation.
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.
WriteBatchWithIndex	Similar to WriteBatch but with a binary searchable index built for all the keys inserted.
WriteOptions	Options that control write operations.

Enum Summary

Enum	Description
AccessHint	File access pattern once a compaction has started
BuiltinComparator	Builtin RocksDB comparators BYTEWISE_COMPARATOR - Sorts all keys in ascending bytewise order. REVERSE_BYTEWISE_COMPARATOR - Sorts all keys in descending bytewise order
ChecksumType	Checksum types used in conjunction with BlockBasedTable.
CompactionPriority	Compaction Priorities
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.
CompressionType	Enum CompressionType
EncodingType	EncodingType
HistogramType
IndexType	IndexType used in conjunction with BlockBasedTable.
InfoLogLevel	RocksDB log levels.
MutableColumnFamilyOptions.CompactionOption
MutableColumnFamilyOptions.MemtableOption
MutableColumnFamilyOptions.MiscOption
MutableColumnFamilyOptions.ValueType
ReadTier	RocksDB ReadOptions read tiers.
StatsLevel	The level of Statistics to report.
Status.Code
Status.SubCode
TickerType
WALRecoveryMode	The WAL Recover Mode
WBWIRocksIterator.WriteType	Enumeration of the Write operation that created the record in the Write Batch

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