io.permazen.kv.rocksdb

Class RocksDBAtomicKVStore

java.lang.Object

io.permazen.kv.util.ForwardingKVStore

io.permazen.kv.rocksdb.RocksDBAtomicKVStore

All Implemented Interfaces:

KVStore, AtomicKVStore

public class RocksDBAtomicKVStore
extends ForwardingKVStore
implements AtomicKVStore

An AtomicKVStore view of a RocksDB database.

A database directory is the only required configuration property. Instances may be stopped and (re)started multiple times.

Constructor Summary

Constructors

Constructor and Description
RocksDBAtomicKVStore() Constructor.

Method Summary

Modifier and Type	Method and Description
protected RocksDBKVStore	delegate()
protected void	finalize() Finalize this instance.
org.rocksdb.RocksDB	getDB() Get the underlying RocksDB associated with this instance.
File	getDirectory() Get the filesystem directory containing the database.
org.rocksdb.Options	getOptions() Get the Options this instance will use when opening the database at startup.
void	mutate(Mutations mutations, boolean sync)
void	setDirectory(File directory) Configure the filesystem directory containing the database.
void	setOptions(org.rocksdb.Options options) Set the Options this instance will use when opening the database at startup.
SnapshotRocksDBKVStore	snapshot()
void	start()
void	stop()
String	toString()

Methods inherited from class io.permazen.kv.util.ForwardingKVStore

adjustCounter, apply, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, put, remove, 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

adjustCounter, apply, decodeCounter, encodeCounter, get, getAtLeast, getAtMost, getRange, getRange, getRange, put, remove, removeRange, removeRange

Constructor Detail

RocksDBAtomicKVStore

public RocksDBAtomicKVStore()

Constructor.

Method Detail

getDirectory

public File getDirectory()

Get the filesystem directory containing the database.

Returns:

database directory

setDirectory

public void setDirectory(File directory)

Configure the filesystem directory containing the database. Required property.

Parameters:

directory - database directory

Throws:

IllegalStateException - if this instance is already start()ed

getDB

public org.rocksdb.RocksDB getDB()

Get the underlying RocksDB associated with this instance.

Returns:

the associated RocksDB

Throws:

IllegalStateException - if this instance is not start()ed

getOptions

public org.rocksdb.Options getOptions()

Get the Options this instance will use when opening the database at startup.

Returns:

database options

setOptions

public void setOptions(org.rocksdb.Options options)

Set the Options this instance will use when opening the database at startup. Overwrites any previous options configuration(s).

Parameters:

options - database options

Throws:

IllegalArgumentException - if options is null

IllegalStateException - if this instance is already start()ed

start

@PostConstruct
public void start()

Specified by:

start in interface AtomicKVStore

stop

@PreDestroy
public void stop()

Specified by:

stop in interface AtomicKVStore

delegate

protected RocksDBKVStore delegate()

Specified by:

delegate in class ForwardingKVStore

snapshot

public SnapshotRocksDBKVStore snapshot()

Specified by:

snapshot in interface AtomicKVStore

mutate

public void mutate(Mutations mutations,
                   boolean sync)

Specified by:

mutate in interface AtomicKVStore

finalize

protected void finalize()
                 throws Throwable

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

Overrides:

finalize in class Object

Throws:

Throwable

toString

public String toString()

Overrides:

toString in class Object