Package org.apache.hadoop.hbase.backup

Class BackupInfo

java.lang.Object

org.apache.hadoop.hbase.backup.BackupInfo

All Implemented Interfaces:

Comparable<BackupInfo>

@Private
public class BackupInfo
extends Object
implements Comparable<BackupInfo>

An object to encapsulate the information for each backup session

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BackupInfo.BackupPhase	BackupPhase - phases of an ACTIVE backup session (running), when state of a backup session is BackupState.RUNNING
static enum	BackupInfo.BackupState	Backup session states
static interface	BackupInfo.Filter

Field Summary

Fields

Modifier and Type	Field	Description
private String	backupId	Backup id
private String	backupRootDir	Target root directory for storing the backup files
private Map<TableName,BackupTableInfo>	backupTableInfoMap	Backup status map for all tables
private long	bandwidth	Bandwidth per worker in MB per sec.
private long	completeTs	Actual end timestamp of the backup process
private String	failedMsg	Backup failure message
private String	hlogTargetDir	For incremental backup, a location of a backed-up hlogs
private List<String>	incrBackupFileList	Incremental backup file list
private Map<TableName,Map<String,Long>>	incrTimestampMap	Previous Region server log timestamps for table set after distributed log roll key - table name, value - map of RegionServer hostname -> last log rolled timestamp
private static final org.slf4j.Logger	LOG
private static final int	MAX_FAILED_MESSAGE_LENGTH
private boolean	noChecksumVerify	Do not verify checksum between source snapshot and exported snapshot
private BackupInfo.BackupPhase	phase	Backup phase
private int	progress	Backup progress in %% (0-100)
private long	startTs	Actual start timestamp of a backup process
private BackupInfo.BackupState	state	Backup state
private Map<TableName,Map<String,Long>>	tableSetTimestampMap	New region server log timestamps for table set after distributed log roll.
private long	totalBytesCopied	Total bytes of incremental logs copied
private BackupType	type	Backup type, full or incremental
private int	workers	Number of parallel workers.

Constructor Summary

Constructors

Constructor	Description
BackupInfo()
BackupInfo(String backupId, BackupType type, TableName[] tables, String targetRootDir)

Method Summary

Modifier and Type	Method	Description
void	addTables(TableName[] tables)
int	compareTo(BackupInfo o)	We use only time stamps to compare objects during sort operation
boolean	equals(Object obj)
static BackupInfo	fromByteArray(byte[] data)
static BackupInfo	fromProto(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo proto)
static BackupInfo	fromStream(InputStream stream)
String	getBackupId()
String	getBackupRootDir()
BackupTableInfo	getBackupTableInfo(TableName table)
long	getBandwidth()
long	getCompleteTs()
String	getFailedMsg()
String	getHLogTargetDir()
List<String>	getIncrBackupFileList()
Map<TableName,Map<String,Long>>	getIncrTimestampMap()	Get new region server log timestamps after distributed log roll
boolean	getNoChecksumVerify()
BackupInfo.BackupPhase	getPhase()
int	getProgress()	Get current progress
String	getShortDescription()
String	getSnapshotName(TableName table)
List<String>	getSnapshotNames()
long	getStartTs()
BackupInfo.BackupState	getState()
String	getStatusAndProgressAsString()
String	getTableBackupDir(TableName tableName)
TableName	getTableBySnapshot(String snapshotName)
String	getTableListAsString()
List<TableName>	getTableNames()
Set<TableName>	getTables()
Map<TableName,Map<String,Long>>	getTableSetTimestampMap()
private static Map<TableName,Map<String,Long>>	getTableSetTimestampMap(Map<String,org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.RSTimestampMap> map)
long	getTotalBytesCopied()
BackupType	getType()
int	getWorkers()
int	hashCode()
void	setBackupId(String backupId)
void	setBackupRootDir(String targetRootDir)
void	setBackupTableInfoMap(Map<TableName,BackupTableInfo> backupTableInfoMap)
private void	setBackupTableInfoMap(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.Builder builder)
void	setBandwidth(long bandwidth)
void	setCompleteTs(long endTs)
void	setFailedMsg(String failedMsg)
void	setHLogTargetDir(String hlogTagetDir)
void	setIncrBackupFileList(List<String> incrBackupFileList)
void	setIncrTimestampMap(Map<TableName,Map<String,Long>> prevTableSetTimestampMap)	Set the new region server log timestamps after distributed log roll
void	setNoChecksumVerify(boolean noChecksumVerify)
void	setPhase(BackupInfo.BackupPhase phase)
void	setProgress(int p)	Set progress (0-100%)
void	setSnapshotName(TableName table, String snapshotName)
void	setStartTs(long startTs)
void	setState(BackupInfo.BackupState flag)
void	setTables(List<TableName> tables)
void	setTableSetTimestampMap(Map<TableName,Map<String,Long>> tableSetTimestampMap)
private void	setTableSetTimestampMap(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.Builder builder)
void	setTotalBytesCopied(long totalBytesCopied)
void	setType(BackupType type)
void	setWorkers(int workers)
byte[]	toByteArray()
private static Map<TableName,BackupTableInfo>	toMap(List<org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupTableInfo> list)
org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo	toProtosBackupInfo()
String	toString()
static BackupInfo.Filter	withRoot(String backupRoot)
static BackupInfo.Filter	withState(BackupInfo.BackupState state)
static BackupInfo.Filter	withType(BackupType type)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

