org.apache.hadoop.hbase.backup.util

Class BackupClientUtil

java.lang.Object

org.apache.hadoop.hbase.backup.util.BackupClientUtil

@InterfaceAudience.Private
 @InterfaceStability.Evolving
public final class BackupClientUtil
extends Object

A collection of methods used by multiple classes to backup HBase tables.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	LOG
static String	LOGNAME_SEPARATOR

Method Summary

Modifier and Type	Method and Description
static boolean	checkPathExist(String backupStr, Configuration conf) Check whether the backup path exist
static void	checkTargetDir(String backupRootPath, Configuration conf)
static void	cleanupBackupData(BackupInfo context, Configuration conf)
static Long	getCreationTime(Path p) Given the log file, parse the timestamp from the file name.
static List<String>	getFiles(FileSystem fs, Path rootDir, List<String> files, PathFilter filter)
static String	getLogBackupDir(String backupRootDir, String backupId) Given the backup root dir and the backup id, return the log file location for an incremental backup.
static <T> Long	getMinValue(HashMap<T,Long> map) Get the min value for all the Values a map.
static String	getPath(Path p) Return the 'path' component of a Path.
static String	getTableBackupDir(String backupRootDir, String backupId, TableName tableName) Given the backup root dir, backup id and the table name, return the backup image location, which is also where the backup manifest file is.
static String	getUniqueWALFileNamePart(Path p) Returns WAL file name
static String	getUniqueWALFileNamePart(String walFileName) Returns WAL file name
static FileStatus[]	listStatus(FileSystem fs, Path dir, PathFilter filter) Calls fs.listStatus() and treats FileNotFoundException as non-fatal This accommodates differences between hadoop versions, where hadoop 1 does not throw a FileNotFoundException, and return an empty FileStatus[] while Hadoop 2 will throw FileNotFoundException.
static String	parseHostFromOldLog(Path p) Parses host name:port from archived WAL path
static TableName[]	parseTableNames(String tables)
static ArrayList<BackupInfo>	sortHistoryListDesc(ArrayList<BackupInfo> historyList) Sort history list by start time in descending order.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final Log LOG

LOGNAME_SEPARATOR

public static final String LOGNAME_SEPARATOR

See Also:

Constant Field Values

Method Detail

checkPathExist

public static boolean checkPathExist(String backupStr,
                                     Configuration conf)
                              throws IOException

Check whether the backup path exist

Parameters:

backupStr - backup

conf - configuration

Returns:

Yes if path exists

Throws:

IOException - exception

checkTargetDir

public static void checkTargetDir(String backupRootPath,
                                  Configuration conf)
                           throws IOException

Throws:

IOException

getMinValue

public static <T> Long getMinValue(HashMap<T,Long> map)

Get the min value for all the Values a map.

Parameters:

map - map

Returns:

the min value

parseHostFromOldLog

public static String parseHostFromOldLog(Path p)
                                  throws IOException

Parses host name:port from archived WAL path

Parameters:

p - path

Returns:

host name

Throws:

IOException - exception

getCreationTime

public static Long getCreationTime(Path p)
                            throws IOException

Given the log file, parse the timestamp from the file name. The timestamp is the last number.

Parameters:

p - a path to the log file

Returns:

the timestamp

Throws:

IOException - exception

getFiles

public static List<String> getFiles(FileSystem fs,
                                    Path rootDir,
                                    List<String> files,
                                    PathFilter filter)
                             throws FileNotFoundException,
                                    IOException

Throws:

FileNotFoundException

IOException

cleanupBackupData

public static void cleanupBackupData(BackupInfo context,
                                     Configuration conf)
                              throws IOException

Throws:

IOException

getTableBackupDir

public static String getTableBackupDir(String backupRootDir,
                                       String backupId,
                                       TableName tableName)

Given the backup root dir, backup id and the table name, return the backup image location, which is also where the backup manifest file is. return value look like: "hdfs://backup.hbase.org:9000/user/biadmin/backup1/backup_1396650096738/default/t1_dn/"

Parameters:

backupRootDir - backup root directory

backupId - backup id

table - table name

Returns:

backupPath String for the particular table

parseTableNames

public static TableName[] parseTableNames(String tables)

sortHistoryListDesc

public static ArrayList<BackupInfo> sortHistoryListDesc(ArrayList<BackupInfo> historyList)

Sort history list by start time in descending order.

Parameters:

historyList - history list

Returns:

sorted list of BackupCompleteData

getUniqueWALFileNamePart

public static String getUniqueWALFileNamePart(String walFileName)
                                       throws IOException

Returns WAL file name

Parameters:

walFileName - WAL file name

Returns:

WAL file name

Throws:

IOException - exception

IllegalArgumentException - exception

getUniqueWALFileNamePart

public static String getUniqueWALFileNamePart(Path p)
                                       throws IOException

Returns WAL file name

Parameters:

p - - WAL file path

Returns:

WAL file name

Throws:

IOException - exception

listStatus

public static FileStatus[] listStatus(FileSystem fs,
                                      Path dir,
                                      PathFilter filter)
                               throws IOException

Calls fs.listStatus() and treats FileNotFoundException as non-fatal This accommodates differences between hadoop versions, where hadoop 1 does not throw a FileNotFoundException, and return an empty FileStatus[] while Hadoop 2 will throw FileNotFoundException.

Parameters:

fs - file system

dir - directory

filter - path filter

Returns:

null if dir is empty or doesn't exist, otherwise FileStatus array

Throws:

IOException

getPath

public static String getPath(Path p)

Return the 'path' component of a Path. In Hadoop, Path is an URI. This method returns the 'path' component of a Path's URI: e.g. If a Path is hdfs://example.org:9000/hbase_trunk/TestTable/compaction.dir, this method returns /hbase_trunk/TestTable/compaction.dir. This method is useful if you want to print out a Path without qualifying Filesystem instance.

Parameters:

p - Filesystem Path whose 'path' component we are to return.

Returns:

Path portion of the Filesystem

getLogBackupDir

public static String getLogBackupDir(String backupRootDir,
                                     String backupId)

Given the backup root dir and the backup id, return the log file location for an incremental backup.

Parameters:

backupRootDir - backup root directory

backupId - backup id

Returns:

logBackupDir: ".../user/biadmin/backup1/WALs/backup_1396650096738"