org.apache.hadoop.hbase.master.snapshot

类 SnapshotManager

java.lang.Object

org.apache.hadoop.hbase.procedure.ProcedureManager

org.apache.hadoop.hbase.procedure.MasterProcedureManager

org.apache.hadoop.hbase.master.snapshot.SnapshotManager

所有已实现的接口:

Stoppable

@InterfaceAudience.LimitedPrivate(value="Configuration")
@InterfaceStability.Unstable
public class SnapshotManager
extends MasterProcedureManager
implements Stoppable

This class manages the procedure of taking and restoring snapshots. There is only one SnapshotManager for the master.

The class provides methods for monitoring in-progress snapshot actions.

Note: Currently there can only be one snapshot being taken at a time over the cluster. This is a simplification in the current implementation.

字段概要

字段

限定符和类型	字段和说明
static String	HBASE_SNAPSHOT_ENABLED Enable or disable snapshot support
static String	HBASE_SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLIS Wait time before removing a finished sentinel from the in-progress map NOTE: This is used as a safety auto cleanup.
static String	ONLINE_SNAPSHOT_CONTROLLER_DESCRIPTION Name of the operation to use in the controller
static int	SNAPSHOT_POOL_THREADS_DEFAULT number of current operations running on the master
static String	SNAPSHOT_POOL_THREADS_KEY Conf key for # of threads used by the SnapshotManager thread pool
static long	SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLS_DEFAULT

构造器概要

构造器

构造器和说明
SnapshotManager()

方法概要

方法

限定符和类型	方法和说明
void	checkSnapshotSupport() Throws an exception if snapshot operations (take a snapshot, restore, clone) are not supported.
void	deleteSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) Delete the specified snapshot
void	execProcedure(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc) Execute a distributed procedure on cluster
List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription>	getCompletedSnapshots() Gets the list of all completed snapshots.
String	getProcedureSignature() Return the unique signature of the procedure.
ReadWriteLock	getTakingSnapshotLock()
void	initialize(MasterServices master, MetricsMaster metricsMaster) Initialize a globally barriered procedure for master.
boolean	isProcedureDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc) Check if the procedure is finished successfully
boolean	isRestoreDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) Returns the status of a restore operation.
boolean	isSnapshotDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription expected) Check if the specified snapshot is done
boolean	isStopped()
boolean	isTakingAnySnapshot() The snapshot operation processing as following: 1.
void	restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot) 已过时。
void	restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot, boolean restoreAcl) Restore the specified snapshot
void	setSnapshotHandlerForTesting(TableName tableName, SnapshotSentinel handler) Set the handler for the current snapshot Exposed for TESTING
void	stop(String why)
void	takeSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot) Take a snapshot based on the enabled/disabled state of the table.

从类继承的方法 org.apache.hadoop.hbase.procedure.MasterProcedureManager

execProcedureWithRet

从类继承的方法 org.apache.hadoop.hbase.procedure.ProcedureManager

equals, hashCode

从类继承的方法 java.lang.Object

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

字段详细资料

HBASE_SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLIS

public static final String HBASE_SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLIS

Wait time before removing a finished sentinel from the in-progress map NOTE: This is used as a safety auto cleanup. The snapshot and restore handlers map entries are removed when a user asks if a snapshot or restore is completed. This operation is part of the HBaseAdmin snapshot/restore API flow. In case something fails on the client side and the snapshot/restore state is not reclaimed after a default timeout, the entry is removed from the in-progress map. At this point, if the user asks for the snapshot/restore status, the result will be snapshot done if exists or failed if it doesn't exists.

另请参阅:

常量字段值

SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLS_DEFAULT

public static final long SNAPSHOT_SENTINELS_CLEANUP_TIMEOUT_MILLS_DEFAULT

另请参阅:

常量字段值

HBASE_SNAPSHOT_ENABLED

public static final String HBASE_SNAPSHOT_ENABLED

Enable or disable snapshot support

另请参阅:

常量字段值

ONLINE_SNAPSHOT_CONTROLLER_DESCRIPTION

public static final String ONLINE_SNAPSHOT_CONTROLLER_DESCRIPTION

Name of the operation to use in the controller

另请参阅:

常量字段值

SNAPSHOT_POOL_THREADS_KEY

public static final String SNAPSHOT_POOL_THREADS_KEY

Conf key for # of threads used by the SnapshotManager thread pool

另请参阅:

常量字段值

SNAPSHOT_POOL_THREADS_DEFAULT

public static final int SNAPSHOT_POOL_THREADS_DEFAULT

number of current operations running on the master

另请参阅:

常量字段值

构造器详细资料

SnapshotManager

