Uses of Class
org.rocksdb.RocksDB

Packages that use RocksDB

Package	Description
org.rocksdb	The RocksDB Java driver

Uses of RocksDB in org.rocksdb

Subclasses of RocksDB in org.rocksdb

Modifier and Type	Class and Description
class	OptimisticTransactionDB Database with Transaction support.
class	TransactionDB Database with Transaction support
class	TtlDB Database with TTL support.

Methods in org.rocksdb that return RocksDB

Modifier and Type	Method and Description
RocksDB	OptimisticTransactionDB.getBaseDB() Get the underlying database that was opened.
static RocksDB	RocksDB.open(DBOptions options, String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
static RocksDB	RocksDB.open(Options options, String path) The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path.
static RocksDB	RocksDB.open(String path) The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the default options w/ createIfMissing set to true.
static RocksDB	RocksDB.open(String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) The factory constructor of RocksDB that opens a RocksDB instance given the path to the database using the specified options and db path and a list of column family names.
static RocksDB	RocksDB.openAsSecondary(DBOptions options, String path, String secondaryPath, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) Open DB as secondary instance with column families.
static RocksDB	RocksDB.openAsSecondary(Options options, String path, String secondaryPath) Open DB as secondary instance with only the default column family.
static RocksDB	RocksDB.openReadOnly(DBOptions options, String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
static RocksDB	RocksDB.openReadOnly(DBOptions options, String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles, boolean errorIfWalFileExists) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
static RocksDB	RocksDB.openReadOnly(Options options, String path) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
static RocksDB	RocksDB.openReadOnly(Options options, String path, boolean errorIfWalFileExists) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the specified options and db path.
static RocksDB	RocksDB.openReadOnly(String path) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.
static RocksDB	RocksDB.openReadOnly(String path, List<ColumnFamilyDescriptor> columnFamilyDescriptors, List<ColumnFamilyHandle> columnFamilyHandles) The factory constructor of RocksDB that opens a RocksDB instance in Read-Only mode given the path to the database using the default options.

Methods in org.rocksdb with parameters of type RocksDB

Modifier and Type	Method and Description
static Checkpoint	Checkpoint.create(RocksDB db) Creates a Checkpoint object to be used for creating open-able snapshots.
void	BackupEngine.createNewBackup(RocksDB db) Captures the state of the database in the latest backup Just a convenience for BackupEngine.createNewBackup(RocksDB, boolean) with the flushBeforeBackup parameter set to false
void	BackupEngine.createNewBackup(RocksDB db, boolean flushBeforeBackup) Captures the state of the database in the latest backup
void	BackupEngine.createNewBackupWithMetadata(RocksDB db, String metadata, boolean flushBeforeBackup) Captures the state of the database in the latest backup along with application specific metadata.
byte[]	WriteBatchWithIndex.getFromBatchAndDB(RocksDB db, ColumnFamilyHandle columnFamilyHandle, ReadOptions options, byte[] key) Similar to get(ColumnFamilyHandle, byte[]) but will also read writes from this batch.
byte[]	WriteBatchWithIndex.getFromBatchAndDB(RocksDB db, ReadOptions options, byte[] key) Similar to get(byte[]) but will also read writes from this batch.
void	AbstractEventListener.onCompactionBegin(RocksDB db, CompactionJobInfo compactionJobInfo)
void	EventListener.onCompactionBegin(RocksDB db, CompactionJobInfo compactionJobInfo) A callback function to RocksDB which will be called before a RocksDB starts to compact.
void	AbstractEventListener.onCompactionCompleted(RocksDB db, CompactionJobInfo compactionJobInfo)
void	EventListener.onCompactionCompleted(RocksDB db, CompactionJobInfo compactionJobInfo) A callback function for RocksDB which will be called whenever a registered RocksDB compacts a file.
void	AbstractEventListener.onExternalFileIngested(RocksDB db, ExternalFileIngestionInfo externalFileIngestionInfo)
void	EventListener.onExternalFileIngested(RocksDB db, ExternalFileIngestionInfo externalFileIngestionInfo) A callback function for RocksDB which will be called after an external file is ingested using IngestExternalFile.
void	AbstractEventListener.onFlushBegin(RocksDB db, FlushJobInfo flushJobInfo)
void	EventListener.onFlushBegin(RocksDB db, FlushJobInfo flushJobInfo) A callback function to RocksDB which will be called before a RocksDB starts to flush memtables.
void	AbstractEventListener.onFlushCompleted(RocksDB db, FlushJobInfo flushJobInfo)
void	EventListener.onFlushCompleted(RocksDB db, FlushJobInfo flushJobInfo) callback function to RocksDB which will be called whenever a registered RocksDB flushes a file.

Method parameters in org.rocksdb with type arguments of type RocksDB

Modifier and Type	Method and Description
static Map<MemoryUsageType,Long>	MemoryUtil.getApproximateMemoryUsageByType(List<RocksDB> dbs, Set<Cache> caches) Returns the approximate memory usage of different types in the input list of DBs and Cache set.

Constructors in org.rocksdb with parameters of type RocksDB

Constructor and Description
RocksIterator(RocksDB rocksDB, long nativeHandle)