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

Class BackupSystemTable

java.lang.Object

org.apache.hadoop.hbase.backup.impl.BackupSystemTable

All Implemented Interfaces:

Closeable, AutoCloseable

@Private
public final class BackupSystemTable
extends Object
implements Closeable

This class provides API to access backup system table
Backup system table schema:

• 1. Backup sessions rowkey= "session:"+backupId; value =serialized BackupInfo
• 2. Backup start code rowkey = "startcode:"+backupRoot; value = startcode
• 3. Incremental backup set rowkey="incrbackupset:"+backupRoot; table="meta:"+tablename of include table; value=empty
• 4. Table-RS-timestamp map rowkey="trslm:"+backupRoot+table_name; value = map[RS-> last WAL timestamp]
• 5. RS - WAL ts map rowkey="rslogts:"+backupRoot +server; value = last WAL timestamp
• 6. WALs recorded rowkey="wals:"+WAL unique file name; value = backupId and full WAL file name

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	BackupSystemTable.WALItem

Field Summary

Fields

Modifier and Type	Field	Description
private static final byte[]	ACTIVE_SESSION_COL
private static final byte[]	ACTIVE_SESSION_NO
private static final byte[]	ACTIVE_SESSION_ROW
private static final byte[]	ACTIVE_SESSION_YES
private static final String	BACKUP_INFO_PREFIX
(package private) static final byte[]	BL_COMMIT
(package private) static final byte[]	BL_PREPARE
private static final String	BLK_LD_DELIM
(package private) static final byte[]	BULK_LOAD_FAMILY
private static final String	BULK_LOAD_PREFIX
private static final byte[]	BULK_LOAD_PREFIX_BYTES
private TableName	bulkLoadTableName	Backup System table name for bulk loaded files.
private final Connection	connection	Connection to HBase cluster, shared among all instances
private static final byte[]	DELETE_OP_ROW
private static final byte[]	EMPTY_VALUE
(package private) static final byte[]	FAM_COL
private static final String	INCR_BACKUP_SET
private static final org.slf4j.Logger	LOG
private static final byte[]	MERGE_OP_ROW
(package private) static final byte[]	META_FAMILY	Stores other meta
private static final String	NULL
(package private) static final byte[]	PATH_COL
private static final String	RS_LOG_TS_PREFIX
(package private) static final byte[]	SESSIONS_FAMILY	Stores backup sessions (contexts)
private static final String	SET_KEY_PREFIX
private static final String	START_CODE_ROW
(package private) static final byte[]	STATE_COL
private static final String	TABLE_RS_LOG_MAP_PREFIX
private TableName	tableName	Backup system table (main) name
(package private) static final byte[]	TBL_COL

Constructor Summary

Constructors

Constructor	Description
BackupSystemTable(Connection conn)

Method Summary

