Package org.apache.hadoop.hbase.backup.impl

Class BackupAdminImpl

java.lang.Object

org.apache.hadoop.hbase.backup.impl.BackupAdminImpl

All Implemented Interfaces:

Closeable, AutoCloseable, BackupAdmin

@Private
public class BackupAdminImpl
extends Object
implements BackupAdmin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHECK_FAILED
static final String	CHECK_OK
private final Connection	conn
private static final org.slf4j.Logger	LOG

Constructor Summary

Constructors

Constructor	Description
BackupAdminImpl(Connection conn)

Method Summary

Modifier and Type	Method	Description
void	addToBackupSet(String name, TableName[] tables)	Add tables to backup set command
String	backupTables(BackupRequest request)	Backup given list of tables fully.
private void	checkIfValidForMerge(String[] backupIds, BackupSystemTable table)	Verifies that backup images are valid for merge.
private void	cleanupBackupDir(BackupInfo backupInfo, TableName table, org.apache.hadoop.conf.Configuration conf)	Clean up the data at target directory
void	close()
private int	deleteBackup(String backupId, BackupSystemTable sysTable)	Delete single backup and all related backups Algorithm: Backup type: FULL or INCREMENTAL Is this last backup session for table T: YES or NO For every table T from table list 'tables': if(FULL, YES) deletes only physical data (PD) if(FULL, NO), deletes PD, scans all newer backups and removes T from backupInfo, until we either reach the most recent backup for T in the system or FULL backup which includes T if(INCREMENTAL, YES) deletes only physical data (PD) if(INCREMENTAL, NO) deletes physical data and for table T scans all backup images between last FULL backup, which is older than the backup being deleted and the next FULL backup (if exists) or last one for a particular table T and removes T from list of backup tables.
int	deleteBackups(String[] backupIds)	Delete backup image command
boolean	deleteBackupSet(String name)	Delete backup set command
private List<TableName>	excludeNonExistingTables(List<TableName> tableList, List<TableName> nonExistingTableList)
private void	finalizeDelete(List<String> backupRoots, BackupSystemTable table)	Updates incremental backup set for every backupRoot
private List<BackupInfo>	getAffectedBackupSessions(BackupInfo backupInfo, TableName tn, BackupSystemTable table)
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... filters)	Show backup history command with filters
private boolean	isLastBackupSession(BackupSystemTable table, TableName tn, long startTime)
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
private void	removeTableFromBackupImage(BackupInfo info, TableName tn, BackupSystemTable sysTable)
void	restore(RestoreRequest request)	Restore backup
private String[]	toStringArray(TableName[] list)

Methods inherited from class java.lang.Object

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

Field Details

CHECK_OK

public static final String CHECK_OK

See Also:

• Constant Field Values

CHECK_FAILED

public static final String CHECK_FAILED

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

conn

private final Connection conn

Constructor Details

BackupAdminImpl

public BackupAdminImpl(Connection conn)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

getBackupInfo

public BackupInfo getBackupInfo(String backupId)
                         throws IOException

Description copied from interface: BackupAdmin

Describe backup image command

Specified by:

getBackupInfo in interface BackupAdmin

Parameters:

backupId - backup id

Returns:

backup info

Throws:

IOException - exception

deleteBackups

public int deleteBackups(String[] backupIds)
                  throws IOException

Description copied from interface: BackupAdmin

Delete backup image command

Specified by:

deleteBackups in interface BackupAdmin

Parameters:

backupIds - array of backup ids

Returns:

total number of deleted sessions

Throws:

IOException - exception

finalizeDelete

private void finalizeDelete(List<String> backupRoots,
 BackupSystemTable table)
                     throws IOException

Updates incremental backup set for every backupRoot

Parameters:

backupRoots - backupRoots for which to revise the incremental backup set

table - backup system table

Throws:

IOException - if a table operation fails

deleteBackup

private int deleteBackup(String backupId,
 BackupSystemTable sysTable)
                  throws IOException

