Package org.apache.hadoop.hbase.master.procedure

Class CloneSnapshotProcedure

java.lang.Object

org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>

org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,TState>

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

org.apache.hadoop.hbase.master.procedure.CloneSnapshotProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@Private
public class CloneSnapshotProcedure
extends AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

StateMachineProcedure.Flow

Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.Procedure

Procedure.LockState

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.master.procedure.TableProcedureInterface

TableProcedureInterface.TableOperationType

Field Summary

Fields

Modifier and Type	Field	Description
private String	customSFT
private static final org.slf4j.Logger	LOG
private MonitoredTask	monitorStatus
private List<RegionInfo>	newRegions
private Map<String,Pair<String,String>>	parentsToChildrenPairMap
private boolean	restoreAcl
private org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription	snapshot
private TableDescriptor	tableDescriptor

Fields inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

stateCount

Fields inherited from class org.apache.hadoop.hbase.procedure2.Procedure

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor	Description
CloneSnapshotProcedure()	Constructor (for failover)
CloneSnapshotProcedure(MasterProcedureEnv env, TableDescriptor tableDescriptor, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot)
CloneSnapshotProcedure(MasterProcedureEnv env, TableDescriptor tableDescriptor, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, boolean restoreAcl)	Constructor
CloneSnapshotProcedure(MasterProcedureEnv env, TableDescriptor tableDescriptor, org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot, boolean restoreAcl, String customSFT)

Method Summary

Modifier and Type	Method	Description
private void	addRegionsToMeta(MasterProcedureEnv env)	Add regions to hbase:meta table.
private List<RegionInfo>	createFilesystemLayout(MasterProcedureEnv env, TableDescriptor tableDescriptor, List<RegionInfo> newRegions)	Create regions in file system.
private List<RegionInfo>	createFsLayout(MasterProcedureEnv env, TableDescriptor tableDescriptor, List<RegionInfo> newRegions, CreateTableProcedure.CreateHdfsRegions hdfsRegionHandler)	Create region layout in file system.
protected void	deserializeStateData(ProcedureStateSerializer serializer)	Called on store load to allow the user to decode the previously serialized state.
protected StateMachineProcedure.Flow	executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)	called to perform a single step of the specified 'state' of the procedure
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState	getInitialState()	Return the initial state object that will be used for the first call to executeFromState().
private MonitoredTask	getMonitorStatus()	Set up monitor status if it is not created.
boolean	getRestoreAcl()	Exposed for Testing: HBASE-26462
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState	getState(int stateId)	Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
protected int	getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)	Convert the Enum (or more descriptive) state object to an ordinal (or state id).
TableName	getTableName()	Returns the name of the table the procedure is operating on
TableProcedureInterface.TableOperationType	getTableOperationType()	Given an operation type we can take decisions about what to do with pending operations.
protected boolean	isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)	Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.
private void	postCloneSnapshot(MasterProcedureEnv env)	Action after cloning from snapshot.
private void	preCloneSnapshot(MasterProcedureEnv env)	Action before cloning from snapshot.
private void	prepareClone(MasterProcedureEnv env)	Action before any real action of cloning from snapshot.
private void	restoreSnapshotAcl(MasterProcedureEnv env)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)	called to perform the rollback of the specified state
protected void	serializeStateData(ProcedureStateSerializer serializer)	The user-level code of the procedure may have some state to persist (e.g.
void	toStringClassDetails(StringBuilder sb)	Extend the toString() information with the procedure details e.g.
private void	updateTableDescriptorWithSFT()	If a StoreFileTracker is specified we strip the TableDescriptor from previous SFT config and set the specified SFT on the table level
private void	validateSFT()

Methods inherited from class org.apache.hadoop.hbase.master.procedure.AbstractStateMachineTableProcedure

acquireLock, checkOnline, checkTableModifiable, getUser, getWALRegionDir, isTableEnabled, preflightChecks, releaseLock, releaseSyncLatch, setUser, waitInitialized

Methods inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, isRollbackSupported, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, setNextState, toStringState

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure

addStackIndex, afterReplay, beforeReplay, bypass, compareTo, completionCleanup, doExecute, doRollback, elapsedTime, getChildrenLatch, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcedureMetrics, getProcId, getProcIdHashCode, getProcName, getResult, getRootProcedureId, getRootProcId, getStackIndexes, getState, getSubmittedTime, getTimeout, getTimeoutTimestamp, hasChildren, hasException, hasLock, hasOwner, hasParent, hasTimeout, haveSameParent, holdLock, incChildrenLatch, isBypass, isFailed, isFinished, isInitializing, isLockedWhenLoading, isRunnable, isSuccess, isWaiting, removeStackIndex, setAbortFailure, setChildrenLatch, setExecuted, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, suspend, toString, toStringClass, toStringDetails, toStringSimpleSB, updateMetricsOnFinish, updateMetricsOnSubmit, updateTimestamp, wasExecuted

Methods inherited from class java.lang.Object

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

Field Details

LOG

private static final org.slf4j.Logger LOG

tableDescriptor

private TableDescriptor tableDescriptor

snapshot

private org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot

restoreAcl

private boolean restoreAcl

customSFT

private String customSFT

newRegions

private List<RegionInfo> newRegions

parentsToChildrenPairMap

private Map<String,Pair<String,String>> parentsToChildrenPairMap

monitorStatus

private MonitoredTask monitorStatus

Constructor Details

CloneSnapshotProcedure

public CloneSnapshotProcedure()

Constructor (for failover)

CloneSnapshotProcedure

public CloneSnapshotProcedure(MasterProcedureEnv env,
 TableDescriptor tableDescriptor,
 org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot)

CloneSnapshotProcedure

public CloneSnapshotProcedure(MasterProcedureEnv env,
 TableDescriptor tableDescriptor,
 org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot,
 boolean restoreAcl)

Constructor

Parameters:

env - MasterProcedureEnv

tableDescriptor - the table to operate on

snapshot - snapshot to clone from

CloneSnapshotProcedure

public CloneSnapshotProcedure(MasterProcedureEnv env,
 TableDescriptor tableDescriptor,
 org.apache.hadoop.hbase.shaded.protobuf.generated.SnapshotProtos.SnapshotDescription snapshot,
 boolean restoreAcl,
 String customSFT)

Method Details

getMonitorStatus

private MonitoredTask getMonitorStatus()

Set up monitor status if it is not created.

restoreSnapshotAcl

private void restoreSnapshotAcl(MasterProcedureEnv env)
                         throws IOException

Throws:

IOException

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)
                                               throws InterruptedException

