org.apache.hudi.common.util.collection

Class RocksDBDAO

java.lang.Object

org.apache.hudi.common.util.collection.RocksDBDAO

public class RocksDBDAO
extends Object

Data access objects for storing and retrieving objects in Rocks DB.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RocksDBDAO.BatchHandler Functional interface for stacking operation to Write batch.

Constructor Summary

Constructors

Constructor and Description
RocksDBDAO(String basePath, String rocksDBBasePath)

Method Summary

Modifier and Type	Method and Description
void	addColumnFamily(String columnFamilyName) Add a new column family to store.
void	close() Close the DAO object.
<K extends Serializable> void	delete(String columnFamilyName, K key) Perform a single Delete operation.
void	delete(String columnFamilyName, String key) Perform a single Delete operation.
<K extends Serializable> void	deleteInBatch(org.rocksdb.WriteBatch batch, String columnFamilyName, K key) Helper to add delete operation in batch.
void	deleteInBatch(org.rocksdb.WriteBatch batch, String columnFamilyName, String key) Helper to add delete operation in batch.
void	dropColumnFamily(String columnFamilyName) Note : Does not delete from underlying DB.
<K extends Serializable,T extends Serializable> T	get(String columnFamilyName, K key) Retrieve a value for a given key in a column family.
<T extends Serializable> T	get(String columnFamilyName, String key) Retrieve a value for a given key in a column family.
long	getTotalBytesWritten()
<T extends Serializable> Iterator<T>	iterator(String columnFamilyName) Return Iterator of key-value pairs from RocksIterator.
<T extends Serializable> void	prefixDelete(String columnFamilyName, String prefix) Perform a prefix delete and return stream of key-value pairs retrieved.
<T extends Serializable> Stream<Pair<String,T>>	prefixSearch(String columnFamilyName, String prefix) Perform a prefix search and return stream of key-value pairs retrieved.
<K extends Serializable,T extends Serializable> void	put(String columnFamilyName, K key, T value) Perform single PUT on a column-family.
<T extends Serializable> void	put(String columnFamilyName, String key, T value) Perform single PUT on a column-family.
<K extends Serializable,T extends Serializable> void	putInBatch(org.rocksdb.WriteBatch batch, String columnFamilyName, K key, T value) Helper to add put operation in batch.
<T extends Serializable> void	putInBatch(org.rocksdb.WriteBatch batch, String columnFamilyName, String key, T value) Helper to add put operation in batch.
void	writeBatch(RocksDBDAO.BatchHandler handler) Perform a batch write operation.

Methods inherited from class java.lang.Object

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

Constructor Detail

RocksDBDAO

public RocksDBDAO(String basePath,
                  String rocksDBBasePath)

Method Detail

writeBatch

public void writeBatch(RocksDBDAO.BatchHandler handler)

Perform a batch write operation.

putInBatch

public <T extends Serializable> void putInBatch(org.rocksdb.WriteBatch batch,
                                                String columnFamilyName,
                                                String key,
                                                T value)

Helper to add put operation in batch.

Type Parameters:

T - Type of payload

Parameters:

batch - Batch Handle

columnFamilyName - Column Family

key - Key

value - Payload

putInBatch

public <K extends Serializable,T extends Serializable> void putInBatch(org.rocksdb.WriteBatch batch,
                                                                       String columnFamilyName,
                                                                       K key,
                                                                       T value)

Helper to add put operation in batch.

Type Parameters:

T - Type of payload

Parameters:

batch - Batch Handle

columnFamilyName - Column Family

key - Key

value - Payload

put

public <T extends Serializable> void put(String columnFamilyName,
                                         String key,
                                         T value)

Perform single PUT on a column-family.

Type Parameters:

T - Type of Payload

Parameters:

columnFamilyName - Column family name

key - Key

value - Payload

put

public <K extends Serializable,T extends Serializable> void put(String columnFamilyName,
                                                                K key,
                                                                T value)

Perform single PUT on a column-family.

Type Parameters:

T - Type of Payload

Parameters:

columnFamilyName - Column family name

key - Key

value - Payload

deleteInBatch

public void deleteInBatch(org.rocksdb.WriteBatch batch,
                          String columnFamilyName,
                          String key)

Helper to add delete operation in batch.

Parameters:

batch - Batch Handle

columnFamilyName - Column Family

key - Key

deleteInBatch

public <K extends Serializable> void deleteInBatch(org.rocksdb.WriteBatch batch,
                                                   String columnFamilyName,
                                                   K key)

Helper to add delete operation in batch.

Parameters:

batch - Batch Handle

columnFamilyName - Column Family

key - Key

delete

public void delete(String columnFamilyName,
                   String key)

Perform a single Delete operation.

Parameters:

columnFamilyName - Column Family name

key - Key to be deleted

delete

public <K extends Serializable> void delete(String columnFamilyName,
                                            K key)

Perform a single Delete operation.

Parameters:

columnFamilyName - Column Family name

key - Key to be deleted

get

public <T extends Serializable> T get(String columnFamilyName,
                                      String key)

Retrieve a value for a given key in a column family.

Type Parameters:

T - Type of object stored.

Parameters:

columnFamilyName - Column Family Name

key - Key to be retrieved

get

public <K extends Serializable,T extends Serializable> T get(String columnFamilyName,
                                                             K key)

Retrieve a value for a given key in a column family.

Type Parameters:

T - Type of object stored.

Parameters:

columnFamilyName - Column Family Name

key - Key to be retrieved

prefixSearch

public <T extends Serializable> Stream<Pair<String,T>> prefixSearch(String columnFamilyName,
                                                                    String prefix)

Perform a prefix search and return stream of key-value pairs retrieved.

Type Parameters:

T - Type of value stored

Parameters:

columnFamilyName - Column Family Name

prefix - Prefix Key

iterator

public <T extends Serializable> Iterator<T> iterator(String columnFamilyName)

Return Iterator of key-value pairs from RocksIterator.

Type Parameters:

T - Type of value stored

Parameters:

columnFamilyName - Column Family Name

prefixDelete

public <T extends Serializable> void prefixDelete(String columnFamilyName,
                                                  String prefix)

Perform a prefix delete and return stream of key-value pairs retrieved.

Type Parameters:

T - Type of value stored

Parameters:

columnFamilyName - Column Family Name

prefix - Prefix Key

addColumnFamily

public void addColumnFamily(String columnFamilyName)

Add a new column family to store.

Parameters:

columnFamilyName - Column family name

dropColumnFamily

public void dropColumnFamily(String columnFamilyName)

Note : Does not delete from underlying DB. Just closes the handle.

Parameters:

columnFamilyName - Column Family Name

close

public void close()

Close the DAO object.

getTotalBytesWritten

public long getTotalBytesWritten()