Package org.apache.hadoop.hbase.backup

Interface BackupAdmin

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

BackupAdminImpl

@Private
public interface BackupAdmin
extends Closeable

The administrative API for HBase Backup. Construct an instance and call Closeable.close() afterwards.

BackupAdmin can be used to create backups, restore data from backups and for other backup-related operations.

Since:

2.0

Method Summary

Modifier and Type	Method	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

Methods inherited from interface java.io.Closeable

close

Method Details

backupTables

String backupTables(BackupRequest userRequest)
             throws IOException

Backup given list of tables fully. This is a synchronous operation. It returns backup id on success or throw exception on failure.

Parameters:

userRequest - BackupRequest instance

Returns:

the backup Id

Throws:

IOException

restore

void restore(RestoreRequest request)
      throws IOException

Restore backup

Parameters:

request - restore request

Throws:

IOException - exception

getBackupInfo

BackupInfo getBackupInfo(String backupId)
                  throws IOException

Describe backup image command

Parameters:

backupId - backup id

Returns:

backup info

Throws:

IOException - exception

deleteBackups

int deleteBackups(String[] backupIds)
           throws IOException

Delete backup image command

Parameters:

backupIds - array of backup ids

Returns:

total number of deleted sessions

Throws:

IOException - exception

mergeBackups

void mergeBackups(String[] backupIds)
           throws IOException

Merge backup images command

Parameters:

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 merged

Throws:

IOException - exception

getHistory

List<BackupInfo> getHistory(int n)
                     throws IOException

Show backup history command

Parameters:

n - last n backup sessions

Returns:

list of backup info objects

Throws:

IOException - exception

getHistory

List<BackupInfo> getHistory(int n,
 BackupInfo.Filter... f)
                     throws IOException

Show backup history command with filters

Parameters:

n - last n backup sessions

f - list of filters

Returns:

list of backup info objects

Throws:

IOException - exception

listBackupSets

List<BackupSet> listBackupSets()
                        throws IOException

Backup sets list command - list all backup sets. Backup set is a named group of tables.

Returns:

all registered backup sets

Throws:

IOException - exception

getBackupSet

BackupSet getBackupSet(String name)
                throws IOException

Backup set describe command. Shows list of tables in this particular backup set.

Parameters:

name - set name

Returns:

backup set description or null

Throws:

IOException - exception

deleteBackupSet

boolean deleteBackupSet(String name)
                 throws IOException

Delete backup set command

Parameters:

name - backup set name

Returns:

true, if success, false - otherwise

Throws:

IOException - exception

addToBackupSet

void addToBackupSet(String name,
 TableName[] tables)
             throws IOException

Add tables to backup set command

Parameters:

name - name of backup set.

tables - array of tables to be added to this set.

Throws:

IOException - exception

removeFromBackupSet

void removeFromBackupSet(String name,
 TableName[] tables)
                  throws IOException

Remove tables from backup set

Parameters:

name - name of backup set.

tables - array of tables to be removed from this set.

Throws:

IOException - exception