@InterfaceAudience.Private public interface BackupAdmin extends Closeable
Closeable.close()
afterwards.
BackupAdmin can be used to create backups, restore data from backups and for other backup-related operations.
Modifier and Type | Method and Description |
---|---|
void |
addToBackupSet(String name,
TableName[] tables)
Add tables to backup set command
|
String |
backupTables(BackupRequest userRequest)
Backup given list of tables fully.
|
int |
deleteBackups(String[] backupIds)
Delete backup image command
|
boolean |
deleteBackupSet(String name)
Delete backup set command
|
BackupInfo |
getBackupInfo(String backupId)
Describe backup image command
|
BackupSet |
getBackupSet(String name)
Backup set describe command.
|
List<BackupInfo> |
getHistory(int n)
Show backup history command
|
List<BackupInfo> |
getHistory(int n,
BackupInfo.Filter... f)
Show backup history command with filters
|
List<BackupSet> |
listBackupSets()
Backup sets list command - list all backup sets.
|
void |
mergeBackups(String[] backupIds)
Merge backup images command
|
void |
removeFromBackupSet(String name,
TableName[] tables)
Remove tables from backup set
|
void |
restore(RestoreRequest request)
Restore backup
|
String backupTables(BackupRequest userRequest) throws IOException
userRequest
- BackupRequest instanceIOException
void restore(RestoreRequest request) throws IOException
request
- restore requestIOException
- exceptionBackupInfo getBackupInfo(String backupId) throws IOException
backupId
- backup idIOException
- exceptionint deleteBackups(String[] backupIds) throws IOException
backupIds
- array of backup idsIOException
- exceptionvoid mergeBackups(String[] backupIds) throws IOException
backupIds
- array of backup ids of images to be merged The resulting backup image will
have the same backup id as the most recent image from a list of images to be
mergedIOException
- exceptionList<BackupInfo> getHistory(int n) throws IOException
n
- last n backup sessionsIOException
- exceptionList<BackupInfo> getHistory(int n, BackupInfo.Filter... f) throws IOException
n
- last n backup sessionsf
- list of filtersIOException
- exceptionList<BackupSet> listBackupSets() throws IOException
IOException
- exceptionBackupSet getBackupSet(String name) throws IOException
name
- set nameIOException
- exceptionboolean deleteBackupSet(String name) throws IOException
name
- backup set nameIOException
- exceptionvoid addToBackupSet(String name, TableName[] tables) throws IOException
name
- name of backup set.tables
- array of tables to be added to this set.IOException
- exceptionvoid removeFromBackupSet(String name, TableName[] tables) throws IOException
name
- name of backup set.tables
- array of tables to be removed from this set.IOException
- exceptionCopyright © 2007–2020 The Apache Software Foundation. All rights reserved.