io.permazen.kv.rocksdb

Class RocksDBKVStore

java.lang.Object

io.permazen.kv.AbstractKVStore

io.permazen.kv.rocksdb.RocksDBKVStore

All Implemented Interfaces:

CloseableKVStore, KVStore, Closeable, AutoCloseable

Direct Known Subclasses:

SnapshotRocksDBKVStore

public class RocksDBKVStore
extends AbstractKVStore
implements CloseableKVStore

Straightforward KVStore view of a RocksDB database.

Instances must be close()'d when no longer needed to avoid leaking resources associated with iterators.

Constructor Summary

Constructors

Constructor and Description
RocksDBKVStore(org.rocksdb.RocksDB db) Convenience constructor.
RocksDBKVStore(org.rocksdb.RocksDB db, org.rocksdb.ReadOptions readOptions, org.rocksdb.WriteBatch writeBatch) Constructor.

Method Summary

Modifier and Type	Method and Description
void	adjustCounter(byte[] key, long amount)
void	close() Close this instance.
long	decodeCounter(byte[] value)
byte[]	encodeCounter(long value)
protected void	finalize() Finalize this instance.
byte[]	get(byte[] key)
org.rocksdb.RocksDB	getDB() Get the RocksDB underlying this instance.
CloseableIterator<KVPair>	getRange(byte[] minKey, byte[] maxKey, boolean reverse)
void	put(byte[] key, byte[] value)
void	remove(byte[] key)
String	toString()

Methods inherited from class io.permazen.kv.AbstractKVStore

getAtLeast, getAtMost, removeRange

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.permazen.kv.KVStore

apply, getAtLeast, getAtMost, getRange, getRange, removeRange, removeRange

Constructor Detail

RocksDBKVStore

public RocksDBKVStore(org.rocksdb.RocksDB db)

Convenience constructor. Uses default read options and no write batching.

Parameters:

db - database

RocksDBKVStore

public RocksDBKVStore(org.rocksdb.RocksDB db,
                      org.rocksdb.ReadOptions readOptions,
                      org.rocksdb.WriteBatch writeBatch)

Constructor.

The caller is responsible for invoking close() on any supplied readOptions and/or writeBatch, after this instance is close()'d of course.

Parameters:

db - database

readOptions - read options, or null for the default

writeBatch - batch for write operations, or null for none

Throws:

IllegalArgumentException - if db is null

Method Detail

getDB

public org.rocksdb.RocksDB getDB()

Get the RocksDB underlying this instance.

Returns:

underlying database

get

public byte[] get(byte[] key)

Specified by:

get in interface KVStore

Overrides:

get in class AbstractKVStore

getRange

public CloseableIterator<KVPair> getRange(byte[] minKey,
                                          byte[] maxKey,
                                          boolean reverse)

Specified by:

getRange in interface KVStore

put

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

Specified by:

put in interface KVStore

Overrides:

put in class AbstractKVStore

remove

public void remove(byte[] key)

Specified by:

remove in interface KVStore

Overrides:

remove in class AbstractKVStore

encodeCounter

public byte[] encodeCounter(long value)

Specified by:

encodeCounter in interface KVStore

Overrides:

encodeCounter in class AbstractKVStore

decodeCounter

public long decodeCounter(byte[] value)

Specified by:

decodeCounter in interface KVStore

Overrides:

decodeCounter in class AbstractKVStore

adjustCounter

public void adjustCounter(byte[] key,
                          long amount)

Specified by:

adjustCounter in interface KVStore

Overrides:

adjustCounter in class AbstractKVStore

finalize

protected void finalize()
                 throws Throwable

Finalize this instance. Invokes close() to close any unclosed iterators.

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object

close

public void close()

Close this instance.

This closes any unclosed iterators returned from getRange(). This does not close the underlying RocksDB or any associated WriteBatch.

Specified by:

close in interface CloseableKVStore

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable