@InterfaceAudience.Private @InterfaceStability.Evolving public class HBaseBackupAdmin extends java.lang.Object implements BackupAdmin
Admin.getBackupAdmin()
and call close()
afterwards.
BackupAdmin can be used to create backups, restore data from backups and for other backup-related operations.
Admin
Modifier and Type | Method and Description |
---|---|
void |
addToBackupSet(java.lang.String name,
TableName[] tables)
Add tables to backup set command
|
java.lang.String |
backupTables(BackupRequest userRequest)
Backs up given list of tables fully.
|
java.util.concurrent.Future<java.lang.String> |
backupTablesAsync(BackupRequest userRequest)
Backs up given list of tables fully.
|
void |
close() |
int |
deleteBackups(java.lang.String[] backupIds)
Delete backup image command
|
boolean |
deleteBackupSet(java.lang.String name)
Delete backup set command
|
BackupInfo |
getBackupInfo(java.lang.String backupId)
Describe backup image command
|
BackupSet |
getBackupSet(java.lang.String name)
Backup set describe command.
|
java.util.List<BackupInfo> |
getHistory(int n)
Show backup history command
|
int |
getProgress(java.lang.String backupId)
Show backup progress command
|
java.util.List<BackupSet> |
listBackupSets()
Backup sets list command - list all backup sets.
|
void |
removeFromBackupSet(java.lang.String name,
java.lang.String[] tables)
Remove tables from backup set
|
void |
restore(RestoreRequest request)
Restore backup
|
public void close() throws java.io.IOException
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
java.io.IOException
public BackupInfo getBackupInfo(java.lang.String backupId) throws java.io.IOException
BackupAdmin
getBackupInfo
in interface BackupAdmin
backupId
- - backup idjava.io.IOException
- exceptionpublic int getProgress(java.lang.String backupId) throws java.io.IOException
BackupAdmin
getProgress
in interface BackupAdmin
backupId
- - backup id (may be null)java.io.IOException
- exceptionpublic int deleteBackups(java.lang.String[] backupIds) throws java.io.IOException
BackupAdmin
deleteBackups
in interface BackupAdmin
backupIds
- - backup idjava.io.IOException
- exceptionpublic java.util.List<BackupInfo> getHistory(int n) throws java.io.IOException
BackupAdmin
getHistory
in interface BackupAdmin
n
- - last n backup sessionsjava.io.IOException
- exceptionpublic java.util.List<BackupSet> listBackupSets() throws java.io.IOException
BackupAdmin
listBackupSets
in interface BackupAdmin
java.io.IOException
- exceptionpublic BackupSet getBackupSet(java.lang.String name) throws java.io.IOException
BackupAdmin
getBackupSet
in interface BackupAdmin
name
- set namejava.io.IOException
- exceptionpublic boolean deleteBackupSet(java.lang.String name) throws java.io.IOException
BackupAdmin
deleteBackupSet
in interface BackupAdmin
name
- - backup set namejava.io.IOException
- exceptionpublic void addToBackupSet(java.lang.String name, TableName[] tables) throws java.io.IOException
BackupAdmin
addToBackupSet
in interface BackupAdmin
name
- - name of backup set.tables
- - list of tables to be added to this set.java.io.IOException
- exceptionpublic void removeFromBackupSet(java.lang.String name, java.lang.String[] tables) throws java.io.IOException
BackupAdmin
removeFromBackupSet
in interface BackupAdmin
name
- - name of backup set.tables
- - list of tables to be removed from this set.java.io.IOException
- exceptionpublic void restore(RestoreRequest request) throws java.io.IOException
BackupAdmin
restore
in interface BackupAdmin
request
- - restore requestjava.io.IOException
- exceptionpublic java.lang.String backupTables(BackupRequest userRequest) throws java.io.IOException
BackupAdmin
backupTables
in interface BackupAdmin
java.io.IOException
public java.util.concurrent.Future<java.lang.String> backupTablesAsync(BackupRequest userRequest) throws java.io.IOException
BackupAdmin
backupTablesAsync
in interface BackupAdmin
java.io.IOException