org.rocksdb

Class BackupableDB

java.lang.Object

org.rocksdb.RocksObject

org.rocksdb.RocksDB

org.rocksdb.BackupableDB

public class BackupableDB
extends RocksDB

A subclass of RocksDB which supports backup-related operations.

See Also:

BackupableDBOptions

Field Summary

Fields inherited from class org.rocksdb.RocksDB

DEFAULT_COLUMN_FAMILY, NOT_FOUND, options_

Fields inherited from class org.rocksdb.RocksObject

nativeHandle_

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BackupableDB() A protected construction that will be used in the static factory method open(Options, BackupableDBOptions, String).

Method Summary

Modifier and Type	Method and Description
void	close() Close the BackupableDB instance and release resource.
void	createNewBackup(boolean flushBeforeBackup) Captures the state of the database in the latest backup.
protected void	createNewBackup(long handle, boolean flag)
void	deleteBackup(int backupId) Deletes a specific backup.
protected void	finalize() Simply calls dispose() and release its c++ resource if it has not yet released.
void	garbageCollect() Will delete all the files we don't need anymore.
protected java.util.List<BackupInfo>	getBackupInfo(long handle)
java.util.List<BackupInfo>	getBackupInfos() Returns a list of BackupInfo instances, which describe already made backups.
int[]	getCorruptedBackups() Returns a list of corrupted backup ids.
protected void	open(long rocksDBHandle, long backupDBOptionsHandle)
static BackupableDB	open(Options opt, BackupableDBOptions bopt, java.lang.String db_path) Open a BackupableDB under the specified path.
void	purgeOldBackups(int numBackupsToKeep) Deletes old backups, keeping latest numBackupsToKeep alive.
protected void	purgeOldBackups(long handle, int numBackupsToKeep)

Methods inherited from class org.rocksdb.RocksDB

createColumnFamily, disposeInternal, dropColumnFamily, flush, flush, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getLongProperty, getLongProperty, getLongProperty, getLongProperty, getProperty, getProperty, getProperty0, getProperty0, getSnapshot, getSnapshot, iterator0, iterator0, iterators, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, keyMayExist, listColumnFamilies, listColumnFamilies, loadLibrary, loadLibrary, merge, merge, merge, merge, merge, merge, merge, merge, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, multiGet, newIterator, newIterator, newIterators, open, open, open, open, open, open, openReadOnly, openReadOnly, openReadOnly, openReadOnly, openROnly, openROnly, put, put, put, put, put, put, put, put, releaseSnapshot, releaseSnapshot, remove, remove, remove, remove, remove, remove, remove, remove, write, write

Methods inherited from class org.rocksdb.RocksObject

disOwnNativeHandle, dispose, isInitialized, isOwningNativeHandle

Methods inherited from class java.lang.Object

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

Constructor Detail

BackupableDB

protected BackupableDB()

A protected construction that will be used in the static factory method open(Options, BackupableDBOptions, String).

Method Detail

open

public static BackupableDB open(Options opt,
                                BackupableDBOptions bopt,
                                java.lang.String db_path)
                         throws RocksDBException

Open a BackupableDB under the specified path. Note that the backup path should be set properly in the input BackupableDBOptions.

Parameters:

opt - Options to set for the database.

bopt - BackupableDBOptions to use.

db_path - Path to store data to. The path for storing the backup should be specified in the BackupableDBOptions.

Returns:

BackupableDB reference to the opened database.

Throws:

RocksDBException - thrown if error happens in underlying native library.

createNewBackup

public void createNewBackup(boolean flushBeforeBackup)
                     throws RocksDBException

Captures the state of the database in the latest backup. Note that this function is not thread-safe.

Parameters:

flushBeforeBackup - if true, then all data will be flushed before creating backup.

Throws:

RocksDBException - thrown if error happens in underlying native library.

purgeOldBackups

public void purgeOldBackups(int numBackupsToKeep)
                     throws RocksDBException

Deletes old backups, keeping latest numBackupsToKeep alive.

Parameters:

numBackupsToKeep - Number of latest backups to keep.

Throws:

RocksDBException - thrown if error happens in underlying native library.

deleteBackup

public void deleteBackup(int backupId)
                  throws RocksDBException

Deletes a specific backup.

Parameters:

backupId - of backup to delete.

Throws:

RocksDBException - thrown if error happens in underlying native library.

getBackupInfos

public java.util.List<BackupInfo> getBackupInfos()

Returns a list of BackupInfo instances, which describe already made backups.

Returns:

List of BackupInfo instances.

getCorruptedBackups

public int[] getCorruptedBackups()

Returns a list of corrupted backup ids. If there is no corrupted backup the method will return an empty list.

Returns:

array of backup ids as int ids.

garbageCollect

public void garbageCollect()
                    throws RocksDBException

Will delete all the files we don't need anymore. It will do the full scan of the files/ directory and delete all the files that are not referenced.

Throws:

RocksDBException - thrown if error happens in underlying native library.

close

public void close()

Close the BackupableDB instance and release resource.

Internally, BackupableDB owns the rocksdb::DB pointer to its associated RocksDB. The release of that RocksDB pointer is handled in the destructor of the c++ rocksdb::BackupableDB and should be transparent to Java developers.

Overrides:

close in class RocksDB

finalize

protected void finalize()
                 throws java.lang.Throwable

Description copied from class: RocksObject

Simply calls dispose() and release its c++ resource if it has not yet released.

Overrides:

finalize in class RocksObject

Throws:

java.lang.Throwable

open

protected void open(long rocksDBHandle,
                    long backupDBOptionsHandle)

createNewBackup

protected void createNewBackup(long handle,
                               boolean flag)
                        throws RocksDBException

Throws:

RocksDBException

purgeOldBackups

protected void purgeOldBackups(long handle,
                               int numBackupsToKeep)
                        throws RocksDBException

Throws:

RocksDBException

getBackupInfo

protected java.util.List<BackupInfo> getBackupInfo(long handle)