org.apache.hadoop.hbase.backup.impl

Class BackupManifest

java.lang.Object

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

@InterfaceAudience.Private
 @InterfaceStability.Evolving
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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BackupManifest.BackupImage

Field Summary

Fields

Modifier and Type	Field and Description
protected Configuration	config
static String	MANIFEST_FILE_NAME
static String	MANIFEST_VERSION

Constructor Summary

Constructors

Constructor and Description
BackupManifest(BackupInfo backupCtx) Construct manifest for a ongoing backup.
BackupManifest(BackupInfo backupCtx, TableName table) Construct a table level manifest for a backup of the named table.
BackupManifest(Configuration conf, Path backupPath) Construct manifest from a backup directory.

Method Summary

Modifier and Type	Method and 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.
Map<String,BackupManifest.BackupImage>	getDependency() Get all dependent backup images.
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,HashMap<String,Long>>	getIncrTimestampMap()
ArrayList<BackupManifest.BackupImage>	getRestoreDependentList(boolean reverse) Get the image list of this backup for restore in time order.
ArrayList<TableName>	getTableList() Get the table set of this image.
BackupType	getType()
String	getVersion() Get manifest file version
void	setIncrTimestampMap(HashMap<TableName,HashMap<String,Long>> incrTimestampMap) Set the incremental timestamp map directly.
void	setType(BackupType type)
void	store(Configuration conf) Persist the manifest file.
byte[]	toByteArray() Protobuf serialization

Methods inherited from class java.lang.Object

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

Field Detail

MANIFEST_FILE_NAME

public static final String MANIFEST_FILE_NAME

See Also:

Constant Field Values

MANIFEST_VERSION

public static final String MANIFEST_VERSION

See Also:

Constant Field Values

config

protected Configuration config

Constructor Detail

BackupManifest

public BackupManifest(BackupInfo backupCtx)

Construct manifest for a ongoing backup.

Parameters:

backupCtx - The ongoing backup context

BackupManifest

public BackupManifest(BackupInfo backupCtx,
                      TableName table)

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

Parameters:

backupCtx - The ongoing backup context

BackupManifest

public BackupManifest(Configuration conf,
                      Path backupPath)
               throws BackupException

Construct manifest from a backup directory.

Parameters:

conf - configuration

backupPath - backup path

Throws:

BackupException - exception

Method Detail

getType

public BackupType getType()

setType

public void setType(BackupType type)

getTableList

public ArrayList<TableName> getTableList()

Get the table set of this image.

Returns:

The table set list

store

public void store(Configuration conf)
           throws BackupException

Persist the manifest file.

Throws:

IOException - IOException when storing the manifest file.

BackupException

toByteArray

public byte[] toByteArray()

Protobuf serialization

Returns:

The filter serialized using pb

getVersion

public String getVersion()

Get manifest file version

Returns:

version

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

getDependency

public Map<String,BackupManifest.BackupImage> getDependency()

Get all dependent backup images. The image of this backup is also contained.

Returns:

The dependent backup images map

setIncrTimestampMap

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

Set the incremental timestamp map directly.

Parameters:

incrTimestampMap - timestamp map

getIncrTimestampMap

public Map<TableName,HashMap<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