org.apache.hadoop.hbase.client

Interface BackupAdmin

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable

All Known Implementing Classes:

HBaseBackupAdmin

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public interface BackupAdmin
extends java.io.Closeable

The administrative API for HBase Backup. Obtain an instance from an Admin.getBackupAdmin() 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

See Also:

Admin

Method Summary

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.
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

Methods inherited from interface java.io.Closeable

close

Method Detail

backupTables

java.lang.String backupTables(BackupRequest userRequest)
                       throws java.io.IOException

Backs up given list of tables fully. Synchronous operation.

Parameters:

request - BackupRequest instance which contains the following members: type whether the backup is full or incremental tableList list of tables to backup targetRootDir root directory for saving the backup workers number of parallel workers. -1 - system defined bandwidth bandwidth per worker in MB per second. -1 - unlimited

Returns:

the backup Id

Throws:

java.io.IOException

backupTablesAsync

java.util.concurrent.Future<java.lang.String> backupTablesAsync(BackupRequest userRequest)
                                                         throws java.io.IOException

Backs up given list of tables fully. Asynchronous operation.

Parameters:

request - BackupRequest instance which contains the following members: type whether the backup is full or incremental tableList list of tables to backup targetRootDir root dir for saving the backup workers number of paralle workers. -1 - system defined bandwidth bandwidth per worker in MB per sec. -1 - unlimited

Returns:

the backup Id future

Throws:

java.io.IOException

getBackupInfo

BackupInfo getBackupInfo(java.lang.String backupId)
                  throws java.io.IOException

Describe backup image command

Parameters:

backupId - - backup id

Returns:

backup info

Throws:

java.io.IOException - exception

getProgress

int getProgress(java.lang.String backupId)
         throws java.io.IOException

Show backup progress command

Parameters:

backupId - - backup id (may be null)

Returns:

backup progress (0-100%), -1 if no active sessions or session not found

Throws:

java.io.IOException - exception

deleteBackups

int deleteBackups(java.lang.String[] backupIds)
           throws java.io.IOException

Delete backup image command

Parameters:

backupIds - - backup id

Returns:

total number of deleted sessions

Throws:

java.io.IOException - exception

getHistory

java.util.List<BackupInfo> getHistory(int n)
                               throws java.io.IOException

Show backup history command

Parameters:

n - - last n backup sessions

Returns:

list of backup infos

Throws:

java.io.IOException - exception

listBackupSets

java.util.List<BackupSet> listBackupSets()
                                  throws java.io.IOException

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

Returns:

all registered backup sets

Throws:

java.io.IOException - exception

getBackupSet

BackupSet getBackupSet(java.lang.String name)
                throws java.io.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:

java.io.IOException - exception

deleteBackupSet

boolean deleteBackupSet(java.lang.String name)
                 throws java.io.IOException

Delete backup set command

Parameters:

name - - backup set name

Returns:

true, if success, false - otherwise

Throws:

java.io.IOException - exception

addToBackupSet

void addToBackupSet(java.lang.String name,
                    TableName[] tables)
             throws java.io.IOException

Add tables to backup set command

Parameters:

name - - name of backup set.

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

Throws:

java.io.IOException - exception

removeFromBackupSet

void removeFromBackupSet(java.lang.String name,
                         java.lang.String[] tables)
                  throws java.io.IOException

Remove tables from backup set

Parameters:

name - - name of backup set.

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

Throws:

java.io.IOException - exception

restore

void restore(RestoreRequest request)
      throws java.io.IOException

Restore backup

Parameters:

request - - restore request

Throws:

java.io.IOException - exception