org.apache.hadoop.hbase.client

Class HBaseBackupAdmin

java.lang.Object

org.apache.hadoop.hbase.client.HBaseBackupAdmin

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, BackupAdmin

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public class HBaseBackupAdmin
extends java.lang.Object
implements BackupAdmin

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

getBackupInfo

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

Description copied from interface: BackupAdmin

Describe backup image command

Specified by:

getBackupInfo in interface BackupAdmin

Parameters:

backupId - - backup id

Returns:

backup info

Throws:

java.io.IOException - exception

getProgress

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

Description copied from interface: BackupAdmin

Show backup progress command

Specified by:

getProgress in interface BackupAdmin

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

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

Description copied from interface: BackupAdmin

Delete backup image command

Specified by:

deleteBackups in interface BackupAdmin

Parameters:

backupIds - - backup id

Returns:

total number of deleted sessions

Throws:

java.io.IOException - exception

getHistory

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

Description copied from interface: BackupAdmin

Show backup history command

Specified by:

getHistory in interface BackupAdmin

Parameters:

n - - last n backup sessions

Returns:

list of backup infos

Throws:

java.io.IOException - exception

listBackupSets

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

Description copied from interface: BackupAdmin

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

Specified by:

listBackupSets in interface BackupAdmin

Returns:

all registered backup sets

Throws:

java.io.IOException - exception

getBackupSet

public BackupSet getBackupSet(java.lang.String name)
                       throws java.io.IOException

Description copied from interface: BackupAdmin

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

Specified by:

getBackupSet in interface BackupAdmin

Parameters:

name - set name

Returns:

backup set description or null

Throws:

java.io.IOException - exception

deleteBackupSet

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

Description copied from interface: BackupAdmin

Delete backup set command

Specified by:

deleteBackupSet in interface BackupAdmin

Parameters:

name - - backup set name

Returns:

true, if success, false - otherwise

Throws:

java.io.IOException - exception

addToBackupSet

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

Description copied from interface: BackupAdmin

Add tables to backup set command

Specified by:

addToBackupSet in interface BackupAdmin

Parameters:

name - - name of backup set.

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

Throws:

java.io.IOException - exception

removeFromBackupSet

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

Description copied from interface: BackupAdmin

Remove tables from backup set

Specified by:

removeFromBackupSet in interface BackupAdmin

Parameters:

name - - name of backup set.

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

Throws:

java.io.IOException - exception

restore

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

Description copied from interface: BackupAdmin

Restore backup

Specified by:

restore in interface BackupAdmin

Parameters:

request - - restore request

Throws:

java.io.IOException - exception

backupTables

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

Description copied from interface: BackupAdmin

Backs up given list of tables fully. Synchronous operation.

Specified by:

backupTables in interface BackupAdmin

Returns:

the backup Id

Throws:

java.io.IOException

backupTablesAsync

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

Description copied from interface: BackupAdmin

Backs up given list of tables fully. Asynchronous operation.

Specified by:

backupTablesAsync in interface BackupAdmin

Returns:

the backup Id future

Throws:

java.io.IOException