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

Class TableBackupClient

java.lang.Object

org.apache.hadoop.hbase.backup.impl.TableBackupClient

Direct Known Subclasses:

FullTableBackupClient, IncrementalTableBackupClient

@Private
public abstract class TableBackupClient
extends Object

Base class for backup operation. Concrete implementation for full and incremental backup are delegated to corresponding sub-classes: FullTableBackupClient and IncrementalTableBackupClient

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TableBackupClient.Stage

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKUP_CLIENT_IMPL_CLASS
static final String	BACKUP_TEST_MODE_STAGE
protected String	backupId
protected BackupInfo	backupInfo
protected BackupManager	backupManager
protected org.apache.hadoop.conf.Configuration	conf
protected Connection	conn
protected org.apache.hadoop.fs.FileSystem	fs
private static final org.slf4j.Logger	LOG
protected Map<String,Long>	newTimestamps
protected List<TableName>	tableList

Constructor Summary

Constructors

Constructor	Description
TableBackupClient()
TableBackupClient(Connection conn, String backupId, BackupRequest request)

Method Summary

Modifier and Type	Method	Description
protected void	addManifest(BackupInfo backupInfo, BackupType type, org.apache.hadoop.conf.Configuration conf)	Creates a manifest based on the provided info, and store it in the backup-specific directory.
protected void	beginBackup(BackupManager backupManager, BackupInfo backupInfo)	Begin the overall backup.
static void	cleanupAndRestoreBackupSystem(Connection conn, BackupInfo backupInfo, org.apache.hadoop.conf.Configuration conf)
protected static void	cleanupExportSnapshotLog(org.apache.hadoop.conf.Configuration conf)	Clean up directories with prefix "exportSnapshot-", which are generated when exporting snapshots.
protected static void	cleanupTargetDir(BackupInfo backupInfo, org.apache.hadoop.conf.Configuration conf)	Clean up the uncompleted data at target directory if the ongoing backup has already entered the copy phase.
protected void	completeBackup(Connection conn, BackupInfo backupInfo, BackupType type, org.apache.hadoop.conf.Configuration conf)	Complete the overall backup.
protected static void	deleteSnapshots(Connection conn, BackupInfo backupInfo, org.apache.hadoop.conf.Configuration conf)	Delete HBase snapshot for backup.
abstract void	execute()	Backup request execution.
protected void	failBackup(Connection conn, BackupInfo backupInfo, BackupManager backupManager, Exception e, String msg, BackupType type, org.apache.hadoop.conf.Configuration conf)	Fail the overall backup.
protected void	failStageIf(TableBackupClient.Stage stage)
protected List<BackupManifest.BackupImage>	getAncestors(BackupInfo backupInfo)	Gets the direct ancestors of the currently being created backup.
protected String	getMessage(Exception e)
protected TableBackupClient.Stage	getTestStage()
void	init(Connection conn, String backupId, BackupRequest request)
protected String	obtainBackupMetaDataStr(BackupInfo backupInfo)	Get backup request meta data dir as string.

Methods inherited from class java.lang.Object

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

Field Details

BACKUP_CLIENT_IMPL_CLASS

public static final String BACKUP_CLIENT_IMPL_CLASS

See Also:

• Constant Field Values

BACKUP_TEST_MODE_STAGE

public static final String BACKUP_TEST_MODE_STAGE

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

conf

protected org.apache.hadoop.conf.Configuration conf

conn

protected Connection conn

backupId

protected String backupId

tableList

protected List<TableName> tableList

newTimestamps

protected Map<String,Long> newTimestamps

backupManager

protected BackupManager backupManager

backupInfo

protected BackupInfo backupInfo

fs

protected org.apache.hadoop.fs.FileSystem fs

Constructor Details

TableBackupClient

public TableBackupClient()

TableBackupClient

public TableBackupClient(Connection conn,
 String backupId,
 BackupRequest request)
                  throws IOException

Throws:

IOException

Method Details

init

public void init(Connection conn,
 String backupId,
 BackupRequest request)
          throws IOException

Throws:

IOException

beginBackup

protected void beginBackup(BackupManager backupManager,
 BackupInfo backupInfo)
                    throws IOException

Begin the overall backup.

Parameters:

backupInfo - backup info

Throws:

IOException - exception

getMessage

protected String getMessage(Exception e)

deleteSnapshots

protected static void deleteSnapshots(Connection conn,
 BackupInfo backupInfo,
 org.apache.hadoop.conf.Configuration conf)
                               throws IOException

Delete HBase snapshot for backup.

Parameters:

backupInfo - backup info

Throws:

IOException - exception

cleanupExportSnapshotLog

protected static void cleanupExportSnapshotLog(org.apache.hadoop.conf.Configuration conf)
                                        throws IOException

Clean up directories with prefix "exportSnapshot-", which are generated when exporting snapshots.

Throws:

IOException - exception

cleanupTargetDir

protected static void cleanupTargetDir(BackupInfo backupInfo,
 org.apache.hadoop.conf.Configuration conf)

Clean up the uncompleted data at target directory if the ongoing backup has already entered the copy phase.

failBackup

protected void failBackup(Connection conn,
 BackupInfo backupInfo,
 BackupManager backupManager,
 Exception e,
 String msg,
 BackupType type,
 org.apache.hadoop.conf.Configuration conf)
                   throws IOException

Fail the overall backup.

Parameters:

backupInfo - backup info

e - exception

Throws:

IOException - exception

cleanupAndRestoreBackupSystem

public static void cleanupAndRestoreBackupSystem(Connection conn,
 BackupInfo backupInfo,
 org.apache.hadoop.conf.Configuration conf)
                                          throws IOException

Throws:

IOException

addManifest

protected void addManifest(BackupInfo backupInfo,
 BackupType type,
 org.apache.hadoop.conf.Configuration conf)
                    throws IOException

Creates a manifest based on the provided info, and store it in the backup-specific directory.

Parameters:

backupInfo - The current backup info

Throws:

IOException - exception

getAncestors

protected List<BackupManifest.BackupImage> getAncestors(BackupInfo backupInfo)
                                                 throws IOException

Gets the direct ancestors of the currently being created backup.

Parameters:

backupInfo - The backup info for the backup being created

Throws:

IOException

obtainBackupMetaDataStr

protected String obtainBackupMetaDataStr(BackupInfo backupInfo)

Get backup request meta data dir as string.

Parameters:

backupInfo - backup info

Returns:

meta data dir

completeBackup

protected void completeBackup(Connection conn,
 BackupInfo backupInfo,
 BackupType type,
 org.apache.hadoop.conf.Configuration conf)
                       throws IOException

Complete the overall backup.

Parameters:

backupInfo - backup info

Throws:

IOException - exception

execute

public abstract void execute()
                      throws IOException

Backup request execution.

Throws:

IOException - if the execution of the backup fails

getTestStage

protected TableBackupClient.Stage getTestStage()

failStageIf

protected void failStageIf(TableBackupClient.Stage stage)
                    throws IOException

Throws:

IOException