Class RocksDbStore

java.lang.Object

org.tasktide.itemstore.AbstractItemStore

org.tasktide.itemstore.RocksDbStore

All Implemented Interfaces:

ItemStore

public class RocksDbStore
extends AbstractItemStore

Use RocksDB as storage backend

Field Summary

Fields

Modifier and Type	Field	Description
protected org.rocksdb.RocksDB	master
protected org.rocksdb.RocksDB	proto

Fields inherited from class AbstractItemStore

dbDirectory, lockStrategy, masterDB, protoDB, storeName

Constructor Summary

Constructors

Constructor	Description
RocksDbStore(String storeName, String dbDirectory)	Connect to DB
RocksDbStore(String storeName, String dbDirectory, String masterDB, String protoDB)	Connect to DB

Method Summary

Modifier and Type	Method	Description
boolean	closeMaster()	Closes connection against master DB
boolean	closePrototoype()	Closes connection against prototype DB
boolean	delete(DbTarget target, Item item)	Delete Item from prototype
<T> T	execute(DbTarget target, Map<String, ItemStore> recipients, LinkedOperationMap<T> operations)	Donates active ItemStore mutex acquisition to provided recipients for provided operation set
<T> T	execute(DbTarget target, ItemStore recipientStore, LinkedOperation<T> linkedOperations)	Performs a set of LinkedOperation over active, and recipient ItemStore.
<T> T	execute(DbTarget target, BulkOperation<T> operationSet)	Performs a set of operations over an ItemStoreSession
org.rocksdb.RocksIterator	fetchIter(org.rocksdb.RocksDB db)	Fetch iterator from db
Item	fetchIteratorValue(org.rocksdb.RocksIterator iter)	Fetch active value from RocksIterator as an Item
List<Item>	getAll(DbTarget target)	Fetch all records from either Master (true), or Cache (False)
Item	getById(DbTarget target, String id)	Fetch the Item with provided Id from cache
protected <T> T	getConnection(DbTarget target, Class<T> type)	Get RocksDB get connection
List<Item>	getItemsByState(DbTarget target, String state)	Fetch item by state from master
String	getPayloadById(DbTarget target, String id)	Fetch payload for queried Item from cache
boolean	isClosed(DbTarget target)	Checks if Master/Prototype are open
boolean	isOpen(DbTarget target)	Checks if Master/Prototype are open
boolean	openMaster()	Open connection master connection
boolean	openPrototoype()	Open connection prototype connection
void	putItem(org.rocksdb.RocksDB db, byte[] key, byte[] value)	Put data in target DB
void	saveItem(DbTarget target, Item item)	Save item to cached RocksDB, connection and lock lifecycles orchestrated by AbstractItemStore
void	saveItems(DbTarget target, List<Item> items)	Import Item list to cached DB
boolean	update(DbTarget target, Item item)	Update by dropping and inserting

Methods inherited from class AbstractItemStore

cacheMaster, clearPrototype, closeConn, getDbDirectory, getFilePath, getMasterFilePath, getStoreName, openConn, syncToMaster, syncToMaster, syncToMaster, withLockedConnection, withLockedConnectionUnchecked

Methods inherited from class Object

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

Field Details

master

protected org.rocksdb.RocksDB master

proto

protected org.rocksdb.RocksDB proto

Constructor Details

RocksDbStore

public RocksDbStore(String storeName,
 String dbDirectory,
 String masterDB,
 String protoDB)

Connect to DB

Parameters:

storeName -

dbDirectory -

masterDB -

protoDB -

RocksDbStore

public RocksDbStore(String storeName,
 String dbDirectory)

Connect to DB

Parameters:

storeName -

dbDirectory -

Method Details

getConnection

protected <T> T getConnection(DbTarget target,
 Class<T> type)

Get RocksDB get connection

Specified by:

getConnection in class AbstractItemStore

Type Parameters:

T -

Parameters:

target -

type - SqliteStore | RocksDbStore

Returns:

RocksDB

fetchIteratorValue

public Item fetchIteratorValue(org.rocksdb.RocksIterator iter)

