org.apache.hadoop.hbase.regionserver.storefiletracker

Class ModifyStoreFileTrackerProcedure

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.ModifyStoreFileTrackerState>

org.apache.hadoop.hbase.regionserver.storefiletracker.ModifyStoreFileTrackerProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

Direct Known Subclasses:

ModifyColumnFamilyStoreFileTrackerProcedure, ModifyTableStoreFileTrackerProcedure

@InterfaceAudience.Private
public abstract class ModifyStoreFileTrackerProcedure
extends AbstractStateMachineTableProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState>

This procedure is used to change the store file tracker implementation.

Typically we need to schedule two ModifyTableProcedure (or three if the table is already in MIGRATION but the dstSFT is not what we expected) to do this, so we introduce this procedure to simplify the work of our users.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	ModifyStoreFileTrackerProcedure.StoreFileTrackerState

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 and Description
private String	dstSFT
private static org.slf4j.Logger	LOG
private TableName	tableName

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

Modifier	Constructor and Description
protected	ModifyStoreFileTrackerProcedure()
protected	ModifyStoreFileTrackerProcedure(MasterProcedureEnv env, TableName tableName, String dstSFT)

Method Summary

Modifier and Type	Method and Description
private void	checkDstSFT(String dstSFT)
private ModifyStoreFileTrackerProcedure.StoreFileTrackerState	checkState(org.apache.hadoop.conf.Configuration conf, String dstSFT)
protected abstract org.apache.hadoop.conf.Configuration	createConf(org.apache.hadoop.conf.Configuration conf, TableDescriptor current)
protected abstract TableDescriptor	createFinishTableDescriptor(TableDescriptor current)
protected abstract TableDescriptor	createMigrationTableDescriptor(org.apache.hadoop.conf.Configuration conf, TableDescriptor current)
protected abstract TableDescriptor	createRestoreTableDescriptor(TableDescriptor current, String restoreSFT)
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.ModifyStoreFileTrackerState state) called to perform a single step of the specified 'state' of the procedure
protected void	finish(BiConsumer<String,String> setValue, Consumer<String> removeValue)
private void	finish(MasterProcedureEnv env)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
private String	getRestoreSFT(org.apache.hadoop.conf.Configuration conf)
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState	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.ModifyStoreFileTrackerState 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.ModifyStoreFileTrackerState state) Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.
protected void	migrate(org.apache.hadoop.conf.Configuration conf, BiConsumer<String,String> setValue)
private void	migrate(MasterProcedureEnv env)
protected abstract void	preCheck(TableDescriptor current)
private StateMachineProcedure.Flow	preCheckAndTryRestoreSFT(MasterProcedureEnv env)
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState 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.

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

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

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

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, isEofState, 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, setFailure, setFailure, setLastUpdate, setNonceKey, setOwner, setOwner, setParentProcId, setProcId, setResult, setRootProcId, setStackIndexes, setState, setSubmittedTime, setTimeout, setTimeoutFailure, shouldWaitClientAck, skipPersistence, 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 Detail

LOG

private static final org.slf4j.Logger LOG

tableName

private TableName tableName

dstSFT

private String dstSFT

Constructor Detail

ModifyStoreFileTrackerProcedure

protected ModifyStoreFileTrackerProcedure()

ModifyStoreFileTrackerProcedure

protected ModifyStoreFileTrackerProcedure(MasterProcedureEnv env,
                                          TableName tableName,
                                          String dstSFT)
                                   throws HBaseIOException

Throws:

HBaseIOException

Method Detail

checkDstSFT

private void checkDstSFT(String dstSFT)
                  throws DoNotRetryIOException

Throws:

DoNotRetryIOException

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.ModifyStoreFileTrackerState>

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.ModifyStoreFileTrackerState>

Returns:

the operation type that the procedure is executing.

checkState

private ModifyStoreFileTrackerProcedure.StoreFileTrackerState checkState(org.apache.hadoop.conf.Configuration conf,
                                                                         String dstSFT)

getRestoreSFT

private final String getRestoreSFT(org.apache.hadoop.conf.Configuration conf)

preCheck

protected abstract void preCheck(TableDescriptor current)
                          throws IOException

Throws:

IOException

createConf

protected abstract org.apache.hadoop.conf.Configuration createConf(org.apache.hadoop.conf.Configuration conf,
                                                                   TableDescriptor current)

createRestoreTableDescriptor

protected abstract TableDescriptor createRestoreTableDescriptor(TableDescriptor current,
                                                                String restoreSFT)

preCheckAndTryRestoreSFT

private StateMachineProcedure.Flow preCheckAndTryRestoreSFT(MasterProcedureEnv env)
                                                     throws IOException

Throws:

IOException

createMigrationTableDescriptor

protected abstract TableDescriptor createMigrationTableDescriptor(org.apache.hadoop.conf.Configuration conf,
                                                                  TableDescriptor current)

migrate

protected final void migrate(org.apache.hadoop.conf.Configuration conf,
                             BiConsumer<String,String> setValue)

createFinishTableDescriptor

protected abstract TableDescriptor createFinishTableDescriptor(TableDescriptor current)

finish

protected final void finish(BiConsumer<String,String> setValue,
                            Consumer<String> removeValue)

migrate

private void migrate(MasterProcedureEnv env)
              throws IOException

Throws:

IOException

finish

private void finish(MasterProcedureEnv env)
             throws IOException

Throws:

IOException

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState state)
                                               throws ProcedureSuspendedException,
                                                      ProcedureYieldException,
                                                      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.ModifyStoreFileTrackerState>

state - state to execute

Returns:

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

Throws:

ProcedureSuspendedException

ProcedureYieldException

InterruptedException

rollbackState

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

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.ModifyStoreFileTrackerState>

state - state to rollback

Throws:

IOException - temporary failure, the rollback will retry later

InterruptedException

getState

protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState 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.ModifyStoreFileTrackerState>

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.ModifyStoreFileTrackerState 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.ModifyStoreFileTrackerState>

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.ModifyStoreFileTrackerState 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.ModifyStoreFileTrackerState>

Returns:

the initial state enum object

isRollbackSupported

protected boolean isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState 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.ModifyStoreFileTrackerState>

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.ModifyStoreFileTrackerState>

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.ModifyStoreFileTrackerState>

Parameters:

serializer - contains the serialized state

Throws:

IOException