io.zeebe.logstreams.rocksdb

Class ZbRocksDb

java.lang.Object

org.rocksdb.AbstractNativeReference

org.rocksdb.AbstractImmutableNativeReference

org.rocksdb.RocksObject

org.rocksdb.RocksDB

io.zeebe.logstreams.rocksdb.ZbRocksDb

All Implemented Interfaces:

AutoCloseable

public class ZbRocksDb
extends org.rocksdb.RocksDB

Extends RocksDB base class to expose a few protected methods, cuts down on the need for reflection since all we need is the initial pointer to the wrapped database.

Add methods as you require them.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ZbRocksDb.IteratorCallback
static class	ZbRocksDb.IteratorControl

Field Summary

Fields inherited from class org.rocksdb.RocksDB

DEFAULT_COLUMN_FAMILY, NOT_FOUND, options_

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ZbRocksDb(long nativeHandle)

Method Summary

Modifier and Type	Method and Description
void	delete(org.rocksdb.ColumnFamilyHandle columnFamily, byte[] key, int keyOffset, int keyLength)
void	delete(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer key)
boolean	exists(org.rocksdb.ColumnFamilyHandle columnFamily, byte[] key, int keyOffset, int keyLength)
boolean	exists(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer key)
boolean	exists(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer key, org.agrona.MutableDirectBuffer value) Allows doing an exist call and getting the value back (since it has to be read anyway) if it does.
void	forEach(org.rocksdb.ColumnFamilyHandle columnFamily, ZbRocksDb.IteratorCallback callback)
void	forEachPrefixed(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer prefix, ZbRocksDb.IteratorCallback callback) NOTE: it doesn't seem possible in Java RocksDB to set a flexible prefix extractor on iterators at the moment, so using prefixes seem to be mostly related to skipping files that do not contain keys with the given prefix (which is useful anyway), but it will still iterate over all keys contained in those files, so we still need to make sure the key actually matches the prefix.
int	get(org.rocksdb.ColumnFamilyHandle columnFamily, byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
int	get(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer key, org.agrona.MutableDirectBuffer value)
int	get(org.rocksdb.ColumnFamilyHandle columnFamily, long key, org.agrona.MutableDirectBuffer value)
List<ZbRocksEntry>	list(org.rocksdb.ColumnFamilyHandle columnFamily) NOTE: not recommended for production use, since it loads all key/values into memory, but it's very useful for debugging.
ZbRocksIterator	newIterator()
ZbRocksIterator	newIterator(org.rocksdb.ColumnFamilyHandle columnFamily)
ZbRocksIterator	newIterator(org.rocksdb.ColumnFamilyHandle columnFamily, org.rocksdb.ReadOptions readOptions)
static ZbRocksDb	open(org.rocksdb.DBOptions options, String path, List<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors, List<org.rocksdb.ColumnFamilyHandle> columnFamilyHandles)
static ZbRocksDb	open(org.rocksdb.Options options, String path)
void	put(org.rocksdb.ColumnFamilyHandle columnFamily, byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
void	put(org.rocksdb.ColumnFamilyHandle columnFamily, org.agrona.DirectBuffer key, org.agrona.DirectBuffer value)

Methods inherited from class org.rocksdb.RocksDB

compactRange, compactRange, compactRange, compactRange, compactRange, compactRange, compactRange, compactRange, continueBackgroundWork, createColumnFamily, delete, delete, delete, delete, delete, delete, delete, delete, deleteRange, deleteRange, deleteRange, deleteRange, deleteRange, deleteRange, deleteRange, deleteRange, destroyDB, disableFileDeletions, disposeInternal, dropColumnFamily, enableFileDeletions, flush, flush, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getDefaultColumnFamily, getLatestSequenceNumber, getLongProperty, getLongProperty, getLongProperty, getLongProperty, getProperty, getProperty, getProperty0, getProperty0, getSnapshot, getSnapshot, getUpdatesSince, ingestExternalFile, ingestExternalFile, iterator, iterator, iteratorCF, iteratorCF, iterators, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, listColumnFamilies, listColumnFamilies, loadLibrary, loadLibrary, merge, merge, merge, merge, merge, merge, merge, merge, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, newIterator, newIterators, newIterators, open, open, open, open, openReadOnly, openReadOnly, openReadOnly, openReadOnly, openROnly, openROnly, pauseBackgroundWork, put, put, put, put, put, put, put, put, releaseSnapshot, releaseSnapshot, remove, remove, remove, remove, setOptions, singleDelete, singleDelete, singleDelete, singleDelete, singleDelete, singleDelete, singleDelete, singleDelete, storeOptionsInstance, write, write, write0, write1

Methods inherited from class org.rocksdb.RocksObject

disposeInternal

Methods inherited from class org.rocksdb.AbstractImmutableNativeReference

close, disOwnNativeHandle, isOwningHandle

Methods inherited from class org.rocksdb.AbstractNativeReference

dispose, finalize

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ZbRocksDb

protected ZbRocksDb(long nativeHandle)

Method Detail

open

public static ZbRocksDb open(org.rocksdb.Options options,
                             String path)
                      throws org.rocksdb.RocksDBException

Throws:

org.rocksdb.RocksDBException

open

public static ZbRocksDb open(org.rocksdb.DBOptions options,
                             String path,
                             List<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors,
                             List<org.rocksdb.ColumnFamilyHandle> columnFamilyHandles)
                      throws org.rocksdb.RocksDBException

Throws:

org.rocksdb.RocksDBException

put

public void put(org.rocksdb.ColumnFamilyHandle columnFamily,
                byte[] key,
                int keyOffset,
                int keyLength,
                byte[] value,
                int valueOffset,
                int valueLength)

put

public void put(org.rocksdb.ColumnFamilyHandle columnFamily,
                org.agrona.DirectBuffer key,
                org.agrona.DirectBuffer value)

get

public int get(org.rocksdb.ColumnFamilyHandle columnFamily,
               byte[] key,
               int keyOffset,
               int keyLength,
               byte[] value,
               int valueOffset,
               int valueLength)

get

public int get(org.rocksdb.ColumnFamilyHandle columnFamily,
               org.agrona.DirectBuffer key,
               org.agrona.MutableDirectBuffer value)

get

public int get(org.rocksdb.ColumnFamilyHandle columnFamily,
               long key,
               org.agrona.MutableDirectBuffer value)

delete

public void delete(org.rocksdb.ColumnFamilyHandle columnFamily,
                   byte[] key,
                   int keyOffset,
                   int keyLength)

delete

public void delete(org.rocksdb.ColumnFamilyHandle columnFamily,
                   org.agrona.DirectBuffer key)

exists

public boolean exists(org.rocksdb.ColumnFamilyHandle columnFamily,
                      byte[] key,
                      int keyOffset,
                      int keyLength)

exists

public boolean exists(org.rocksdb.ColumnFamilyHandle columnFamily,
                      org.agrona.DirectBuffer key)

exists

public boolean exists(org.rocksdb.ColumnFamilyHandle columnFamily,
                      org.agrona.DirectBuffer key,
                      org.agrona.MutableDirectBuffer value)

Allows doing an exist call and getting the value back (since it has to be read anyway) if it does.

NOTE: creates garbage by allocating a new string builder, which will then allocate a new string before filling the value buffer.

Parameters:

columnFamily - column family to look into

key - the key to look for

value - a buffer which will be filled with the value if it exists

Returns:

true or false

forEachPrefixed

public void forEachPrefixed(org.rocksdb.ColumnFamilyHandle columnFamily,
                            org.agrona.DirectBuffer prefix,
                            ZbRocksDb.IteratorCallback callback)

NOTE: it doesn't seem possible in Java RocksDB to set a flexible prefix extractor on iterators at the moment, so using prefixes seem to be mostly related to skipping files that do not contain keys with the given prefix (which is useful anyway), but it will still iterate over all keys contained in those files, so we still need to make sure the key actually matches the prefix. Or I misunderstood how to do it, which is equally as likely.

My understanding is seek(prefix) simply positions the cursor to the first key (allowing to skip previous keys), but while iterating over subsequent keys we have to validate it.

forEach

public void forEach(org.rocksdb.ColumnFamilyHandle columnFamily,
                    ZbRocksDb.IteratorCallback callback)

list

public List<ZbRocksEntry> list(org.rocksdb.ColumnFamilyHandle columnFamily)

NOTE: not recommended for production use, since it loads all key/values into memory, but it's very useful for debugging.

Parameters:

columnFamily - the column family to list all entries for

Returns:

a list of all entries in the database

newIterator

public ZbRocksIterator newIterator()

Overrides:

newIterator in class org.rocksdb.RocksDB

newIterator

public ZbRocksIterator newIterator(org.rocksdb.ColumnFamilyHandle columnFamily)

Overrides:

newIterator in class org.rocksdb.RocksDB

newIterator

public ZbRocksIterator newIterator(org.rocksdb.ColumnFamilyHandle columnFamily,
                                   org.rocksdb.ReadOptions readOptions)

Overrides:

newIterator in class org.rocksdb.RocksDB