LOG

private static final org.slf4j.Logger LOG

MAX_FAILED_MESSAGE_LENGTH

private static final int MAX_FAILED_MESSAGE_LENGTH

See Also:

• Constant Field Values

backupId

private String backupId

Backup id

type

private BackupType type

Backup type, full or incremental

backupRootDir

private String backupRootDir

Target root directory for storing the backup files

state

private BackupInfo.BackupState state

Backup state

phase

private BackupInfo.BackupPhase phase

Backup phase

failedMsg

private String failedMsg

Backup failure message

backupTableInfoMap

private Map<TableName,BackupTableInfo> backupTableInfoMap

Backup status map for all tables

startTs

private long startTs

Actual start timestamp of a backup process

completeTs

private long completeTs

Actual end timestamp of the backup process

totalBytesCopied

private long totalBytesCopied

Total bytes of incremental logs copied

hlogTargetDir

private String hlogTargetDir

For incremental backup, a location of a backed-up hlogs

incrBackupFileList

private List<String> incrBackupFileList

Incremental backup file list

tableSetTimestampMap

private Map<TableName,Map<String,Long>> tableSetTimestampMap

New region server log timestamps for table set after distributed log roll. The keys consist of all tables that are part of the backup chain of the backup root (not just the tables that were specified when creating the backup, which could be a subset). The value is a map of RegionServer hostname to the last log-roll timestamp, i.e. the point up to which logs are included in the backup.

incrTimestampMap

private Map<TableName,Map<String,Long>> incrTimestampMap

Previous Region server log timestamps for table set after distributed log roll key - table name, value - map of RegionServer hostname -> last log rolled timestamp

progress

private int progress

Backup progress in %% (0-100)

workers

private int workers

Number of parallel workers. -1 - system defined

bandwidth

private long bandwidth

Bandwidth per worker in MB per sec. -1 - unlimited

noChecksumVerify

private boolean noChecksumVerify

Do not verify checksum between source snapshot and exported snapshot

Constructor Details

BackupInfo

public BackupInfo()

BackupInfo

public BackupInfo(String backupId,
 BackupType type,
 TableName[] tables,
 String targetRootDir)

Method Details

withRoot

public static BackupInfo.Filter withRoot(String backupRoot)

withType

public static BackupInfo.Filter withType(BackupType type)

withState

public static BackupInfo.Filter withState(BackupInfo.BackupState state)

getWorkers

public int getWorkers()

setWorkers

public void setWorkers(int workers)

getBandwidth

public long getBandwidth()

setBandwidth

public void setBandwidth(long bandwidth)

setNoChecksumVerify

public void setNoChecksumVerify(boolean noChecksumVerify)

getNoChecksumVerify

public boolean getNoChecksumVerify()

