org.apache.hadoop.hbase.backup.impl

Class BackupSystemTable

java.lang.Object

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

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public final class BackupSystemTable
extends Object
implements Closeable

This class provides 'hbase:backup' table API

Constructor Summary

Constructors

Constructor and Description
BackupSystemTable(Connection conn)

Method Summary

Modifier and Type	Method and 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)
void	addWALFiles(List<String> files, String backupId, String backupRoot) Register WAL files as eligible for deletion
void	close()
void	deleteBackupInfo(String backupId) Deletes backup status from hbase:backup table
void	deleteBackupSet(String name) Delete backup set
List<TableName>	describeBackupSet(String name) Get backup set description (list of tables)
ArrayList<BackupInfo>	getBackupContexts(BackupInfo.BackupState status) Get all backup session with a given status (in desc order by time)
ArrayList<BackupInfo>	getBackupHistory()
ArrayList<BackupInfo>	getBackupHistory(boolean onlyCompleted) Get all completed backup information (in desc order by time)
Set<TableName>	getIncrementalBackupTableSet(String backupRoot) Return the current tables covered by incremental backup.
static HTableDescriptor	getSystemTableDescriptor() Get backup system table descriptor
static TableName	getTableName()
static String	getTableNameAsString()
Iterator<org.apache.hadoop.hbase.backup.impl.BackupSystemTable.WALItem>	getWALFilesIterator(String backupRoot) Register WAL files as eligible for deletion
boolean	hasBackupSessions() Checks if we have at least one backup session in hbase:backup This API is used by BackupLogCleaner
boolean	isWALFileDeletable(String file) Check if WAL file is eligible for deletion Future: to support all backup destinations
List<String>	listBackupSets() Get backup set list
BackupInfo	readBackupInfo(String backupId) Reads backup status object (instance of BackupContext) from hbase:backup table
String	readBackupStartCode(String backupRoot) Read the last backup start code (timestamp) of last successful backup.
HashMap<TableName,HashMap<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 hbase:backup.
void	removeFromBackupSet(String name, String[] toRemove) Remove tables from backup set (list of tables)
void	updateBackupInfo(BackupInfo context) Updates status (state) of a backup session in hbase:backup table
void	writeBackupStartCode(Long startCode, String backupRoot) Write the start code (timestamp) to hbase:backup.
void	writeRegionServerLastLogRollResult(String server, Long ts, String backupRoot) Writes Region Server last roll log result (timestamp) to hbase:backup table
void	writeRegionServerLogTimestamp(Set<TableName> tables, HashMap<String,Long> newTimestamps, String backupRoot) Write the current timestamps for each regionserver to hbase:backup 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

Constructor Detail

BackupSystemTable

public BackupSystemTable(Connection conn)
                  throws IOException

Throws:

IOException

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

updateBackupInfo

public void updateBackupInfo(BackupInfo context)
                      throws IOException

Updates status (state) of a backup session in hbase:backup table

Parameters:

context - context

Throws:

IOException - exception

deleteBackupInfo

public void deleteBackupInfo(String backupId)
                      throws IOException

Deletes backup status from hbase:backup table

Parameters:

backupId - backup id

Throws:

IOException - exception

readBackupInfo

public BackupInfo readBackupInfo(String backupId)
                          throws IOException

Reads backup status object (instance of BackupContext) from hbase:backup table

Parameters:

backupId - - backupId

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 - root directory path to backup

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 hbase:backup. If passed in null, then write 0 byte.

Parameters:

startCode - start code

backupRoot - root directory path to backup

Throws:

IOException - exception

readRegionServerLastLogRollResult

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

Get the Region Servers log information after the last log roll from hbase:backup.

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 hbase:backup table

Parameters:

server - - Region Server name

timestamp - - 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:

onlyCompeleted, - true, if only successfully completed sessions

Returns:

history info of BackupCompleteData

Throws:

IOException - exception

getBackupHistory

public ArrayList<BackupInfo> getBackupHistory()
                                       throws IOException

Throws:

IOException

getBackupContexts

public ArrayList<BackupInfo> getBackupContexts(BackupInfo.BackupState status)
                                        throws IOException

Get all backup session with a given status (in desc order by time)

Parameters:

status - status

Returns:

history info of backup contexts

Throws:

IOException - exception

writeRegionServerLogTimestamp

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

Write the current timestamps for each regionserver to hbase:backup 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 HashMap<TableName,HashMap<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

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

addWALFiles

public void addWALFiles(List<String> files,
                        String backupId,
                        String backupRoot)
                 throws IOException

Register WAL files as eligible for deletion

Parameters:

files - files

backupId - backup id

backupRoot - root directory path to backup

Throws:

IOException - exception

getWALFilesIterator

public Iterator<org.apache.hadoop.hbase.backup.impl.BackupSystemTable.WALItem> getWALFilesIterator(String backupRoot)
                                                                                            throws IOException

Register WAL files as eligible for deletion

Parameters:

backupRoot - root directory path to backup

Throws:

IOException - exception

isWALFileDeletable

public boolean isWALFileDeletable(String file)
                           throws IOException

Check if WAL file is eligible for deletion Future: to support all backup destinations

Parameters:

file - file

Returns:

true, if - yes.

Throws:

IOException - exception

hasBackupSessions

public boolean hasBackupSessions()
                          throws IOException

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

Returns:

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

Throws:

IOException - exception

listBackupSets

public List<String> listBackupSets()
                            throws IOException

Get backup set list

Returns:

backup set list

Throws:

IOException

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

addToBackupSet

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

Add backup set (list of tables)

Parameters:

name - - set name

tables - - list of tables, comma-separated

Throws:

IOException

removeFromBackupSet

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

Remove tables from backup set (list of tables)

Parameters:

name - - set name

tables - - list of tables, comma-separated

Throws:

IOException

deleteBackupSet

public void deleteBackupSet(String name)
                     throws IOException

Delete backup set

Parameters:

name - set's name

Throws:

IOException

getSystemTableDescriptor

public static HTableDescriptor getSystemTableDescriptor()

Get backup system table descriptor

Returns:

descriptor

getTableNameAsString

public static String getTableNameAsString()

getTableName

public static TableName getTableName()