org.yamcs.yarch.rocksdb

Class RDBFactory

java.lang.Object

org.yamcs.yarch.rocksdb.RDBFactory

All Implemented Interfaces:

Runnable

public class RDBFactory
extends Object
implements Runnable

manufacturer of RDB databases. It runs a thread that synchronises them from time to time and closes those that have not been used in a while

Author:

nm

Field Summary

Fields

Modifier and Type	Field and Description
static org.rocksdb.FlushOptions	flushOptions

Method Summary

Modifier and Type	Method and Description
void	close(YRDB yrdb) immediately closes the database
void	closeIfOpen(String absolutePath) Close the DB if open (called when dropping the table)
void	delete(String file)
void	dispose(YRDB rdb)
CompletableFuture<Void>	doBackup(String dbpath, String backupDir) Performs a backup of the database to the given directory
static RDBFactory	getInstance(String instance)
List<String>	getOpenDbPaths()
YRDB	getOpenRdb(String absolutePath) Get the database which is already open or null if it is not open
YRDB	getRdb(String absolutePath, boolean readonly) Opens or create a database.
YRDB	getRdb(String absolutePath, int prefixSize, boolean readonly)
CompletableFuture<Void>	restoreBackup(int backupId, String backupDir, String dbPath)
CompletableFuture<Void>	restoreBackup(String backupDir, String dbPath)
void	run()

Methods inherited from class java.lang.Object

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

Field Detail

flushOptions

public static org.rocksdb.FlushOptions flushOptions

Method Detail

getInstance

public static RDBFactory getInstance(String instance)

getRdb

public YRDB getRdb(String absolutePath,
                   boolean readonly)
            throws IOException

Opens or create a database.

Parameters:

absolutePath - - absolute path - should be a directory

readonly - - open in readonly mode; if the database is open in readwrite mode, it will be returned like that

Returns:

the database created or opened

Throws:

IOException

getRdb

public YRDB getRdb(String absolutePath,
                   int prefixSize,
                   boolean readonly)
            throws IOException

Throws:

IOException

delete

public void delete(String file)

run

public void run()

Specified by:

run in interface Runnable

dispose

public void dispose(YRDB rdb)

closeIfOpen

public void closeIfOpen(String absolutePath)

Close the DB if open (called when dropping the table)

Parameters:

absolutePath -

getOpenRdb

public YRDB getOpenRdb(String absolutePath)

Get the database which is already open or null if it is not open

Parameters:

absolutePath - the absoulte path of the database to be returned

Returns:

the database object

getOpenDbPaths

public List<String> getOpenDbPaths()

close

public void close(YRDB yrdb)

immediately closes the database

Parameters:

yrdb -

doBackup

public CompletableFuture<Void> doBackup(String dbpath,
                                        String backupDir)

Performs a backup of the database to the given directory

Parameters:

dbpath -

backupDir -

Returns:

a future that can be used to know when the backup has finished and if there was any error

restoreBackup

public CompletableFuture<Void> restoreBackup(String backupDir,
                                             String dbPath)

restoreBackup

public CompletableFuture<Void> restoreBackup(int backupId,
                                             String backupDir,
                                             String dbPath)