alluxio.rocks

Interface RocksCheckpointed

All Superinterfaces:

Checkpointed

All Known Implementing Classes:

RocksBlockMetaStore, RocksInodeStore

public interface RocksCheckpointed
extends Checkpointed

Provides default implementations for checkpointing RocksDB databases.

Field Summary

Fields inherited from interface alluxio.master.journal.checkpoint.Checkpointed

LOG

Method Summary

Modifier and Type	Method and Description
RocksStore	getRocksStore()
default void	restoreFromCheckpoint(CheckpointInputStream input) Restores state from a checkpoint.
default CompletableFuture<Void>	restoreFromCheckpoint(File directory, ExecutorService executorService) Restores state from a checkpoint asynchronously.
default CompletableFuture<Void>	writeToCheckpoint(File directory, ExecutorService executorService) Writes a checkpoint to the specified directory asynchronously using the provided executor.
default void	writeToCheckpoint(OutputStream output) Writes a checkpoint of all state to the given output stream.

Methods inherited from interface alluxio.master.journal.checkpoint.Checkpointed

getCheckpointName

Method Detail

getRocksStore

RocksStore getRocksStore()

Returns:

the RocksStore that will produce a checkpoint

writeToCheckpoint

default CompletableFuture<Void> writeToCheckpoint(File directory,
                                                  ExecutorService executorService)

Description copied from interface: Checkpointed

Writes a checkpoint to the specified directory asynchronously using the provided executor.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

directory - where the checkpoint will be written

executorService - to use when running tasks asynchronously

Returns:

a future that processes the computation

writeToCheckpoint

default void writeToCheckpoint(OutputStream output)
                        throws IOException,
                               InterruptedException

Description copied from interface: Checkpointed

Writes a checkpoint of all state to the given output stream. Implementations should make an effort to throw InterruptedException if they get interrupted while running.

Specified by:

writeToCheckpoint in interface Checkpointed

Parameters:

output - the output stream to write to

Throws:

IOException

InterruptedException

restoreFromCheckpoint

default CompletableFuture<Void> restoreFromCheckpoint(File directory,
                                                      ExecutorService executorService)

Description copied from interface: Checkpointed

Restores state from a checkpoint asynchronously.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

directory - where the checkpoint will be located

executorService - to use when running asynchronous tasks

Returns:

a future to track the progress

restoreFromCheckpoint

default void restoreFromCheckpoint(CheckpointInputStream input)
                            throws IOException

Description copied from interface: Checkpointed

Restores state from a checkpoint.

Specified by:

restoreFromCheckpoint in interface Checkpointed

Parameters:

input - an input stream with checkpoint data

Throws:

IOException