Description copied from class: StateMachineProcedure

called to perform a single step of the specified 'state' of the procedure

Specified by:

executeFromState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

state - state to execute

Returns:

Flow.NO_MORE_STATE if the procedure is completed, Flow.HAS_MORE_STATE if there is another step.

Throws:

InterruptedException

updateTableDescriptorWithSFT

private void updateTableDescriptorWithSFT()

If a StoreFileTracker is specified we strip the TableDescriptor from previous SFT config and set the specified SFT on the table level

validateSFT

private void validateSFT()

rollbackState

protected void rollbackState(MasterProcedureEnv env,
 org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)
                      throws IOException

Description copied from class: StateMachineProcedure

called to perform the rollback of the specified state

Specified by:

rollbackState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

isRollbackSupported

protected boolean isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)

Description copied from class: StateMachineProcedure

Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.

Overrides:

isRollbackSupported in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState getState(int stateId)

Description copied from class: StateMachineProcedure

Convert an ordinal (or state id) to an Enum (or more descriptive) state object.

Specified by:

getState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Parameters:

stateId - the ordinal() of the state enum (or state id)

Returns:

the state enum object

getStateId

protected int getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState state)

Description copied from class: StateMachineProcedure

Convert the Enum (or more descriptive) state object to an ordinal (or state id).

Specified by:

getStateId in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Parameters:

state - the state enum object

Returns:

stateId the ordinal() of the state enum (or state id)

getInitialState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState getInitialState()

Description copied from class: StateMachineProcedure

Return the initial state object that will be used for the first call to executeFromState().

Specified by:

getInitialState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Returns:

the initial state enum object

getTableName

public TableName getTableName()

Description copied from interface: TableProcedureInterface

Returns the name of the table the procedure is operating on

Specified by:

getTableName in interface TableProcedureInterface

Specified by:

getTableName in class AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

getTableOperationType

public TableProcedureInterface.TableOperationType getTableOperationType()

Description copied from interface: TableProcedureInterface

Given an operation type we can take decisions about what to do with pending operations. e.g. if we get a delete and we have some table operation pending (e.g. add column) we can abort those operations.

Specified by:

getTableOperationType in interface TableProcedureInterface

Specified by:

getTableOperationType in class AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Returns:

the operation type that the procedure is executing.

toStringClassDetails

public void toStringClassDetails(StringBuilder sb)

Description copied from class: Procedure

Extend the toString() information with the procedure details e.g. className and parameters

Overrides:

toStringClassDetails in class AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Parameters:

sb - the string builder to use to append the proc specific information

serializeStateData

protected void serializeStateData(ProcedureStateSerializer serializer)
                           throws IOException

Description copied from class: Procedure

The user-level code of the procedure may have some state to persist (e.g. input arguments or current position in the processing state) to be able to resume on failure.

Overrides:

serializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Parameters:

serializer - stores the serializable state

Throws:

IOException

deserializeStateData

protected void deserializeStateData(ProcedureStateSerializer serializer)
                             throws IOException

Description copied from class: Procedure

Called on store load to allow the user to decode the previously serialized state.

Overrides:

deserializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CloneSnapshotState>

Parameters:

serializer - contains the serialized state

Throws:

IOException

prepareClone

private void prepareClone(MasterProcedureEnv env)
                   throws IOException

Action before any real action of cloning from snapshot.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

preCloneSnapshot

private void preCloneSnapshot(MasterProcedureEnv env)
                       throws IOException,
InterruptedException

Action before cloning from snapshot.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

InterruptedException

postCloneSnapshot

private void postCloneSnapshot(MasterProcedureEnv env)
                        throws IOException,
InterruptedException

Action after cloning from snapshot.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

InterruptedException

createFilesystemLayout

private List<RegionInfo> createFilesystemLayout(MasterProcedureEnv env,
 TableDescriptor tableDescriptor,
 List<RegionInfo> newRegions)
                                         throws IOException

Create regions in file system.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

createFsLayout

private List<RegionInfo> createFsLayout(MasterProcedureEnv env,
 TableDescriptor tableDescriptor,
 List<RegionInfo> newRegions,
 CreateTableProcedure.CreateHdfsRegions hdfsRegionHandler)
                                 throws IOException

Create region layout in file system.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

addRegionsToMeta

private void addRegionsToMeta(MasterProcedureEnv env)
                       throws IOException

Add regions to hbase:meta table.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

getRestoreAcl

public boolean getRestoreAcl()

Exposed for Testing: HBASE-26462