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

Class BackupManifest

java.lang.Object

org.apache.hadoop.hbase.backup.impl.BackupManifest

@Private
public class BackupManifest
extends Object

Backup manifest contains all the meta data of a backup image. The manifest info will be bundled as manifest file together with data. So that each backup image will contain all the info needed for restore. BackupManifest is a storage container for BackupImage. It is responsible for storing/reading backup image data and has some additional utility methods.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BackupManifest.BackupImage	Backup image, the dependency graph is made up by series of backup images BackupImage contains all the relevant information to restore the backup and is used during restore operation

Field Summary

Fields

Modifier and Type	Field	Description
private BackupManifest.BackupImage	backupImage
private static final org.slf4j.Logger	LOG
static final String	MANIFEST_FILE_NAME

Constructor Summary

Constructors

Constructor	Description
BackupManifest(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path backupPath)	Construct manifest from a backup directory.
BackupManifest(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.fs.Path backupPath)	Construct manifest from a backup directory.
BackupManifest(BackupInfo backup)	Construct manifest for a ongoing backup.
BackupManifest(BackupInfo backup, TableName table)	Construct a table level manifest for a backup of the named table.

Method Summary

Modifier and Type	Method	Description
void	addDependentImage(BackupManifest.BackupImage image)	Add dependent backup image for this backup.
static boolean	canCoverImage(ArrayList<BackupManifest.BackupImage> fullImages, BackupManifest.BackupImage image)	Check whether backup image set could cover a backup image or not.
static boolean	canCoverImage(BackupManifest.BackupImage image1, BackupManifest.BackupImage image2)	Check whether backup image1 could cover backup image2 or not.
ArrayList<BackupManifest.BackupImage>	getAllDependentListByTable(TableName table)	Get the full dependent image list in the whole dependency scope for a specific table of this backup in time order from old to new.
BackupManifest.BackupImage	getBackupImage()	Get this backup image.
ArrayList<BackupManifest.BackupImage>	getDependentListByTable(TableName table)	Get the dependent image list for a specific table of this backup in time order from old to new if want to restore to this backup image level.
Map<TableName,Map<String,Long>>	getIncrTimestampMap()
ArrayList<BackupManifest.BackupImage>	getRestoreDependentList(boolean reverse)	Get the image list of this backup for restore in time order.
List<TableName>	getTableList()	Get the table set of this image.
BackupType	getType()
void	setIncrTimestampMap(Map<TableName,Map<String,Long>> incrTimestampMap)	Set the incremental timestamp map directly.
void	store(org.apache.hadoop.conf.Configuration conf)	TODO: fix it.
BackupInfo	toBackupInfo()

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

MANIFEST_FILE_NAME

public static final String MANIFEST_FILE_NAME

See Also:

• Constant Field Values

backupImage

private BackupManifest.BackupImage backupImage

Constructor Details

BackupManifest

public BackupManifest(BackupInfo backup)

Construct manifest for a ongoing backup.

Parameters:

backup - The ongoing backup info

BackupManifest

public BackupManifest(BackupInfo backup,
 TableName table)

Construct a table level manifest for a backup of the named table.

Parameters:

backup - The ongoing backup session info

BackupManifest

public BackupManifest(org.apache.hadoop.conf.Configuration conf,
 org.apache.hadoop.fs.Path backupPath)
               throws IOException

Construct manifest from a backup directory.

Parameters:

conf - configuration

backupPath - backup path

Throws:

IOException - if constructing the manifest from the backup directory fails

BackupManifest

public BackupManifest(org.apache.hadoop.fs.FileSystem fs,
 org.apache.hadoop.fs.Path backupPath)
               throws BackupException

Construct manifest from a backup directory.

Parameters:

fs - the FileSystem

backupPath - backup path

Throws:

BackupException - exception

Method Details

getType

public BackupType getType()

getTableList

public List<TableName> getTableList()

Get the table set of this image.

Returns:

The table set list

store

public void store(org.apache.hadoop.conf.Configuration conf)
           throws BackupException

TODO: fix it. Persist the manifest file.

Throws:

BackupException - if an error occurred while storing the manifest file.

getBackupImage

public BackupManifest.BackupImage getBackupImage()

Get this backup image.

Returns:

the backup image.

addDependentImage

public void addDependentImage(BackupManifest.BackupImage image)

Add dependent backup image for this backup.

Parameters:

image - The direct dependent backup image

setIncrTimestampMap

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

Set the incremental timestamp map directly.

Parameters:

incrTimestampMap - timestamp map

getIncrTimestampMap

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

getRestoreDependentList

public ArrayList<BackupManifest.BackupImage> getRestoreDependentList(boolean reverse)

Get the image list of this backup for restore in time order.

Parameters:

reverse - If true, then output in reverse order, otherwise in time order from old to new

Returns:

the backup image list for restore in time order

getDependentListByTable

public ArrayList<BackupManifest.BackupImage> getDependentListByTable(TableName table)

Get the dependent image list for a specific table of this backup in time order from old to new if want to restore to this backup image level.

Parameters:

table - table

Returns:

the backup image list for a table in time order

getAllDependentListByTable

public ArrayList<BackupManifest.BackupImage> getAllDependentListByTable(TableName table)

Get the full dependent image list in the whole dependency scope for a specific table of this backup in time order from old to new.

Parameters:

table - table

Returns:

the full backup image list for a table in time order in the whole scope of the dependency of this image

canCoverImage

public static boolean canCoverImage(BackupManifest.BackupImage image1,
 BackupManifest.BackupImage image2)

Check whether backup image1 could cover backup image2 or not.

Parameters:

image1 - backup image 1

image2 - backup image 2

Returns:

true if image1 can cover image2, otherwise false

canCoverImage

public static boolean canCoverImage(ArrayList<BackupManifest.BackupImage> fullImages,
 BackupManifest.BackupImage image)

Check whether backup image set could cover a backup image or not.

Parameters:

fullImages - The backup image set

image - The target backup image

Returns:

true if fullImages can cover image, otherwise false

toBackupInfo

public BackupInfo toBackupInfo()