ModifyStoreFileTrackerProcedure (Apache HBase

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/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 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

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`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)`
`protected StateMachineProcedure.Flow`	`executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState state)`
`protected void`	`finish(BiConsumer<String,String> setValue, Consumer<String> removeValue)`
`protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState`	`getInitialState()`
`protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState`	`getState(int stateId)`
`protected int`	`getStateId(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState state)`
`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)`
`protected void`	`migrate(org.apache.hadoop.conf.Configuration conf, BiConsumer<String,String> setValue)`
`protected abstract void`	`preCheck(TableDescriptor current)`
`protected void`	`rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState state)`
`protected void`	`serializeStateData(ProcedureStateSerializer serializer)`

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

Constructor Detail

ModifyStoreFileTrackerProcedure

protected ModifyStoreFileTrackerProcedure()

ModifyStoreFileTrackerProcedure

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

Throws:: HBaseIOException

Method Detail

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.

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)

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)

executeFromState

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

Specified by:: executeFromState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.ModifyStoreFileTrackerState>
Throws:: ProcedureSuspendedException; ProcedureYieldException; InterruptedException

rollbackState

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