com.amazon.carbonado.repo.sleepycat

Interface HotBackupCapability

All Superinterfaces:

Capability

public interface HotBackupCapability
extends Capability

Capability for performing a backup of an active BDB environment. If in-memory logging is enabled, backups cannot be performed. To restore from a hot backup, it is critical that a full recovery be performed. Pass true to setRunFullRecovery to enable. BDB-JE does not require this, however.

To support incremental backups against the native BDB product, old log files must be kept. Pass true to setKeepOldLogFiles.

Since:

1.2.1

Author:

Brian S O'Neill, Olga Kuznetsova

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	HotBackupCapability.Backup

Method Summary

Methods

Modifier and Type	Method and Description
HotBackupCapability.Backup	startBackup() Starts the backup by disabling log file deletion.
HotBackupCapability.Backup	startBackup(boolean deleteOldLogFiles) Starts the backup by disabling log file deletion.
HotBackupCapability.Backup	startIncrementalBackup(long lastLogNumber) Starts an incremental backup.
HotBackupCapability.Backup	startIncrementalBackup(long lastLogNumber, boolean deleteOldLogFiles) Starts an incremental backup.

Method Detail

startBackup

HotBackupCapability.Backup startBackup()
                                       throws RepositoryException

Starts the backup by disabling log file deletion. Be sure to call endBackup when done to resume log file cleanup. Concurrent backups are supported.

Throws:

java.lang.IllegalStateException - if configuration doesn't support backups

RepositoryException

startBackup

HotBackupCapability.Backup startBackup(boolean deleteOldLogFiles)
                                       throws RepositoryException

Starts the backup by disabling log file deletion. Be sure to call endBackup when done to resume log file cleanup. Concurrent backups are supported.

Caution should be observed when deleting old log files by force, if an external process is also performing backups. If a concurrent backup is issued by this repository instance, log file deletion is suppressed.

Parameters:

deleteOldLogFiles - deletes log files that are no longer in use and have been backed up. False by default.

Throws:

java.lang.IllegalStateException - if configuration doesn't support backups

RepositoryException

startIncrementalBackup

HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber)
                                                  throws RepositoryException

Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied during the backup. Should only be run after performing a full backup.

Parameters:

lastLogNumber - number of the last log file that was copied in a previous backup

Throws:

java.lang.IllegalArgumentException - if lastLogNumber is negative

java.lang.IllegalStateException - if configuration doesn't support backups

RepositoryException

startIncrementalBackup

HotBackupCapability.Backup startIncrementalBackup(long lastLogNumber,
                                                boolean deleteOldLogFiles)
                                                  throws RepositoryException

Starts an incremental backup. Log files that are newer than the lastLogNumber will be copied during the backup. Can only be run after performing a full backup.

Caution should be observed when deleting old log files by force, if an external process is also performing backups. If a concurrent backup is issued by this repository instance, log file deletion is suppressed.

Parameters:

lastLogNumber - number of the last log file that was copied in a previous backup.

deleteOldLogFiles - deletes log files that are no longer in use and have been backed up. False by default.

Throws:

java.lang.IllegalArgumentException - if lastLogNumber is negative

java.lang.IllegalStateException - if configuration doesn't support backups

RepositoryException