public SnapshotManager()

方法详细资料

getCompletedSnapshots

public List<org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription> getCompletedSnapshots()
                                                                                                       throws IOException

Gets the list of all completed snapshots.

返回:

list of SnapshotDescriptions

抛出:

IOException - File system exception

deleteSnapshot

public void deleteSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                    throws IOException

Delete the specified snapshot

参数:

snapshot -

抛出:

SnapshotDoesNotExistException - If the specified snapshot does not exist.

IOException - For filesystem IOExceptions

isSnapshotDone

public boolean isSnapshotDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription expected)
                       throws IOException

Check if the specified snapshot is done

参数:

expected -

返回:

true if snapshot is ready to be restored, false if it is still being taken.

抛出:

IOException - IOException if error from HDFS or RPC

UnknownSnapshotException - if snapshot is invalid or does not exist.

takeSnapshot

public void takeSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                  throws IOException

Take a snapshot based on the enabled/disabled state of the table.

参数:

snapshot -

抛出:

HBaseSnapshotException - when a snapshot specific exception occurs.

IOException - when some sort of generic IO exception occurs.

getTakingSnapshotLock

public ReadWriteLock getTakingSnapshotLock()

isTakingAnySnapshot

public boolean isTakingAnySnapshot()

The snapshot operation processing as following:
1. Create a Snapshot Handler, and do some initialization;
2. Put the handler into snapshotHandlers
So when we consider if any snapshot is taking, we should consider both the takingSnapshotLock and snapshotHandlers;

返回:

true to indicate that there're some running snapshots.

setSnapshotHandlerForTesting

public void setSnapshotHandlerForTesting(TableName tableName,
                                SnapshotSentinel handler)

Set the handler for the current snapshot

Exposed for TESTING

参数:

tableName -

handler - handler the master should use TODO get rid of this if possible, repackaging, modify tests.

restoreSnapshot

@Deprecated
public void restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot)
                     throws IOException

已过时。

Restore the specified snapshot

参数:

reqSnapshot - the snapshot to restore

抛出:

IOException

restoreSnapshot

public void restoreSnapshot(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription reqSnapshot,
                   boolean restoreAcl)
                     throws IOException

Restore the specified snapshot

参数:

reqSnapshot - the snapshot to restore

restoreAcl - whether or not to restore ACLs on the snapshot

抛出:

IOException

isRestoreDone

public boolean isRestoreDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.SnapshotDescription snapshot)
                      throws IOException

Returns the status of a restore operation. If the in-progress restore is failed throws the exception that caused the failure.

参数:

snapshot -

返回:

false if in progress, true if restore is completed or not requested.

抛出:

IOException - if there was a failure during the restore

stop

public void stop(String why)

指定者:

stop 在接口中 Stoppable

isStopped

public boolean isStopped()

指定者:

isStopped 在接口中 Stoppable

checkSnapshotSupport

public void checkSnapshotSupport()
                          throws UnsupportedOperationException

Throws an exception if snapshot operations (take a snapshot, restore, clone) are not supported. Called at the beginning of snapshot() and restoreSnapshot() methods.

抛出:

UnsupportedOperationException - if snapshot are not supported

initialize

public void initialize(MasterServices master,
              MetricsMaster metricsMaster)
                throws org.apache.zookeeper.KeeperException,
                       IOException,
                       UnsupportedOperationException

从类复制的说明: MasterProcedureManager

Initialize a globally barriered procedure for master.

指定者:

initialize 在类中 MasterProcedureManager

参数:

master - Master service interface

抛出:

org.apache.zookeeper.KeeperException

IOException

UnsupportedOperationException

getProcedureSignature

public String getProcedureSignature()

从类复制的说明: ProcedureManager

Return the unique signature of the procedure. This signature uniquely identifies the procedure. By default, this signature is the string used in the procedure controller (i.e., the root ZK node name for the procedure)

指定者:

getProcedureSignature 在类中 ProcedureManager

execProcedure

public void execProcedure(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc)
                   throws IOException

从类复制的说明: MasterProcedureManager

Execute a distributed procedure on cluster

覆盖:

execProcedure 在类中 MasterProcedureManager

参数:

desc - Procedure description

抛出:

IOException

isProcedureDone

public boolean isProcedureDone(org.apache.hadoop.hbase.protobuf.generated.HBaseProtos.ProcedureDescription desc)
                        throws IOException

从类复制的说明: MasterProcedureManager

Check if the procedure is finished successfully

指定者:

isProcedureDone 在类中 MasterProcedureManager

参数:

desc - Procedure description

返回:

true if the specified procedure is finished successfully

抛出:

IOException