alluxio.master.metastore.rocks

Class RocksStore

java.lang.Object

alluxio.master.metastore.rocks.RocksStore

All Implemented Interfaces:

Closeable, AutoCloseable

@ThreadSafe
public final class RocksStore
extends Object
implements Closeable

Class for managing a rocksdb database. This class handles common functionality such as initializing the database and performing database backup/restore. Thread safety is achieved by synchronizing all public methods.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ROCKS_OPEN_RETRY_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
RocksStore(String name, String dbPath, String checkpointPath, org.rocksdb.DBOptions dbOpts, Collection<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors, List<AtomicReference<org.rocksdb.ColumnFamilyHandle>> columnHandles)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears and re-initializes the database.
void	close()
org.rocksdb.RocksDB	getDb()
void	restoreFromCheckpoint(CheckpointInputStream input) Restores the database from a checkpoint.
void	writeToCheckpoint(OutputStream output) Writes a checkpoint of the database's content to the given output stream.

Methods inherited from class java.lang.Object

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

Field Detail

ROCKS_OPEN_RETRY_TIMEOUT

public static final int ROCKS_OPEN_RETRY_TIMEOUT

See Also:

Constant Field Values

Constructor Detail

RocksStore

public RocksStore(String name,
                  String dbPath,
                  String checkpointPath,
                  org.rocksdb.DBOptions dbOpts,
                  Collection<org.rocksdb.ColumnFamilyDescriptor> columnFamilyDescriptors,
                  List<AtomicReference<org.rocksdb.ColumnFamilyHandle>> columnHandles)

Parameters:

name - a name to distinguish what store this is

dbPath - a path for the rocks database

checkpointPath - a path for taking database checkpoints

dbOpts - the configured RocksDB options

columnFamilyDescriptors - columns to create within the rocks database

columnHandles - column handle references to populate

Method Detail

getDb

public org.rocksdb.RocksDB getDb()

Returns:

the underlying rocksdb instance. The instance changes when clear() is called, so if the caller caches the returned db, they must reset it after calling clear()

clear

public void clear()

Clears and re-initializes the database.

writeToCheckpoint

public void writeToCheckpoint(OutputStream output)
                       throws IOException,
                              InterruptedException

Writes a checkpoint of the database's content to the given output stream.

Parameters:

output - the stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

public void restoreFromCheckpoint(CheckpointInputStream input)
                           throws IOException

Restores the database from a checkpoint.

Parameters:

input - the checkpoint stream to restore from

Throws:

IOException

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable