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

Class BackupManager

java.lang.Object

org.apache.hadoop.hbase.backup.impl.BackupManager

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

IncrementalBackupManager

@Private
public class BackupManager
extends Object
implements Closeable

Handles backup requests, creates backup info records in backup system table to keep track of backup sessions, dispatches backup request.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BACKUP_EXCLUSIVE_OPERATION_TIMEOUT_SECONDS_KEY
protected BackupInfo	backupInfo
protected org.apache.hadoop.conf.Configuration	conf
protected final Connection	conn
private static final int	DEFAULT_BACKUP_EXCLUSIVE_OPERATION_TIMEOUT
private static final org.slf4j.Logger	LOG
protected BackupSystemTable	systemTable

Constructor Summary

Constructors

Constructor	Description
BackupManager(Connection conn, org.apache.hadoop.conf.Configuration conf)	Backup manager constructor.

Method Summary

Modifier and Type	Method	Description
void	addIncrementalBackupTableSet(Set<TableName> tables)	Adds set of tables to overall incremental backup table set
void	close()	Stop all the work of backup.
BackupInfo	createBackupInfo(String backupId, BackupType type, List<TableName> tableList, String targetRootDir, int workers, long bandwidth, boolean noChecksumVerify)	Creates a backup info based on input backup request.
static void	decorateMasterConfiguration(org.apache.hadoop.conf.Configuration conf)	This method modifies the master's configuration in order to inject backup-related features (TESTs only)
static void	decorateRegionServerConfiguration(org.apache.hadoop.conf.Configuration conf)	This method modifies the Region Server configuration in order to inject backup-related features TESTs only.
void	deleteBulkLoadedRows(List<byte[]> rows)
void	finishBackupSession()	Finishes active backup session
List<BackupInfo>	getBackupHistory()	Get all completed backup information (in desc order by time)
ArrayList<BackupInfo>	getBackupHistory(boolean completed)
protected BackupInfo	getBackupInfo()	Returns backup info
(package private) org.apache.hadoop.conf.Configuration	getConf()	Get configuration
Connection	getConnection()
Set<TableName>	getIncrementalBackupTableSet()	Return the current tables covered by incremental backup.
private String	getOngoingBackupId()	Check if any ongoing backup.
void	initialize()	Start the backup manager service.
static boolean	isBackupEnabled(org.apache.hadoop.conf.Configuration conf)
String	readBackupStartCode()	Read the last backup start code (timestamp) of last successful backup.
Pair<Map<TableName,Map<String,Map<String,List<Pair<String,Boolean>>>>>,List<byte[]>>	readBulkloadRows(List<TableName> tableList)
Map<TableName,Map<String,Long>>	readLogTimestampMap()	Read the timestamp for each region server log after the last successful backup.
HashMap<String,Long>	readRegionServerLastLogRollResult()	Get the RS log information after the last log roll from backup system table.
void	setBackupInfo(BackupInfo backupInfo)
void	startBackupSession()	Starts new backup session
void	updateBackupInfo(BackupInfo context)	Updates status (state) of a backup session in a persistent store
void	writeBackupStartCode(Long startCode)	Write the start code (timestamp) to backup system table.
void	writeRegionServerLogTimestamp(Set<TableName> tables, Map<String,Long> newTimestamps)	Write the current timestamps for each regionserver to backup system table after a successful full or incremental backup.

Methods inherited from class java.lang.Object

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

Field Details

BACKUP_EXCLUSIVE_OPERATION_TIMEOUT_SECONDS_KEY

public static final String BACKUP_EXCLUSIVE_OPERATION_TIMEOUT_SECONDS_KEY

See Also:

• Constant Field Values

DEFAULT_BACKUP_EXCLUSIVE_OPERATION_TIMEOUT

private static final int DEFAULT_BACKUP_EXCLUSIVE_OPERATION_TIMEOUT

See Also:

• Constant Field Values

LOG

private static final org.slf4j.Logger LOG

conf

protected org.apache.hadoop.conf.Configuration conf

backupInfo

protected BackupInfo backupInfo

systemTable

protected BackupSystemTable systemTable

conn

protected final Connection conn

Constructor Details

BackupManager

public BackupManager(Connection conn,
 org.apache.hadoop.conf.Configuration conf)
              throws IOException

Backup manager constructor.

Parameters:

conn - connection

conf - configuration

Throws:

IOException - exception

Method Details

getBackupInfo

protected BackupInfo getBackupInfo()

Returns backup info

decorateMasterConfiguration

public static void decorateMasterConfiguration(org.apache.hadoop.conf.Configuration conf)

This method modifies the master's configuration in order to inject backup-related features (TESTs only)

Parameters:

