Package org.rocksdb
package org.rocksdb
-
ClassDescriptionAbstractCompactionFilter<T extends AbstractSlice<?>>A CompactionFilter allows an application to modify/delete a key-value at the time of compaction.AbstractCompactionFilterFactory<T extends AbstractCompactionFilter<?>>Each compaction will create a new
AbstractCompactionFilterallowing 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 ofAbstractNativeReferencewhich 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.AbstractMutableOptions.AbstractMutableOptionsBuilder<T extends AbstractMutableOptions,U extends AbstractMutableOptions.AbstractMutableOptionsBuilder<T, U, K>, K extends MutableOptionKey> AbstractNativeReference is the base-class of all RocksDB classes that have a pointer to a native C++rocksdbobject.AbstractRocksIterator<P extends RocksObject>Base class implementation for Rocks Iterators in the Java APISlices 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 createdBase class for WAL Filters.AdvancedColumnFamilyOptionsInterface<T extends AdvancedColumnFamilyOptionsInterface<T> & ColumnFamilyOptionsInterface<T>>Advanced Column Family Options which are not mutable (i.e.AdvancedMutableColumnFamilyOptionsInterface<T extends AdvancedMutableColumnFamilyOptionsInterface<T>>Advanced Column Family Options which are mutableBackupEngine allows you to backup and restore the databaseBackupEngineOptions controls the behavior of aBackupEngine.Instances of this class describe a Backup made byBackupEngine.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 orderA ByteBuffer containing fetched data, together with a result for the fetch and the total size of the object fetched.Just 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.ColumnFamilyOptionsInterface<T extends ColumnFamilyOptionsInterface<T>>CompactionOptions are used inRocksDB.compactFiles(CompactionOptions, ColumnFamilyHandle, List, int, int, CompactionJobInfo)calls.Options for FIFO CompactionOptions for Universal CompactionCompaction PrioritiesAlgorithm used to make a compaction request stop picking new files into a single compaction runEnum CompactionStyleCompactRangeOptions is used by CompactRange() call.This class controls the behaviour of Java implementations of AbstractComparatorOptions for CompressionEnum CompressionTypeDataBlockIndexType used in conjunction with BlockBasedTable.DBOptions to control the behavior of a database.DBOptionsInterface<T extends DBOptionsInterface<T>>Tuple of database path and target sizeBase class for slices which will receive direct ByteBuffer based access to the underlying data.EncodingTypeBase class for all Env implementations in RocksDB.Options while opening a file to read/writeEventListener 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 futureThe metadata that describes a column family.Java representation of FileOperationInfo struct from include/rocksdb/listener.hFilters 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 ofRocksDB.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.Holder<T>Simple instance reference wrapper.HyperClockCache - A lock-free Cache alternative for RocksDB block cache that offers much improved CPU efficiency vs.ImportColumnFamilyOptions is used byRocksDB.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 byRocksDB.ingestExternalFile(ColumnFamilyHandle, List, IngestExternalFileOptions).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 wrapsRocksDBlogging 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 CacheMemoryUsageTypeJNI 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.MutableDBOptionsInterface<T extends MutableDBOptionsInterface<T>>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 PrepopulateBlobCacheThe 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.RocksDBReadOptionsread 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.RocksCallbackObject is similar toRocksObjectbut 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 ofAbstractNativeReferencewhose reference to the underlying native C++ object can change.RocksObject is an implementation ofAbstractNativeReferencewhich has an immutable and therefore thread-safe reference to the underlying native C++ RocksDB object.Flags forRocksDB.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 databaseSstFileManager 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.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 forRocksDB.startTrace(TraceOptions, AbstractTraceWriter).TraceWriter allows exporting RocksDB traces to any system, one operation at a time.Provides BEGIN/COMMIT/ROLLBACK transactions.Database with Transaction supportA 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 aWriteBatchinstance.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 ModeRepresents an entry returned byWBWIRocksIterator.entry()It is worth noting that a WriteEntry with the typeWBWIRocksIterator.WriteType.DELETEorWBWIRocksIterator.WriteType.LOGwill not have a value.Enumeration of the Write operation that created the record in the Write BatchWriteBatch 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 toWriteBatchbut with a binary searchable index built for all the keys inserted.Java wrapper over native write_buffer_manager classOptions that control write operations.