setBackupTableInfoMap

public void setBackupTableInfoMap(Map<TableName,BackupTableInfo> backupTableInfoMap)

getTableSetTimestampMap

public Map<TableName,Map<String,Long>> getTableSetTimestampMap()

setTableSetTimestampMap

public void setTableSetTimestampMap(Map<TableName,Map<String,Long>> tableSetTimestampMap)

setType

public void setType(BackupType type)

setBackupRootDir

public void setBackupRootDir(String targetRootDir)

setTotalBytesCopied

public void setTotalBytesCopied(long totalBytesCopied)

setProgress

public void setProgress(int p)

Set progress (0-100%)

Parameters:

p - progress value

getProgress

public int getProgress()

Get current progress

getBackupId

public String getBackupId()

setBackupId

public void setBackupId(String backupId)

getBackupTableInfo

public BackupTableInfo getBackupTableInfo(TableName table)

getFailedMsg

public String getFailedMsg()

setFailedMsg

public void setFailedMsg(String failedMsg)

getStartTs

public long getStartTs()

setStartTs

public void setStartTs(long startTs)

getCompleteTs

public long getCompleteTs()

setCompleteTs

public void setCompleteTs(long endTs)

getTotalBytesCopied

public long getTotalBytesCopied()

getState

public BackupInfo.BackupState getState()

setState

public void setState(BackupInfo.BackupState flag)

getPhase

public BackupInfo.BackupPhase getPhase()

setPhase

public void setPhase(BackupInfo.BackupPhase phase)

getType

public BackupType getType()

setSnapshotName

public void setSnapshotName(TableName table,
 String snapshotName)

getSnapshotName

public String getSnapshotName(TableName table)

getSnapshotNames

public List<String> getSnapshotNames()

getTables

public Set<TableName> getTables()

getTableNames

public List<TableName> getTableNames()

addTables

public void addTables(TableName[] tables)

setTables

public void setTables(List<TableName> tables)

getBackupRootDir

public String getBackupRootDir()

getTableBackupDir

public String getTableBackupDir(TableName tableName)

setHLogTargetDir

public void setHLogTargetDir(String hlogTagetDir)

getHLogTargetDir

public String getHLogTargetDir()

getIncrBackupFileList

public List<String> getIncrBackupFileList()

setIncrBackupFileList

public void setIncrBackupFileList(List<String> incrBackupFileList)

setIncrTimestampMap

public void setIncrTimestampMap(Map<TableName,Map<String,Long>> prevTableSetTimestampMap)

Set the new region server log timestamps after distributed log roll

Parameters:

prevTableSetTimestampMap - table timestamp map

getIncrTimestampMap

public Map<TableName,Map<String,Long>> getIncrTimestampMap()

Get new region server log timestamps after distributed log roll

Returns:

new region server log timestamps

getTableBySnapshot

public TableName getTableBySnapshot(String snapshotName)

toProtosBackupInfo

public org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo toProtosBackupInfo()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

toByteArray

public byte[] toByteArray()
                   throws IOException

Throws:

IOException

setBackupTableInfoMap

private void setBackupTableInfoMap(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.Builder builder)

setTableSetTimestampMap

private void setTableSetTimestampMap(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.Builder builder)

fromByteArray

public static BackupInfo fromByteArray(byte[] data)
                                throws IOException

Throws:

IOException

fromStream

public static BackupInfo fromStream(InputStream stream)
                             throws IOException

Throws:

IOException

fromProto

public static BackupInfo fromProto(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo proto)

toMap

private static Map<TableName,BackupTableInfo> toMap(List<org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupTableInfo> list)

getTableSetTimestampMap

private static Map<TableName,Map<String,Long>> getTableSetTimestampMap(Map<String,org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.BackupInfo.RSTimestampMap> map)

getShortDescription

public String getShortDescription()

getStatusAndProgressAsString

public String getStatusAndProgressAsString()

getTableListAsString

public String getTableListAsString()

compareTo

public int compareTo(BackupInfo o)

We use only time stamps to compare objects during sort operation

Specified by:

compareTo in interface Comparable<BackupInfo>