Delete single backup and all related backups
Algorithm:
Backup type: FULL or INCREMENTAL
Is this last backup session for table T: YES or NO
For every table T from table list 'tables':
if(FULL, YES) deletes only physical data (PD)
if(FULL, NO), deletes PD, scans all newer backups and removes T from backupInfo,
until we either reach the most recent backup for T in the system or FULL backup
which includes T
if(INCREMENTAL, YES) deletes only physical data (PD) if(INCREMENTAL, NO) deletes physical data and for table T scans all backup images between last
FULL backup, which is older than the backup being deleted and the next FULL backup (if exists)
or last one for a particular table T and removes T from list of backup tables.

Parameters:

backupId - backup id

sysTable - backup system table

Returns:

total number of deleted backup images

Throws:

IOException - if deleting the backup fails

removeTableFromBackupImage

private void removeTableFromBackupImage(BackupInfo info,
 TableName tn,
 BackupSystemTable sysTable)
                                 throws IOException

Throws:

IOException

getAffectedBackupSessions

private List<BackupInfo> getAffectedBackupSessions(BackupInfo backupInfo,
 TableName tn,
 BackupSystemTable table)
                                            throws IOException

Throws:

IOException

cleanupBackupDir

private void cleanupBackupDir(BackupInfo backupInfo,
 TableName table,
 org.apache.hadoop.conf.Configuration conf)
                       throws IOException

Clean up the data at target directory

Throws:

IOException - if cleaning up the backup directory fails

isLastBackupSession

private boolean isLastBackupSession(BackupSystemTable table,
 TableName tn,
 long startTime)
                             throws IOException

Throws:

IOException

getHistory

public List<BackupInfo> getHistory(int n)
                            throws 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 info objects

Throws:

IOException - exception

getHistory

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

Description copied from interface: BackupAdmin

Show backup history command with filters

Specified by:

getHistory in interface BackupAdmin

Parameters:

n - last n backup sessions

filters - list of filters

Returns:

list of backup info objects

Throws:

IOException - exception

listBackupSets

public List<BackupSet> listBackupSets()
                               throws 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:

IOException - exception

getBackupSet

public BackupSet getBackupSet(String name)
                       throws 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:

IOException - exception

deleteBackupSet

public boolean deleteBackupSet(String name)
                        throws 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:

IOException - exception

addToBackupSet

public void addToBackupSet(String name,
 TableName[] tables)
                    throws 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 - array of tables to be added to this set.

Throws:

IOException - exception

removeFromBackupSet

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

Description copied from interface: BackupAdmin

Remove tables from backup set

Specified by:

removeFromBackupSet in interface BackupAdmin

Parameters:

name - name of backup set.

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

Throws:

IOException - exception

toStringArray

private String[] toStringArray(TableName[] list)

restore

public void restore(RestoreRequest request)
             throws IOException

Description copied from interface: BackupAdmin

Restore backup

Specified by:

restore in interface BackupAdmin

Parameters:

request - restore request

Throws:

IOException - exception

backupTables

public String backupTables(BackupRequest request)
                    throws IOException

Description copied from interface: BackupAdmin

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

Specified by:

backupTables in interface BackupAdmin

Parameters:

request - BackupRequest instance

Returns:

the backup Id

Throws:

IOException

excludeNonExistingTables

private List<TableName> excludeNonExistingTables(List<TableName> tableList,
 List<TableName> nonExistingTableList)

mergeBackups

public void mergeBackups(String[] backupIds)
                  throws IOException

Description copied from interface: BackupAdmin

Merge backup images command

Specified by:

mergeBackups in interface BackupAdmin

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

checkIfValidForMerge

private void checkIfValidForMerge(String[] backupIds,
 BackupSystemTable table)
                           throws IOException

Verifies that backup images are valid for merge.

• All backups MUST be in the same destination
• No FULL backups are allowed - only INCREMENTAL
• All backups must be in COMPLETE state
• No holes in backup list are allowed

Parameters:

backupIds - list of backup ids

table - backup system table

Throws:

IOException - if the backup image is not valid for merge