conf - configuration

decorateRegionServerConfiguration

public static void decorateRegionServerConfiguration(org.apache.hadoop.conf.Configuration conf)

This method modifies the Region Server configuration in order to inject backup-related features TESTs only.

Parameters:

conf - configuration

isBackupEnabled

public static boolean isBackupEnabled(org.apache.hadoop.conf.Configuration conf)

getConf

org.apache.hadoop.conf.Configuration getConf()

Get configuration

close

public void close()

Stop all the work of backup.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

createBackupInfo

public BackupInfo createBackupInfo(String backupId,
 BackupType type,
 List<TableName> tableList,
 String targetRootDir,
 int workers,
 long bandwidth,
 boolean noChecksumVerify)
                            throws BackupException

Creates a backup info based on input backup request.

Parameters:

backupId - backup id

type - type

tableList - table list

targetRootDir - root dir

workers - number of parallel workers

bandwidth - bandwidth per worker in MB per sec

Throws:

BackupException - exception

getOngoingBackupId

private String getOngoingBackupId()
                           throws IOException

Check if any ongoing backup. Currently, we only reply on checking status in backup system table. We need to consider to handle the case of orphan records in the future. Otherwise, all the coming request will fail.

Returns:

the ongoing backup id if on going backup exists, otherwise null

Throws:

IOException - exception

initialize

public void initialize()
                throws IOException

Start the backup manager service.

Throws:

IOException - exception

setBackupInfo

public void setBackupInfo(BackupInfo backupInfo)

updateBackupInfo

public void updateBackupInfo(BackupInfo context)
                      throws IOException

Updates status (state) of a backup session in a persistent store

Parameters:

context - context

Throws:

IOException - exception

startBackupSession

public void startBackupSession()
                        throws IOException

Starts new backup session

Throws:

IOException - if active session already exists

finishBackupSession

public void finishBackupSession()
                         throws IOException

Finishes active backup session

Throws:

IOException - if no active session

readBackupStartCode

public String readBackupStartCode()
                           throws IOException

Read the last backup start code (timestamp) of last successful backup. Will return null if there is no startcode stored in backup system table or the value is of length 0. These two cases indicate there is no successful backup completed so far.

Returns:

the timestamp of a last successful backup

Throws:

IOException - exception

writeBackupStartCode

public void writeBackupStartCode(Long startCode)
                          throws IOException

Write the start code (timestamp) to backup system table. If passed in null, then write 0 byte.

Parameters:

startCode - start code

Throws:

IOException - exception

readRegionServerLastLogRollResult

public HashMap<String,Long> readRegionServerLastLogRollResult()
                                                       throws IOException

Get the RS log information after the last log roll from backup system table.

Returns:

RS log info

Throws:

IOException - exception

readBulkloadRows

public Pair<Map<TableName,Map<String,Map<String,List<Pair<String,Boolean>>>>>,List<byte[]>> readBulkloadRows(List<TableName> tableList)
                                                                                                      throws IOException

Throws:

IOException

deleteBulkLoadedRows

public void deleteBulkLoadedRows(List<byte[]> rows)
                          throws IOException

Throws:

IOException

getBackupHistory

public List<BackupInfo> getBackupHistory()
                                  throws IOException

Get all completed backup information (in desc order by time)

Returns:

history info of BackupCompleteData

Throws:

IOException - exception

getBackupHistory

public ArrayList<BackupInfo> getBackupHistory(boolean completed)
                                       throws IOException

Throws:

IOException

writeRegionServerLogTimestamp

public void writeRegionServerLogTimestamp(Set<TableName> tables,
 Map<String,Long> newTimestamps)
                                   throws IOException

Write the current timestamps for each regionserver to backup system table after a successful full or incremental backup. Each table may have a different set of log timestamps. The saved timestamp is of the last log file that was backed up already.

Parameters:

tables - tables

Throws:

IOException - exception

readLogTimestampMap

public Map<TableName,Map<String,Long>> readLogTimestampMap()
                                                    throws IOException

Read the timestamp for each region server log after the last successful backup. Each table has its own set of the timestamps.

Returns:

the timestamp for each region server. key: tableName value: RegionServer,PreviousTimeStamp

Throws:

IOException - exception

getIncrementalBackupTableSet

public Set<TableName> getIncrementalBackupTableSet()
                                            throws IOException

Return the current tables covered by incremental backup.

Returns:

set of tableNames

Throws:

IOException - exception

addIncrementalBackupTableSet

public void addIncrementalBackupTableSet(Set<TableName> tables)
                                  throws IOException

Adds set of tables to overall incremental backup table set

Parameters:

tables - tables

Throws:

IOException - exception

getConnection

public Connection getConnection()