org.firebirdsql.management
Interface BackupManager
- ServiceManager
- FBBackupManager
public interface BackupManager
Implements the backup and restore functionality of Firebird Services API.
void | addBackupPath(String path) - Add backup file to the list.
|
void | addBackupPath(String path, int size) - Add the file to the backup of the specified size.
|
void | addRestorePath(String path, int size) - Add the file to the multi-file database of the specified size for restore
operation.
|
void | backupDatabase() - Perform the backup operation.
|
void | backupDatabase(int options) - Perform the backup operation.
|
void | backupMetadata() - Perform the backup operation, metadata only.
|
void | clearBackupPaths() - Clear the information about backup paths.
|
void | clearRestorePaths() - Clear the information about restore paths.
|
void | restoreDatabase() - Perform the restore operation.
|
void | restoreDatabase(int options) - Perform the restore operation.
|
void | setBackupPath(String backupPath) - Sets the location of the backup file.
|
void | setDatabase(String path) - Set the path to the database.
|
void | setRestorePageBufferCount(int bufferCount) - Set the default number of pages to be buffered (cached) by default in a
restored database.
|
void | setRestorePageSize(int pageSize) - Set the page size that will be used for a restored database.
|
void | setRestoreReadOnly(boolean readOnly) - Set the read-only attribute on a restored database.
|
void | setRestoreReplace(boolean replace) - Set the restore operation to create a new database, as opposed to
overwriting an existing database.
|
void | setVerbose(boolean verbose) - Set whether the operations of this
BackupManager will
result in verbose logging to the configured logger.
|
getDatabase , getHost , getLogger , getPassword , getPort , getUser , setDatabase , setHost , setLogger , setPassword , setPort , setUser |
BACKUP_CONVERT
public static final int BACKUP_CONVERT
Backup external files as tables.
BACKUP_EXPAND
public static final int BACKUP_EXPAND
No data compression.
BACKUP_IGNORE_CHECKSUMS
public static final int BACKUP_IGNORE_CHECKSUMS
Ignore checksums.
BACKUP_IGNORE_LIMBO
public static final int BACKUP_IGNORE_LIMBO
Ignore in-limbo transactions.
BACKUP_METADATA_ONLY
public static final int BACKUP_METADATA_ONLY
Backup metadata only.
BACKUP_NON_TRANSPORTABLE
public static final int BACKUP_NON_TRANSPORTABLE
Use non-transportable backup format.
BACKUP_NO_GARBAGE_COLLECT
public static final int BACKUP_NO_GARBAGE_COLLECT
Do not collect garbage during backup.
BACKUP_OLD_DESCRIPTIONS
public static final int BACKUP_OLD_DESCRIPTIONS
Save old style metadata descriptions.
RESTORE_DEACTIVATE_INDEX
public static final int RESTORE_DEACTIVATE_INDEX
Deactivate indices during restore.
RESTORE_NO_SHADOW
public static final int RESTORE_NO_SHADOW
Do not restore shadow database.
RESTORE_NO_VALIDITY
public static final int RESTORE_NO_VALIDITY
Do not restore validity constraints.
RESTORE_ONE_AT_A_TIME
public static final int RESTORE_ONE_AT_A_TIME
Commit after completing restore of each table.
RESTORE_USE_ALL_SPACE
public static final int RESTORE_USE_ALL_SPACE
Do not reserve 20% on each page for the future versions, useful for
read-only databases.
addBackupPath
public void addBackupPath(String path)
Add backup file to the list. This method is used only during restoring
the database to specify multi-file backups. The call is equivalent to
passing the size -1 to
addBackupPath(String,int)
call.
If application invokes backup operation, an error is generated in that
call.
path
- path to the backup file.
addBackupPath
public void addBackupPath(String path,
int size)
Add the file to the backup of the specified size. Firebird allows
splitting the backup into multiple files, limiting the size of the backup
file. This can be useful for example for creating a backup on CD or DVD.
path
- path to the backup file.size
- max size of the file in bytes.
addRestorePath
public void addRestorePath(String path,
int size)
Add the file to the multi-file database of the specified size for restore
operation.
path
- path to the backup file.size
- max size of the database file in pages.
backupDatabase
public void backupDatabase()
throws SQLException
Perform the backup operation.
backupDatabase
public void backupDatabase(int options)
throws SQLException
Perform the backup operation.
options
- a bitmask combination of the BACKUP_*
static final fields for the backup operation
backupMetadata
public void backupMetadata()
throws SQLException
Perform the backup operation, metadata only.
clearBackupPaths
public void clearBackupPaths()
clearRestorePaths
public void clearRestorePaths()
restoreDatabase
public void restoreDatabase()
throws SQLException
Perform the restore operation.
restoreDatabase
public void restoreDatabase(int options)
throws SQLException
Perform the restore operation.
options
- A bitmask combination of RESTORE_*
static
final fields
setBackupPath
public void setBackupPath(String backupPath)
Sets the location of the backup file. This method is used to set the
path to the backup consisting of a single file. It is not possible to
add multiple files or specify the max. size of the file using this
method. It is also not possible to call
addBackupPath(String,int)
method after calling this one.
backupPath
- the location of the backup file.
setDatabase
public void setDatabase(String path)
Set the path to the database. This method is used both for backup and
restore operation.
- setDatabase in interface ServiceManager
path
- path to the database file.
In case of backup, value specifies the path of the existing database on
the server that will be backed up.
In case of restore, value specifies the path of the single-file database
where the backup will be restored to.
setRestorePageBufferCount
public void setRestorePageBufferCount(int bufferCount)
Set the default number of pages to be buffered (cached) by default in a
restored database.
bufferCount
- The page-buffer size to be used, a positive value
setRestorePageSize
public void setRestorePageSize(int pageSize)
Set the page size that will be used for a restored database. The value
for pageSize
must be one of: 1024, 2048, 4096, or 8192. The
default value is 1024.
pageSize
- The page size to be used in a restored database, one
of 1024, 2048, 4196, 8192
setRestoreReadOnly
public void setRestoreReadOnly(boolean readOnly)
Set the read-only attribute on a restored database.
readOnly
- If true
, a restored database will be
read-only, otherwise it will be read-write.
setRestoreReplace
public void setRestoreReplace(boolean replace)
Set the restore operation to create a new database, as opposed to
overwriting an existing database.
replace
- If true
, the restore operation will attempt
to create a new database if it does not exit or overwrite an
existing one when it exists, false
when restore
should fail if database already exist (if it doesn't, a database
will be successfully created).
setVerbose
public void setVerbose(boolean verbose)
Set whether the operations of this BackupManager
will
result in verbose logging to the configured logger.
verbose
- If true
, operations will be logged
verbosely, otherwise they will not be logged verbosely
Copyright B) 2001 David Jencks and other authors. All rights reserved.