io.zeebe.logstreams.state

Class StateController

java.lang.Object

io.zeebe.logstreams.state.StateController

All Implemented Interfaces:

AutoCloseable

public class StateController
extends Object
implements AutoCloseable

Controls opening, closing, and managing of RocksDB associated resources. Could be argued that db reference should not be made transparent, as it could be closed on its own elsewhere, but for now it's easier.

Current suggested method of customizing RocksDB instance per stream processor is to subclass this class and to override the protected methods to your liking.

Another option would be to use a Builder class and make StateController entirely controlled through its properties.

Field Summary

Fields

Modifier and Type	Field and Description
protected List<AutoCloseable>	closeables
protected List<org.rocksdb.ColumnFamilyDescriptor>	columnFamilyDescriptors
protected List<org.rocksdb.ColumnFamilyHandle>	columnFamilyHandles
protected File	dbDirectory

Constructor Summary

Constructors

Constructor and Description
StateController()

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.rocksdb.ColumnFamilyOptions	createColumnFamilyOptions()
protected org.rocksdb.Options	createOptions()
void	delete()
void	delete(byte[] key)
void	delete(File dbDirectory)
void	delete(long key)
protected void	ensureIsOpened(String operation)
boolean	exist(org.rocksdb.ColumnFamilyHandle handle, byte[] key, int offset, int length)
void	foreach(org.rocksdb.ColumnFamilyHandle handle, java.util.function.BiConsumer<byte[],byte[]> keyValueConsumer)
int	get(byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
int	get(org.rocksdb.ColumnFamilyHandle columnFamilyHandle, byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
int	get(org.rocksdb.ColumnFamilyHandle columnFamilyHandle, long key, byte[] value, int valueOffset, int valueLength)
byte[]	get(long key) !creates garbage!
org.rocksdb.ColumnFamilyHandle	getColumnFamilyHandle(byte[] name)
org.rocksdb.RocksDB	getDb()
protected org.rocksdb.Env	getDbEnv()
boolean	isOpened()
org.rocksdb.RocksDB	open(File dbDirectory, boolean reopen)
protected org.rocksdb.RocksDB	open(File dbDirectory, boolean reopen, List<byte[]> columnFamilyNames)
protected org.rocksdb.RocksDB	openDb(org.rocksdb.DBOptions dbOptions)
protected org.rocksdb.RocksDB	openDb(org.rocksdb.Options options)
void	put(byte[] key, byte[] valueBuffer)
void	put(byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
void	put(org.rocksdb.ColumnFamilyHandle handle, byte[] key, int keyOffset, int keyLength, byte[] value, int valueOffset, int valueLength)
void	put(org.rocksdb.ColumnFamilyHandle handle, long key, byte[] value, int valueOffset, int valueLength)
void	put(long key, BufferWriter valueWriter) *creates garbage*
void	put(long key, byte[] valueBuffer)
void	put(long key, byte[] value, int valueOffset, int valueLength)
void	remove(byte[] key, int offset, int length)
void	remove(org.rocksdb.ColumnFamilyHandle handle, byte[] key, int offset, int length)
void	remove(org.rocksdb.ColumnFamilyHandle handle, long key)
void	removeEntriesWithPrefix(org.rocksdb.ColumnFamilyHandle handle, byte[] prefix, java.util.function.BiConsumer<byte[],byte[]> entryConsumer)
boolean	tryGet(byte[] keyBuffer, byte[] valueBuffer)
boolean	tryGet(long key, byte[] valueBuffer)
void	whileEqualPrefix(org.rocksdb.ColumnFamilyHandle handle, byte[] prefix, java.util.function.BiConsumer<byte[],byte[]> keyValueConsumer)
void	whileTrue(org.rocksdb.ColumnFamilyHandle handle, java.util.function.BiFunction<byte[],byte[],Boolean> keyValueConsumer)

Methods inherited from class java.lang.Object

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

Field Detail

dbDirectory

protected File dbDirectory

closeables

protected List<AutoCloseable> closeables

columnFamilyDescriptors

protected final List<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors

columnFamilyHandles

protected final List<org.rocksdb.ColumnFamilyHandle> columnFamilyHandles

Constructor Detail

StateController

public StateController()

Method Detail

open

public org.rocksdb.RocksDB open(File dbDirectory,
                                boolean reopen)
                         throws Exception

Throws:

Exception

openDb

protected org.rocksdb.RocksDB openDb(org.rocksdb.Options options)
                              throws org.rocksdb.RocksDBException

Throws:

org.rocksdb.RocksDBException

open

protected org.rocksdb.RocksDB open(File dbDirectory,
                                   boolean reopen,
                                   List<byte[]> columnFamilyNames)
                            throws Exception

Throws:

Exception

openDb

protected org.rocksdb.RocksDB openDb(org.rocksdb.DBOptions dbOptions)
                              throws org.rocksdb.RocksDBException

Throws:

org.rocksdb.RocksDBException

getColumnFamilyHandle

public org.rocksdb.ColumnFamilyHandle getColumnFamilyHandle(byte[] name)

createOptions

protected org.rocksdb.Options createOptions()

createColumnFamilyOptions

protected org.rocksdb.ColumnFamilyOptions createColumnFamilyOptions()

getDbEnv

protected org.rocksdb.Env getDbEnv()

ensureIsOpened

protected void ensureIsOpened(String operation)

isOpened

public boolean isOpened()

delete

public void delete()
            throws Exception

Throws:

Exception

delete

public void delete(File dbDirectory)
            throws Exception

Throws:

Exception

close

public void close()

Specified by:

close in interface AutoCloseable

getDb

public org.rocksdb.RocksDB getDb()

put

public void put(long key,
                byte[] valueBuffer)

put

public void put(org.rocksdb.ColumnFamilyHandle handle,
                long key,
                byte[] value,
                int valueOffset,
                int valueLength)

put

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

put

public void put(long key,
                byte[] value,
                int valueOffset,
                int valueLength)

put

public void put(byte[] key,
                int keyOffset,
                int keyLength,
                byte[] value,
                int valueOffset,
                int valueLength)

put

public void put(long key,
                BufferWriter valueWriter)

*creates garbage*

Parameters:

key -

valueWriter -

put

public void put(byte[] key,
                byte[] valueBuffer)

delete

public void delete(long key)

delete

public void delete(byte[] key)

get

public int get(byte[] key,
               int keyOffset,
               int keyLength,
               byte[] value,
               int valueOffset,
               int valueLength)

get

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

get

public int get(org.rocksdb.ColumnFamilyHandle columnFamilyHandle,
               long key,
               byte[] value,
               int valueOffset,
               int valueLength)

get

public byte[] get(long key)

!creates garbage!

Parameters:

key -

Returns:

tryGet

public boolean tryGet(long key,
                      byte[] valueBuffer)

tryGet

public boolean tryGet(byte[] keyBuffer,
                      byte[] valueBuffer)

exist

public boolean exist(org.rocksdb.ColumnFamilyHandle handle,
                     byte[] key,
                     int offset,
                     int length)

remove

public void remove(byte[] key,
                   int offset,
                   int length)

remove

public void remove(org.rocksdb.ColumnFamilyHandle handle,
                   byte[] key,
                   int offset,
                   int length)

remove

public void remove(org.rocksdb.ColumnFamilyHandle handle,
                   long key)

foreach

public void foreach(org.rocksdb.ColumnFamilyHandle handle,
                    java.util.function.BiConsumer<byte[],byte[]> keyValueConsumer)

removeEntriesWithPrefix

public void removeEntriesWithPrefix(org.rocksdb.ColumnFamilyHandle handle,
                                    byte[] prefix,
                                    java.util.function.BiConsumer<byte[],byte[]> entryConsumer)

whileEqualPrefix

public void whileEqualPrefix(org.rocksdb.ColumnFamilyHandle handle,
                             byte[] prefix,
                             java.util.function.BiConsumer<byte[],byte[]> keyValueConsumer)

whileTrue

public void whileTrue(org.rocksdb.ColumnFamilyHandle handle,
                      java.util.function.BiFunction<byte[],byte[],Boolean> keyValueConsumer)