All Classes and Interfaces
Class
Description
A CompactionFilter allows an application to modify/delete a key-value at
the time of compaction.
Each compaction will create a new
AbstractCompactionFilter
allowing the application to know about different compactionsComparators are used by RocksDB to determine
the ordering of keys.
Base class for Event Listeners.
Offers functionality for implementations of
AbstractNativeReference which have an immutable reference to the
underlying native C++ objectThis class is not strictly abstract in Java language terms, so we do not declare it as such.
AbstractNativeReference is the base-class of all RocksDB classes that have
a pointer to a native C++
rocksdb object.Base class implementation for Rocks Iterators
in the Java API
Slices are used by RocksDB to provide
efficient access to keys and values.
Base class for Table Filters.
Base class for TraceWriters.
Provides notification to the caller of SetSnapshotOnNextOperation when
the actual snapshot gets created
Base class for WAL Filters.
Advanced Column Family Options which are not
mutable (i.e.
Advanced Column Family Options which are mutable
BackupEngine allows you to backup
and restore the database
BackupEngineOptions controls the behavior of a
BackupEngine.Instances of this class describe a Backup made by
BackupEngine.The config for block based table sst format.
Bloom filter policy that uses a bloom filter with approximately
the specified number of bits per key.
Builtin RocksDB comparators
BYTEWISE_COMPARATOR - Sorts all keys in ascending bytewise
order.
REVERSE_BYTEWISE_COMPARATOR - Sorts all keys in descending bytewise
order
A ByteBuffer containing fetched data, together with a result for the fetch
and the total size of the object fetched.
This is a Java Native implementation of the C++
equivalent BytewiseComparatorImpl using
Slice
The performance of Comparators implemented in Java is always
less than their C++ counterparts due to the bridging overhead,
as such you likely don't want to use this apart from benchmarking
and you most likely instead wanted
BuiltinComparator.BYTEWISE_COMPARATORJust a Java wrapper around CassandraCompactionFilter implemented in C++
CassandraValueMergeOperator is a merge operator that merges two cassandra wide column
values.
Provides Checkpoint functionality.
Checksum types used in conjunction with BlockBasedTable.
Deprecated.
The old Clock Cache implementation had an unresolved bug and
has been removed.
Describes a column family with a
name and respective Options.
ColumnFamilyHandle class to hold handles to underlying rocksdb
ColumnFamily Pointers.
The metadata that describes a column family.
ColumnFamilyOptions to control the behavior of a database.
CompactionOptions are used in
RocksDB.compactFiles(CompactionOptions, ColumnFamilyHandle, List, int, int, CompactionJobInfo)
calls.Options for FIFO Compaction
Options for Universal Compaction
Compaction Priorities
Algorithm used to make a compaction request stop picking new files
into a single compaction run
Enum CompactionStyle
CompactRangeOptions is used by CompactRange() call.
This class controls the behaviour
of Java implementations of
AbstractComparator
Options for Compression
Enum CompressionType
DataBlockIndexType used in conjunction with BlockBasedTable.
DBOptions to control the behavior of a database.
Tuple of database path and target size
Base class for slices which will receive direct
ByteBuffer based access to the underlying data.
EncodingType
Base class for all Env implementations in RocksDB.
Options while opening a file to read/write
EventListener class contains a set of callback functions that will
be called when specific RocksDB event happens such as flush.
Marks a feature as experimental, meaning that it is likely
to change or even be removed/re-engineered in the future
The metadata that describes a column family.
Java representation of FileOperationInfo struct from include/rocksdb/listener.h
Filters are stored in rocksdb and are consulted automatically
by rocksdb to decide whether or not to read some
information from disk.
IndexType used in conjunction with BlockBasedTable.
FlushOptions to be passed to flush operations of
RocksDB.The result for a fetch
and the total size of the object fetched.
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).
The config for hash skip-list mem-table representation.
Simple instance reference wrapper.
HyperClockCache - A lock-free Cache alternative for RocksDB block cache
that offers much improved CPU efficiency vs.
ImportColumnFamilyOptions is used by
RocksDB.createColumnFamilyWithImport(ColumnFamilyDescriptor, ImportColumnFamilyOptions, ExportImportFilesMetaData).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 used in conjunction with BlockBasedTable.
RocksDB log levels.
IngestExternalFileOptions is used by
RocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions).This is a Java implementation of a Comparator for Java int
keys.
The metadata that describes a level.
The full set of metadata associated with each SST file.
This class provides a custom logger functionality
in Java which wraps
RocksDB logging facilities.LoggerInterface is a thin interface that specifies the most basic
functionality for a Java wrapper around a RocksDB Logger.
Simple enumeration used for differentiating
the types of loggers when passing via the JNI
boundary.
Least Recently Used Cache
MemoryUsageType
JNI passthrough for MemoryUtil.
MemTableConfig is used to config the internal mem-table of a RocksDB.
MergeOperator holds an operator to be applied when compacting
two merge operands held under the same key in order to obtain a single
value.
A simple abstraction to allow a Java class to wrap a custom comparator
implemented in C++.
This class is used to load the RocksDB shared library from within the jar.
The operation stage.
The type used to refer to a thread operation.
Database with Transaction support.
Options to control the behavior of a database.
Persistent cache for caching IO pages on a persistent medium.
The config for plain table sst format.
Enum PrepopulateBlobCache
The Thread Pool priority.
Range from start to limit.
RateLimiter, which is used to control write rate of flush and
compaction.
The class that controls the get behavior.
RocksDB
ReadOptions read tiers.Just a Java wrapper around EmptyValueCompactionFilter implemented in C++
RestoreOptions to control the behavior of restore.
Determines the type of synchronisation primitive used
in native code.
This is a Java Native implementation of the C++
equivalent ReverseBytewiseComparatorImpl using
Slice
The performance of Comparators implemented in Java is always
less than their C++ counterparts due to the bridging overhead,
as such you likely don't want to use this apart from benchmarking
and you most likely instead wanted
BuiltinComparator.REVERSE_BYTEWISE_COMPARATORRocksCallbackObject 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.A RocksDB is a persistent ordered map from keys to values.
A RocksDBException encapsulates the error of an operation.
A RocksEnv is an interface used by the rocksdb implementation to access
operating system functionality like the filesystem etc.
An iterator that yields a sequence of key/value pairs from a source.
Defines the interface for an Iterator which provides
access to data one entry at a time.
Memory environment.
RocksMutableObject is an implementation of
AbstractNativeReference
whose reference to the underlying native C++ object can change.RocksObject is an implementation of
AbstractNativeReference which
has an immutable and therefore thread-safe reference to the underlying
native C++ RocksDB object.Flags for
RocksDB.getApproximateSizes(ColumnFamilyHandle, List, SizeApproximationFlag...)
that specify whether memtable stats should be included,
or file stats approximation or both.The config for skip-list memtable representation.
Base class for slices which will receive
byte[] based access to the underlying data.
Snapshot of database
SstFileManager is used to track SST files in the DB and control their
deletion rate.
The metadata that describes a SST file.
An iterator that yields a sequence of key/value pairs from a source.
SstFileWriter is used to create sst files that can be added to the
database later.
Handle to factory for SstPartitioner.
Fixed prefix factory.
The type used to refer to a thread state.
Statistics to analyze the performance of a db.
Helper class to collect DB statistics periodically at a period specified in
constructor.
Callback interface provided to StatisticsCollector.
Contains all information necessary to collect statistics from one instance
of DB statistics.
The level of Statistics to report.
Represents the status returned by a function call in RocksDB.
Simply redirects all log messages to StdErr.
StringAppendOperator is a merge operator that concatenates
two strings.
Filter for iterating a table.
TableFormatConfig is used to config the internal Table format of a RocksDB.
TableProperties contains read-only properties of its associated
table.
The type of a thread.
The logical mapping of tickers defined in rocksdb::Tickers.
Timed environment.
TraceOptions is used for
RocksDB.startTrace(TraceOptions, AbstractTraceWriter).TraceWriter allows exporting RocksDB traces to any system,
one operation at a time.
Provides BEGIN/COMMIT/ROLLBACK transactions.
Database with Transaction support
A TransactionLogIterator is used to iterate over the transactions in a db.
BatchResult represents a data structure returned
by a TransactionLogIterator containing a sequence
number and a
WriteBatch instance.Database with TTL support.
The transaction db write policy.
Uint64AddOperator is a merge operator that accumlates a long
integer value.
The config for vector memtable representation.
WALFilter allows an application to inspect write-ahead-log (WAL)
records or modify their processing on recovery.
The WAL Recover Mode
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.Enumeration of the Write operation
that created the record in the Write Batch
WriteBatch holds a collection of updates to apply atomically to a DB.
Handler callback for iterating over the contents of a batch.
A structure for describing the save point in the Write Batch.
Defines the interface for a Write Batch which
holds a collection of updates to apply atomically to a DB.
Similar to
WriteBatch but with a binary searchable
index built for all the keys inserted.Java wrapper over native write_buffer_manager class
Options that control write operations.