Package org.apache.bookkeeper.bookie.storage.ldb

Class KeyValueStorageRocksDB

java.lang.Object

org.apache.bookkeeper.bookie.storage.ldb.KeyValueStorageRocksDB

All Implemented Interfaces:

Closeable, AutoCloseable, KeyValueStorage

public class KeyValueStorageRocksDB
extends Object
implements KeyValueStorage

RocksDB based implementation of the KeyValueStorage.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.bookkeeper.bookie.storage.ldb.KeyValueStorage

KeyValueStorage.Batch, KeyValueStorage.CloseableIterator<T>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static KeyValueStorageFactory	factory

Constructor Summary

Constructors

Constructor	Description
KeyValueStorageRocksDB(String basePath, String subPath, KeyValueStorageFactory.DbConfigType dbConfigType, ServerConfiguration conf)
KeyValueStorageRocksDB(String basePath, String subPath, KeyValueStorageFactory.DbConfigType dbConfigType, ServerConfiguration conf, boolean readOnly)

Method Summary

Modifier and Type	Method	Description
void	close()
void	compact()	Compact storage full range.
void	compact(byte[] firstKey, byte[] lastKey)	Compact storage within a specified range.
long	count()
(package private) org.rocksdb.RocksDB	db()
void	delete(byte[] key)
byte[]	get(byte[] key)	Get the value associated with the given key.
int	get(byte[] key, byte[] value)	Get the value associated with the given key.
Map.Entry<byte[],byte[]>	getCeil(byte[] key)	Get the entry whose key is bigger or equal the supplied key.
(package private) List<org.rocksdb.ColumnFamilyDescriptor>	getColumnFamilyDescriptors()
String	getDBPath()	Get storage path.
Map.Entry<byte[],byte[]>	getFloor(byte[] key)	Get the entry whose key is the biggest and it's lesser than the supplied key.
(package private) org.rocksdb.RocksObject	getOptions()
KeyValueStorage.CloseableIterator<Map.Entry<byte[],byte[]>>	iterator()	Return an iterator object that can be used to sequentially scan through all the entries in the database.
KeyValueStorage.CloseableIterator<byte[]>	keys()	Get an iterator over to scan sequentially through all the keys in the database.
KeyValueStorage.CloseableIterator<byte[]>	keys(byte[] firstKey, byte[] lastKey)	Get an iterator over to scan sequentially through all the keys within a specified range.
KeyValueStorage.Batch	newBatch()
void	put(byte[] key, byte[] value)
void	sync()	Commit all pending write to durable storage.

Methods inherited from class java.lang.Object

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

Field Details

factory

static KeyValueStorageFactory factory

Constructor Details

KeyValueStorageRocksDB

public KeyValueStorageRocksDB(String basePath,
 String subPath,
 KeyValueStorageFactory.DbConfigType dbConfigType,
 ServerConfiguration conf)
                       throws IOException

Throws:

IOException

KeyValueStorageRocksDB

public KeyValueStorageRocksDB(String basePath,
 String subPath,
 KeyValueStorageFactory.DbConfigType dbConfigType,
 ServerConfiguration conf,
 boolean readOnly)
                       throws IOException

Throws:

IOException

Method Details

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

put

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

Specified by:

put in interface KeyValueStorage

Throws:

IOException

get

public byte[] get(byte[] key)
           throws IOException

Description copied from interface: KeyValueStorage

Get the value associated with the given key.

Specified by:

get in interface KeyValueStorage

Parameters:

key - the key to lookup

Returns:

the value or null if the key was not found

Throws:

IOException

get

public int get(byte[] key,
 byte[] value)
        throws IOException

Description copied from interface: KeyValueStorage

Get the value associated with the given key.

This method will use the provided array store the value

Specified by:

get in interface KeyValueStorage

Parameters:

key - the key to lookup

value - an array where to store the result

Returns:

-1 if the entry was not found or the length of the value

Throws:

IOException - if the value array could not hold the result

getFloor

public Map.Entry<byte[],byte[]> getFloor(byte[] key)
                                  throws IOException

Description copied from interface: KeyValueStorage

Get the entry whose key is the biggest and it's lesser than the supplied key.

For example if the db contains :

 {
      1 : 'a',
      2 : 'b',
      3 : 'c'
 }
 

Then:

 getFloor(3) --> (2, 'b')
 

Specified by:

getFloor in interface KeyValueStorage

Parameters:

key - the non-inclusive upper limit key

Returns:

the entry before or null if there's no entry before key

Throws:

IOException

getCeil

public Map.Entry<byte[],byte[]> getCeil(byte[] key)
                                 throws IOException

Description copied from interface: KeyValueStorage

Get the entry whose key is bigger or equal the supplied key.

Specified by:

getCeil in interface KeyValueStorage

Returns:

Throws:

IOException

delete

public void delete(byte[] key)
            throws IOException

Specified by:

delete in interface KeyValueStorage

Throws:

IOException

getDBPath

public String getDBPath()

Description copied from interface: KeyValueStorage

Get storage path.

Specified by:

getDBPath in interface KeyValueStorage

compact

public void compact(byte[] firstKey,
 byte[] lastKey)
             throws IOException

Description copied from interface: KeyValueStorage

Compact storage within a specified range.

Specified by:

compact in interface KeyValueStorage

Parameters:

firstKey - the first key in the range (included)

lastKey - the last key in the range (not included)

Throws:

IOException

compact

public void compact()
             throws IOException

Description copied from interface: KeyValueStorage

Compact storage full range.

Specified by:

compact in interface KeyValueStorage

Throws:

IOException

sync

public void sync()
          throws IOException

Description copied from interface: KeyValueStorage

Commit all pending write to durable storage.

Specified by:

sync in interface KeyValueStorage

Throws:

IOException

keys

public KeyValueStorage.CloseableIterator<byte[]> keys()

Description copied from interface: KeyValueStorage

Get an iterator over to scan sequentially through all the keys in the database.

Specified by:

keys in interface KeyValueStorage

Returns:

keys

public KeyValueStorage.CloseableIterator<byte[]> keys(byte[] firstKey,
 byte[] lastKey)

Description copied from interface: KeyValueStorage

Get an iterator over to scan sequentially through all the keys within a specified range.

Specified by:

keys in interface KeyValueStorage

Parameters:

firstKey - the first key in the range (included)

lastKey - the lastKey in the range (not included)

iterator

public KeyValueStorage.CloseableIterator<Map.Entry<byte[],byte[]>> iterator()

Description copied from interface: KeyValueStorage

Return an iterator object that can be used to sequentially scan through all the entries in the database.

Specified by:

iterator in interface KeyValueStorage

count

public long count()
           throws IOException

Specified by:

count in interface KeyValueStorage

Returns:

the number of keys.

Throws:

IOException

newBatch

public KeyValueStorage.Batch newBatch()

Specified by:

newBatch in interface KeyValueStorage

db

org.rocksdb.RocksDB db()

getColumnFamilyDescriptors

List<org.rocksdb.ColumnFamilyDescriptor> getColumnFamilyDescriptors()

getOptions

org.rocksdb.RocksObject getOptions()