Fetch active value from RocksIterator as an Item

Parameters:

iter -

Returns:

Item

fetchIter

public org.rocksdb.RocksIterator fetchIter(org.rocksdb.RocksDB db)

Fetch iterator from db

Parameters:

db -

Returns:

RocksIterator

putItem

public void putItem(org.rocksdb.RocksDB db,
 byte[] key,
 byte[] value)
             throws ItemStoreCheckedException

Put data in target DB

Parameters:

db -

key -

value -

Throws:

ItemStoreCheckedException

getAll

public List<Item> getAll(DbTarget target)
                  throws ItemStoreUncheckedException

Fetch all records from either Master (true), or Cache (False)

Parameters:

target -

Returns:

List-Item

Throws:

ItemStoreUncheckedException

saveItem

public void saveItem(DbTarget target,
 Item item)
              throws ItemStoreCheckedException

Save item to cached RocksDB, connection and lock lifecycles orchestrated by AbstractItemStore

Parameters:

target -

item -

Throws:

ItemStoreCheckedException

update

public boolean update(DbTarget target,
 Item item)

Update by dropping and inserting

Parameters:

target -

item -

Returns:

boolean

saveItems

public void saveItems(DbTarget target,
 List<Item> items)
               throws ItemStoreCheckedException

Import Item list to cached DB

Parameters:

target -

items -

Throws:

ItemStoreCheckedException

getById

public Item getById(DbTarget target,
 String id)
             throws ItemStoreCheckedException

Fetch the Item with provided Id from cache

Parameters:

target -

id -

Returns:

Throws:

Exception

ItemStoreCheckedException

getItemsByState

public List<Item> getItemsByState(DbTarget target,
 String state)
                           throws ItemStoreCheckedException

Fetch item by state from master

Parameters:

target -

state -

Returns:

List-Item

Throws:

ItemStoreCheckedException

getPayloadById

public String getPayloadById(DbTarget target,
 String id)

Fetch payload for queried Item from cache

Parameters:

target -

id -

Returns:

String

delete

public boolean delete(DbTarget target,
 Item item)
               throws ItemStoreCheckedException

Delete Item from prototype

Parameters:

target -

item -

Returns:

boolean

Throws:

ItemStoreCheckedException

isOpen

public boolean isOpen(DbTarget target)

Checks if Master/Prototype are open

Parameters:

target -

Returns:

boolean

isClosed

public boolean isClosed(DbTarget target)

Checks if Master/Prototype are open

Parameters:

target -

Returns:

boolean

openMaster

public boolean openMaster()

Open connection master connection

Returns:

boolean

closeMaster

public boolean closeMaster()

Closes connection against master DB

Returns:

boolean

openPrototoype

public boolean openPrototoype()

Open connection prototype connection

Returns:

boolean

closePrototoype

public boolean closePrototoype()

Closes connection against prototype DB

Returns:

boolean

execute

public <T> T execute(DbTarget target,
 BulkOperation<T> operationSet)
              throws ItemStoreCheckedException

Performs a set of operations over an ItemStoreSession

Type Parameters:

T -

Parameters:

target -

operationSet -

Returns:

T

Throws:

ItemStoreCheckedException

execute

public <T> T execute(DbTarget target,
 ItemStore recipientStore,
 LinkedOperation<T> linkedOperations)
              throws ItemStoreCheckedException

Performs a set of LinkedOperation over active, and recipient ItemStore. Under the mutex of the calling ItemStore, hence provided ItemStore referred to as a recipient of the stores mutex

Type Parameters:

T -

Parameters:

target -

recipientStore -

linkedOperations -

Returns:

of T

Throws:

ItemStoreCheckedException

execute

public <T> T execute(DbTarget target,
 Map<String, ItemStore> recipients,
 LinkedOperationMap<T> operations)
              throws ItemStoreCheckedException

Donates active ItemStore mutex acquisition to provided recipients for provided operation set

Type Parameters:

T -

Parameters:

target -

recipients -

operations -

Returns:

of T

Throws:

ItemStoreCheckedException