Modifier and Type	Method	Description
void	addIncrementalBackupTableSet(Set<TableName> tables, String backupRoot)	Add tables to global incremental backup set
void	addToBackupSet(String name, String[] newTables)	Add backup set (list of tables)
private String	cellKeyToBackupSetName(Cell current)	Converts cell key to backup set name.
private BackupInfo	cellToBackupInfo(Cell current)	Converts cell to backup info instance.
private String[]	cellValueToBackupSet(Cell current)	Converts cell to backup set list.
private void	checkSystemTable()
void	close()
private byte[]	convertToByteArray(String[] tables)
private Delete	createDeleteForBackupDeleteOperation()
private Delete	createDeleteForBackupInfo(String backupId)	Creates Delete operation for a given backup id
private Delete	createDeleteForBackupMergeOperation()
private Delete	createDeleteForBackupSet(String name)	Creates Delete operation to delete backup set content
private Delete	createDeleteForIncrBackupTableSet(String backupRoot)	Creates Delete for incremental backup table set
static List<Delete>	createDeleteForOrigBulkLoad(List<TableName> lst)
private Get	createGetForBackupInfo(String backupId)	Creates Get operation for a given backup id
private Get	createGetForBackupSet(String name)	Creates Get operation to load backup set content
private Get	createGetForDeleteOperation()
private Get	createGetForIncrBackupTableSet(String backupRoot)	Creates Get to retrieve incremental backup table set from backup system table
private Get	createGetForMergeOperation()
private Get	createGetForStartCode(String rootPath)	Creates Get operation to retrieve start code from backup system table
private Put	createPutForBackupInfo(BackupInfo context)	Creates Put operation for a given backup info object
private Put	createPutForBackupSet(String name, String[] tables)	Creates Put operation to update backup set content
(package private) static Put	createPutForBulkLoadedFile(TableName tn, byte[] fam, String p, String backupId, long ts, int idx)
(package private) static List<Put>	createPutForCommittedBulkload(TableName table, byte[] region, Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)
private Put	createPutForDeleteOperation(String[] backupIdList)
private Put	createPutForIncrBackupTableSet(Set<TableName> tables, String backupRoot)	Creates Put to store incremental backup table set
private Put	createPutForMergeOperation(String[] backupIdList)
(package private) static List<Put>	createPutForPreparedBulkload(TableName table, byte[] region, byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
private Put	createPutForRegionServerLastLogRollResult(String server, Long timestamp, String backupRoot)	Creates Put to store RS last log result
private Put	createPutForStartBackupSession()
private Put	createPutForStartCode(String startCode, String rootPath)	Creates Put operation to store start code to backup system table
private Put	createPutForStopBackupSession()
private Put	createPutForUpdateTablesForMerge(List<TableName> tables)
private Put	createPutForWriteRegionServerLogTimestamp(TableName table, byte[] smap, String backupRoot)	Creates Put to write RS last roll log timestamp map
private Scan	createScanForBackupHistory()	Creates Scan operation to load backup history
private Scan	createScanForBackupSetList()	Creates Scan operation to load backup set list
(package private) static Scan	createScanForBulkLoadedFiles(String backupId)
(package private) static Scan	createScanForOrigBulkLoadedFiles(TableName table)
private Scan	createScanForReadLogTimestampMap(String backupRoot)	Creates Scan to load table-> { RS -> ts} map of maps
private Scan	createScanForReadRegionServerLastLogRollResult(String backupRoot)	Creates Scan operation to load last RS log roll results
private void	createSystemTable(Admin admin, TableDescriptor descriptor)
void	deleteBackupInfo(String backupId)	Deletes backup status from backup system table table
void	deleteBackupSet(String name)	Delete backup set
void	deleteBulkLoadedRows(List<byte[]> rows)
void	deleteIncrementalBackupTableSet(String backupRoot)	Deletes incremental backup set for a backup destination
static void	deleteSnapshot(Connection conn)
List<TableName>	describeBackupSet(String name)	Get backup set description (list of tables)
private String[]	disjoin(String[] existingTables, String[] toRemove)
private static void	ensureTableEnabled(Admin admin, TableName tableName)
void	finishBackupExclusiveOperation()
void	finishDeleteOperation()
void	finishMergeOperation()
private HashMap<String,Long>	fromTableServerTimestampProto(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.TableServerTimestamp proto)
List<BackupInfo>	getBackupHistory()	Get all backups history
ArrayList<BackupInfo>	getBackupHistory(boolean onlyCompleted)	Get all completed backup information (in desc order by time)
List<BackupInfo>	getBackupHistory(int n, BackupInfo.Filter... filters)	Get backup history records filtered by list of filters.
List<BackupInfo>	getBackupHistory(String backupRoot)	Get history for backup destination
List<BackupInfo>	getBackupHistoryForTable(TableName name)	Get history for a table
Map<TableName,List<BackupInfo>>	getBackupHistoryForTableSet(Set<TableName> set, String backupRoot)	Goes through all backup history corresponding to the provided root folder, and collects all backup info mentioning each of the provided tables.
ArrayList<BackupInfo>	getBackupInfos(BackupInfo.BackupState state)	Get all backup sessions with a given state (in descending order by time)
List<BackupInfo>	getHistory(int n)	Get first n backup history records
Set<TableName>	getIncrementalBackupTableSet(String backupRoot)	Return the current tables covered by incremental backup.
String[]	getListOfBackupIdsFromDeleteOperation()
String[]	getListOfBackupIdsFromMergeOperation()
(package private) static String	getRegionNameFromOrigBulkLoadRow(String rowStr)
private String	getServerNameForReadRegionServerLastLogRollResult(byte[] row)	Get server's name from rowkey
static String	getSnapshotName(org.apache.hadoop.conf.Configuration conf)
static TableDescriptor	getSystemTableDescriptor(org.apache.hadoop.conf.Configuration conf)	Get backup system table descriptor
static TableDescriptor	getSystemTableForBulkLoadedDataDescriptor(org.apache.hadoop.conf.Configuration conf)	Get backup system table descriptor
static TableName	getTableName(org.apache.hadoop.conf.Configuration conf)
static String	getTableNameAsString(org.apache.hadoop.conf.Configuration conf)
static TableName	getTableNameForBulkLoadedData(org.apache.hadoop.conf.Configuration conf)
private String	getTableNameForReadLogTimestampMap(byte[] cloneRow)	Get table name from rowkey
(package private) static String	getTableNameFromOrigBulkLoadRow(String rowStr)
List<TableName>	getTablesForBackupType(BackupType type)
boolean	hasBackupSessions()	Checks if we have at least one backup session in backup system table This API is used by BackupLogCleaner
boolean	isMergeInProgress()
List<String>	listBackupSets()	Get backup set list
private String[]	merge(String[] existingTables, String[] newTables)
BackupInfo	readBackupInfo(String backupId)	Reads backup status object (instance of backup info) from backup system table table
String	readBackupStartCode(String backupRoot)	Read the last backup start code (timestamp) of last successful backup.
(package private) Map<byte[],String>	readBulkLoadedFiles(String backupId)
Map<byte[],List<org.apache.hadoop.fs.Path>>[]	readBulkLoadedFiles(String backupId, List<TableName> sTableList)
Pair<Map<TableName,Map<String,Map<String,List<Pair<String,Boolean>>>>>,List<byte[]>>	readBulkloadRows(List<TableName> tableList)
Map<TableName,Map<String,Long>>	readLogTimestampMap(String backupRoot)	Read the timestamp for each region server log after the last successful backup.
HashMap<String,Long>	readRegionServerLastLogRollResult(String backupRoot)	Get the Region Servers log information after the last log roll from backup system table.
void	removeFromBackupSet(String name, String[] toRemove)	Remove tables from backup set (list of tables)
static void	restoreFromSnapshot(Connection conn)
private BackupInfo	resultToBackupInfo(Result res)	Converts Result to BackupInfo
private static byte[]	rowkey(String s, String... other)
static void	snapshot(Connection conn)
private static boolean	snapshotExists(Admin admin, String snapshotName)
static boolean	snapshotExists(Connection conn)
void	startBackupExclusiveOperation()	Exclusive operations are: create, delete, merge
void	startDeleteOperation(String[] backupIdList)
void	startMergeOperation(String[] backupIdList)
private org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.TableServerTimestamp	toTableServerTimestampProto(TableName table, Map<String,Long> map)
void	updateBackupInfo(BackupInfo info)	Updates status (state) of a backup session in backup system table table
void	updateProcessedTablesForMerge(List<TableName> tables)
private void	verifyNamespaceExists(Admin admin)
private void	waitForSystemTable(Admin admin, TableName tableName)
void	writeBackupStartCode(Long startCode, String backupRoot)	Write the start code (timestamp) to backup system table.
void	writeBulkLoadedFiles(List<TableName> sTableList, Map<byte[],List<org.apache.hadoop.fs.Path>>[] maps, String backupId)
void	writeFilesForBulkLoadPreCommit(TableName tabName, byte[] region, byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
void	writePathsPostBulkLoad(TableName tabName, byte[] region, Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)
void	writeRegionServerLastLogRollResult(String server, Long ts, String backupRoot)	Writes Region Server last roll log result (timestamp) to backup system table table
void	writeRegionServerLogTimestamp(Set<TableName> tables, Map<String,Long> newTimestamps, String backupRoot)	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

LOG

private static final org.slf4j.Logger LOG

tableName

private TableName tableName

Backup system table (main) name

bulkLoadTableName

private TableName bulkLoadTableName

Backup System table name for bulk loaded files. We keep all bulk loaded file references in a separate table because we have to isolate general backup operations: create, merge etc from activity of RegionObserver, which controls process of a bulk loading BackupObserver

SESSIONS_FAMILY

static final byte[] SESSIONS_FAMILY

Stores backup sessions (contexts)

META_FAMILY

static final byte[] META_FAMILY

Stores other meta

BULK_LOAD_FAMILY

static final byte[] BULK_LOAD_FAMILY

connection

private final Connection connection

Connection to HBase cluster, shared among all instances

BACKUP_INFO_PREFIX

private static final String BACKUP_INFO_PREFIX

See Also:

• Constant Field Values

START_CODE_ROW

private static final String START_CODE_ROW

See Also:

• Constant Field Values

ACTIVE_SESSION_ROW

private static final byte[] ACTIVE_SESSION_ROW

ACTIVE_SESSION_COL

private static final byte[] ACTIVE_SESSION_COL

ACTIVE_SESSION_YES

private static final byte[] ACTIVE_SESSION_YES

ACTIVE_SESSION_NO

private static final byte[] ACTIVE_SESSION_NO

INCR_BACKUP_SET

private static final String INCR_BACKUP_SET

See Also:

• Constant Field Values

TABLE_RS_LOG_MAP_PREFIX

private static final String TABLE_RS_LOG_MAP_PREFIX

See Also:

• Constant Field Values

RS_LOG_TS_PREFIX

private static final String RS_LOG_TS_PREFIX

See Also:

• Constant Field Values

BULK_LOAD_PREFIX

private static final String BULK_LOAD_PREFIX

See Also:

• Constant Field Values

BULK_LOAD_PREFIX_BYTES

private static final byte[] BULK_LOAD_PREFIX_BYTES

DELETE_OP_ROW

private static final byte[] DELETE_OP_ROW

MERGE_OP_ROW

private static final byte[] MERGE_OP_ROW

TBL_COL

static final byte[] TBL_COL

FAM_COL

static final byte[] FAM_COL

PATH_COL

static final byte[] PATH_COL

STATE_COL

static final byte[] STATE_COL

BL_PREPARE

static final byte[] BL_PREPARE

BL_COMMIT

static final byte[] BL_COMMIT

SET_KEY_PREFIX

private static final String SET_KEY_PREFIX

See Also:

• Constant Field Values

BLK_LD_DELIM

private static final String BLK_LD_DELIM

See Also:

• Constant Field Values

EMPTY_VALUE

private static final byte[] EMPTY_VALUE

NULL

private static final String NULL

See Also:

• Constant Field Values

Constructor Details

BackupSystemTable

public BackupSystemTable(Connection conn)
                  throws IOException

Throws:

IOException

Method Details

checkSystemTable

private void checkSystemTable()
                       throws IOException

Throws:

IOException

createSystemTable

private void createSystemTable(Admin admin,
 TableDescriptor descriptor)
                        throws IOException

Throws:

IOException

verifyNamespaceExists

private void verifyNamespaceExists(Admin admin)
                            throws IOException

Throws:

IOException

waitForSystemTable

private void waitForSystemTable(Admin admin,
 TableName tableName)
                         throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

updateBackupInfo

public void updateBackupInfo(BackupInfo info)
                      throws IOException

Updates status (state) of a backup session in backup system table table

Parameters:

info - backup info

Throws:

IOException - exception

readBulkLoadedFiles

Map<byte[],String> readBulkLoadedFiles(String backupId)
                                throws IOException

Throws:

IOException

readBulkLoadedFiles

public Map<byte[],List<org.apache.hadoop.fs.Path>>[] readBulkLoadedFiles(String backupId,
 List<TableName> sTableList)
                                                                  throws IOException

Throws:

IOException

deleteBackupInfo

public void deleteBackupInfo(String backupId)
                      throws IOException

Deletes backup status from backup system table table

Parameters:

backupId - backup id

Throws:

IOException - exception

writePathsPostBulkLoad

public void writePathsPostBulkLoad(TableName tabName,
 byte[] region,
 Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)
                            throws IOException

Throws:

IOException

writeFilesForBulkLoadPreCommit

public void writeFilesForBulkLoadPreCommit(TableName tabName,
 byte[] region,
 byte[] family,
 List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
                                    throws IOException

Throws:

IOException

deleteBulkLoadedRows

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

Throws:

IOException

readBulkloadRows

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

Throws:

IOException

writeBulkLoadedFiles

public void writeBulkLoadedFiles(List<TableName> sTableList,
 Map<byte[],List<org.apache.hadoop.fs.Path>>[] maps,
 String backupId)
                          throws IOException

Throws:

IOException

readBackupInfo

public BackupInfo readBackupInfo(String backupId)
                          throws IOException

Reads backup status object (instance of backup info) from backup system table table

Parameters:

backupId - backup id

Returns:

Current status of backup session or null

Throws:

IOException

readBackupStartCode

public String readBackupStartCode(String backupRoot)
                           throws IOException

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

Parameters:

backupRoot - directory path to backup destination

Returns:

the timestamp of last successful backup

Throws:

IOException - exception

writeBackupStartCode

public void writeBackupStartCode(Long startCode,
 String backupRoot)
                          throws IOException

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

Parameters:

startCode - start code

backupRoot - root directory path to backup

Throws:

IOException - exception

startBackupExclusiveOperation

public void startBackupExclusiveOperation()
                                   throws IOException

Exclusive operations are: create, delete, merge

Throws:

IOException - if a table operation fails or an active backup exclusive operation is already underway

createPutForStartBackupSession

private Put createPutForStartBackupSession()

finishBackupExclusiveOperation

public void finishBackupExclusiveOperation()
                                    throws IOException

Throws:

IOException

createPutForStopBackupSession

private Put createPutForStopBackupSession()

readRegionServerLastLogRollResult

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

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

Parameters:

backupRoot - root directory path to backup

Returns:

RS log info

Throws:

IOException - exception

writeRegionServerLastLogRollResult

public void writeRegionServerLastLogRollResult(String server,
 Long ts,
 String backupRoot)
                                        throws IOException

Writes Region Server last roll log result (timestamp) to backup system table table

Parameters:

server - Region Server name

ts - last log timestamp

backupRoot - root directory path to backup

Throws:

IOException - exception

getBackupHistory

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

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

Parameters:

onlyCompleted - true, if only successfully completed sessions

Returns:

history info of BackupCompleteData

Throws:

IOException - exception

getBackupHistory

public List<BackupInfo> getBackupHistory()
                                  throws IOException

Get all backups history

Returns:

list of backup info

Throws:

IOException - if getting the backup history fails

getHistory

public List<BackupInfo> getHistory(int n)
                            throws IOException

Get first n backup history records

Parameters:

n - number of records, if n== -1 - max number is ignored

Returns:

list of records

Throws:

IOException - if getting the backup history fails

getBackupHistory

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

Get backup history records filtered by list of filters.

Parameters:

n - max number of records, if n == -1 , then max number is ignored

filters - list of filters

Returns:

backup records

Throws:

IOException - if getting the backup history fails

getTablesForBackupType

public List<TableName> getTablesForBackupType(BackupType type)
                                       throws IOException

Throws:

IOException

getBackupHistory

public List<BackupInfo> getBackupHistory(String backupRoot)
                                  throws IOException

Get history for backup destination

Parameters:

backupRoot - backup destination path

Returns:

List of backup info

Throws:

IOException - if getting the backup history fails

getBackupHistoryForTable

public List<BackupInfo> getBackupHistoryForTable(TableName name)
                                          throws IOException

Get history for a table

Parameters:

name - table name

Returns:

history for a table

Throws:

IOException - if getting the backup history fails

getBackupHistoryForTableSet

public Map<TableName,List<BackupInfo>> getBackupHistoryForTableSet(Set<TableName> set,
 String backupRoot)
                                                            throws IOException

Goes through all backup history corresponding to the provided root folder, and collects all backup info mentioning each of the provided tables.

Parameters:

set - the tables for which to collect the BackupInfo

backupRoot - backup destination path to retrieve backup history for

Returns:

a map containing (a subset of) the provided TableNames, mapped to a list of at least one BackupInfo

Throws:

IOException - if getting the backup history fails

getBackupInfos

public ArrayList<BackupInfo> getBackupInfos(BackupInfo.BackupState state)
                                     throws IOException

Get all backup sessions with a given state (in descending order by time)

Parameters:

state - backup session state

Returns:

history info of backup info objects

Throws:

IOException - exception

writeRegionServerLogTimestamp

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

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

Parameters:

tables - tables

newTimestamps - timestamps

backupRoot - root directory path to backup

Throws:

IOException - exception

readLogTimestampMap

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

Read the timestamp for each region server log after the last successful backup. Each table has its own set of the timestamps. The info is stored for each table as a concatenated string of rs->timestapmp

Parameters:

backupRoot - root directory path to backup

Returns:

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

Throws:

IOException - exception

toTableServerTimestampProto

private org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.TableServerTimestamp toTableServerTimestampProto(TableName table,
 Map<String,Long> map)

fromTableServerTimestampProto

private HashMap<String,Long> fromTableServerTimestampProto(org.apache.hadoop.hbase.shaded.protobuf.generated.BackupProtos.TableServerTimestamp proto)

getIncrementalBackupTableSet

public Set<TableName> getIncrementalBackupTableSet(String backupRoot)
                                            throws IOException

Return the current tables covered by incremental backup.

Parameters:

backupRoot - root directory path to backup

Returns:

set of tableNames

Throws:

IOException - exception

addIncrementalBackupTableSet

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

Add tables to global incremental backup set

Parameters:

tables - set of tables

backupRoot - root directory path to backup

Throws:

IOException - exception

deleteIncrementalBackupTableSet

public void deleteIncrementalBackupTableSet(String backupRoot)
                                     throws IOException

Deletes incremental backup set for a backup destination

Parameters:

backupRoot - backup root

Throws:

IOException

hasBackupSessions

public boolean hasBackupSessions()
                          throws IOException

Checks if we have at least one backup session in backup system table This API is used by BackupLogCleaner

Returns:

true, if - at least one session exists in backup system table table

Throws:

IOException - exception

listBackupSets

public List<String> listBackupSets()
                            throws IOException

Get backup set list

Returns:

backup set list

Throws:

IOException - if a table or scanner operation fails

describeBackupSet

public List<TableName> describeBackupSet(String name)
                                  throws IOException

Get backup set description (list of tables)

Parameters:

name - set's name

Returns:

list of tables in a backup set

Throws:

IOException - if a table operation fails

addToBackupSet

public void addToBackupSet(String name,
 String[] newTables)
                    throws IOException

Add backup set (list of tables)

Parameters:

name - set name

newTables - list of tables, comma-separated

Throws:

IOException - if a table operation fails

removeFromBackupSet

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

Remove tables from backup set (list of tables)

Parameters:

name - set name

toRemove - list of tables

Throws:

IOException - if a table operation or deleting the backup set fails

merge

private String[] merge(String[] existingTables,
 String[] newTables)

disjoin

private String[] disjoin(String[] existingTables,
 String[] toRemove)

deleteBackupSet

public void deleteBackupSet(String name)
                     throws IOException

Delete backup set

Parameters:

name - set's name

Throws:

IOException - if getting or deleting the table fails

getSystemTableDescriptor

public static TableDescriptor getSystemTableDescriptor(org.apache.hadoop.conf.Configuration conf)

Get backup system table descriptor

Returns:

table's descriptor

getTableName

public static TableName getTableName(org.apache.hadoop.conf.Configuration conf)

getTableNameAsString

public static String getTableNameAsString(org.apache.hadoop.conf.Configuration conf)

getSnapshotName

public static String getSnapshotName(org.apache.hadoop.conf.Configuration conf)

getSystemTableForBulkLoadedDataDescriptor

public static TableDescriptor getSystemTableForBulkLoadedDataDescriptor(org.apache.hadoop.conf.Configuration conf)

Get backup system table descriptor

Returns:

table's descriptor

getTableNameForBulkLoadedData

public static TableName getTableNameForBulkLoadedData(org.apache.hadoop.conf.Configuration conf)

createPutForBackupInfo

private Put createPutForBackupInfo(BackupInfo context)
                            throws IOException

Creates Put operation for a given backup info object

Parameters:

context - backup info

Returns:

put operation

Throws:

IOException - exception

createGetForBackupInfo

private Get createGetForBackupInfo(String backupId)
                            throws IOException

Creates Get operation for a given backup id

Parameters:

backupId - backup's ID

Returns:

get operation

Throws:

IOException - exception

createDeleteForBackupInfo

private Delete createDeleteForBackupInfo(String backupId)

Creates Delete operation for a given backup id

Parameters:

backupId - backup's ID

Returns:

delete operation

resultToBackupInfo

private BackupInfo resultToBackupInfo(Result res)
                               throws IOException

Converts Result to BackupInfo

Parameters:

res - HBase result

Returns:

backup info instance

Throws:

IOException - exception

createGetForStartCode

private Get createGetForStartCode(String rootPath)
                           throws IOException

Creates Get operation to retrieve start code from backup system table

Returns:

get operation

Throws:

IOException - exception

createPutForStartCode

private Put createPutForStartCode(String startCode,
 String rootPath)

Creates Put operation to store start code to backup system table

Returns:

put operation

createGetForIncrBackupTableSet

private Get createGetForIncrBackupTableSet(String backupRoot)
                                    throws IOException

Creates Get to retrieve incremental backup table set from backup system table

Returns:

get operation

Throws:

IOException - exception

createPutForIncrBackupTableSet

private Put createPutForIncrBackupTableSet(Set<TableName> tables,
 String backupRoot)

Creates Put to store incremental backup table set

Parameters:

tables - tables

Returns:

put operation

createDeleteForIncrBackupTableSet

private Delete createDeleteForIncrBackupTableSet(String backupRoot)

Creates Delete for incremental backup table set

Parameters:

backupRoot - backup root

Returns:

delete operation

createScanForBackupHistory

private Scan createScanForBackupHistory()

Creates Scan operation to load backup history

Returns:

scan operation

cellToBackupInfo

private BackupInfo cellToBackupInfo(Cell current)
                             throws IOException

Converts cell to backup info instance.

Parameters:

current - current cell

Returns:

backup backup info instance

Throws:

IOException - exception

createPutForWriteRegionServerLogTimestamp

private Put createPutForWriteRegionServerLogTimestamp(TableName table,
 byte[] smap,
 String backupRoot)

Creates Put to write RS last roll log timestamp map

Parameters:

table - table

smap - map, containing RS:ts

Returns:

put operation

createScanForReadLogTimestampMap

private Scan createScanForReadLogTimestampMap(String backupRoot)

Creates Scan to load table-> { RS -> ts} map of maps

Returns:

scan operation

getTableNameForReadLogTimestampMap

private String getTableNameForReadLogTimestampMap(byte[] cloneRow)

Get table name from rowkey

Parameters:

cloneRow - rowkey

Returns:

table name

createPutForRegionServerLastLogRollResult

private Put createPutForRegionServerLastLogRollResult(String server,
 Long timestamp,
 String backupRoot)

Creates Put to store RS last log result

Parameters:

server - server name

timestamp - log roll result (timestamp)

Returns:

put operation

createScanForReadRegionServerLastLogRollResult

private Scan createScanForReadRegionServerLastLogRollResult(String backupRoot)

Creates Scan operation to load last RS log roll results

Returns:

scan operation

getServerNameForReadRegionServerLastLogRollResult

private String getServerNameForReadRegionServerLastLogRollResult(byte[] row)

Get server's name from rowkey

Parameters:

row - rowkey

Returns:

server's name

createPutForCommittedBulkload

static List<Put> createPutForCommittedBulkload(TableName table,
 byte[] region,
 Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)

snapshot

public static void snapshot(Connection conn)
                     throws IOException

Throws:

IOException

restoreFromSnapshot

public static void restoreFromSnapshot(Connection conn)
                                throws IOException

Throws:

IOException

snapshotExists

private static boolean snapshotExists(Admin admin,
 String snapshotName)
                               throws IOException

Throws:

IOException

snapshotExists

public static boolean snapshotExists(Connection conn)
                              throws IOException

Throws:

IOException

deleteSnapshot

public static void deleteSnapshot(Connection conn)
                           throws IOException

Throws:

IOException

createPutForPreparedBulkload

static List<Put> createPutForPreparedBulkload(TableName table,
 byte[] region,
 byte[] family,
 List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)

createDeleteForOrigBulkLoad

public static List<Delete> createDeleteForOrigBulkLoad(List<TableName> lst)

createPutForDeleteOperation

private Put createPutForDeleteOperation(String[] backupIdList)

createDeleteForBackupDeleteOperation

private Delete createDeleteForBackupDeleteOperation()

createGetForDeleteOperation

private Get createGetForDeleteOperation()

startDeleteOperation

public void startDeleteOperation(String[] backupIdList)
                          throws IOException

Throws:

IOException

finishDeleteOperation

public void finishDeleteOperation()
                           throws IOException

Throws:

IOException

getListOfBackupIdsFromDeleteOperation

public String[] getListOfBackupIdsFromDeleteOperation()
                                               throws IOException

Throws:

IOException

createPutForMergeOperation

private Put createPutForMergeOperation(String[] backupIdList)

isMergeInProgress

public boolean isMergeInProgress()
                          throws IOException

Throws:

IOException

createPutForUpdateTablesForMerge

private Put createPutForUpdateTablesForMerge(List<TableName> tables)

createDeleteForBackupMergeOperation

private Delete createDeleteForBackupMergeOperation()

createGetForMergeOperation

private Get createGetForMergeOperation()

startMergeOperation

public void startMergeOperation(String[] backupIdList)
                         throws IOException

Throws:

IOException

updateProcessedTablesForMerge

public void updateProcessedTablesForMerge(List<TableName> tables)
                                   throws IOException

Throws:

IOException

finishMergeOperation

public void finishMergeOperation()
                          throws IOException

Throws:

IOException

getListOfBackupIdsFromMergeOperation

public String[] getListOfBackupIdsFromMergeOperation()
                                              throws IOException

Throws:

IOException

createScanForOrigBulkLoadedFiles

static Scan createScanForOrigBulkLoadedFiles(TableName table)

getTableNameFromOrigBulkLoadRow

static String getTableNameFromOrigBulkLoadRow(String rowStr)

getRegionNameFromOrigBulkLoadRow

static String getRegionNameFromOrigBulkLoadRow(String rowStr)

createScanForBulkLoadedFiles

static Scan createScanForBulkLoadedFiles(String backupId)

createPutForBulkLoadedFile

static Put createPutForBulkLoadedFile(TableName tn,
 byte[] fam,
 String p,
 String backupId,
 long ts,
 int idx)

createScanForBackupSetList

private Scan createScanForBackupSetList()

Creates Scan operation to load backup set list

Returns:

scan operation

createGetForBackupSet

private Get createGetForBackupSet(String name)

Creates Get operation to load backup set content

Returns:

get operation

createDeleteForBackupSet

private Delete createDeleteForBackupSet(String name)

Creates Delete operation to delete backup set content

Parameters:

name - backup set's name

Returns:

delete operation

createPutForBackupSet

private Put createPutForBackupSet(String name,
 String[] tables)

Creates Put operation to update backup set content

Parameters:

name - backup set's name

tables - list of tables

Returns:

put operation

convertToByteArray

private byte[] convertToByteArray(String[] tables)

cellValueToBackupSet

private String[] cellValueToBackupSet(Cell current)

Converts cell to backup set list.

Parameters:

current - current cell

Returns:

backup set as array of table names

cellKeyToBackupSetName

private String cellKeyToBackupSetName(Cell current)

Converts cell key to backup set name.

Parameters:

current - current cell

Returns:

backup set name

rowkey

private static byte[] rowkey(String s,
 String... other)

ensureTableEnabled

private static void ensureTableEnabled(Admin admin,
 TableName tableName)
                                throws IOException

Throws:

IOException