Package org.rocksdb

Interface Summary

Interface	Description
ColumnFamilyOptionsInterface
DBOptionsInterface
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.
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
AbstractComparator<T extends org.rocksdb.AbstractSlice<?>>	Comparators are used by RocksDB to determine the ordering of keys.
AbstractRocksIterator<P extends RocksObject>	Base class implementation for Rocks Iterators in the Java API
AbstractWriteBatch
BackupableDB	A subclass of RocksDB which supports backup-related operations.
BackupableDBOptions	BackupableDBOptions to control the behavior of a backupable database.
BackupInfo	Instances of this class describe a Backup made by BackupableDB.
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.
Checkpoint	Provides Checkpoint functionality.
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.
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++.
DBOptions	DBOptions to control the behavior of a database.
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.
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.
GenericRateLimiterConfig	Config for rate limiter, which is used to control write rate of flush and compaction.
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
Logger	This class provides a custom logger functionality in Java which wraps RocksDB logging facilities.
MemTableConfig	MemTableConfig is used to config the internal mem-table of a RocksDB.
NativeLibraryLoader	This class is used to load the RocksDB shared library from within the jar.
Options	Options to control the behavior of a database.
PlainTableConfig	The config for plain table sst format.
RateLimiterConfig	Config for rate limiter, which is used to control write rate of flush and compaction.
ReadOptions	The class that controls the get behavior.
RestoreBackupableDB	This class is used to access information about backups and restore from them.
RestoreOptions	RestoreOptions to control the behavior of restore.
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.
RocksObject	RocksObject is the base-class of all RocksDB classes that has a pointer to some 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
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.
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.
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
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.
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.
TickerType
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.