AddColumnFamilyProcedure (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.procedure2.Procedure<TEnvironment>
- - org.apache.hadoop.hbase.procedure2.StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
  - - org.apache.hadoop.hbase.master.procedure.AddColumnFamilyProcedure

All Implemented Interfaces:: Comparable<Procedure>, TableProcedureInterface

@InterfaceAudience.Private
public class AddColumnFamilyProcedure
extends StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
implements TableProcedureInterface

The procedure to add a column family to an existing table.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure
  StateMachineProcedure.Flow
- 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 AtomicBoolean`	`aborted`
`private HColumnDescriptor`	`cfDescriptor`
`private static org.apache.commons.logging.Log`	`LOG`
`private List<HRegionInfo>`	`regionInfoList`
`private TableName`	`tableName`
`private Boolean`	`traceEnabled`
`private HTableDescriptor`	`unmodifiedHTableDescriptor`
`private org.apache.hadoop.security.UserGroupInformation`	`user`

Constructor Summary

Constructors
Constructor and Description
`AddColumnFamilyProcedure()`
`AddColumnFamilyProcedure(MasterProcedureEnv env, TableName tableName, HColumnDescriptor cfDescriptor)`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`abort(MasterProcedureEnv env)` The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable.
`protected boolean`	`acquireLock(MasterProcedureEnv env)` The user should override this method, and try to take a lock if necessary.
`void`	`deserializeStateData(InputStream stream)` Called on store load to allow the user to decode the previously serialized state.
`protected StateMachineProcedure.Flow`	`executeFromState(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` called to perform a single step of the specified 'state' of the procedure
`private String`	`getColumnFamilyName()`
`protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState`	`getInitialState()` Return the initial state object that will be used for the first call to executeFromState().
`private List<HRegionInfo>`	`getRegionInfoList(MasterProcedureEnv env)`
`protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState`	`getState(int stateId)` Convert an ordinal (or state id) to an Enum (or more descriptive) state object.
`protected int`	`getStateId(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` Convert the Enum (or more descriptive) state object to an ordinal (or state id).
`TableName`	`getTableName()`
`TableProcedureInterface.TableOperationType`	`getTableOperationType()` Given an operation type we can take decisions about what to do with pending operations.
`private Boolean`	`isTraceEnabled()` The procedure could be restarted from a different machine.
`private void`	`postAdd(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` Action after adding column family.
`private void`	`preAdd(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` Action before adding column family.
`private void`	`prepareAdd(MasterProcedureEnv env)` Action before any real action of adding column family.
`protected void`	`releaseLock(MasterProcedureEnv env)` The user should override this method, and release lock if necessary.
`private void`	`reOpenAllRegionsIfTableIsOnline(MasterProcedureEnv env)` Last action from the procedure - executed when online schema change is supported.
`private void`	`restoreTableDescriptor(MasterProcedureEnv env)` Restore the table descriptor back to pre-add
`protected void`	`rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` called to perform the rollback of the specified state
`private void`	`runCoprocessorAction(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` Coprocessor Action.
`void`	`serializeStateData(OutputStream stream)` The user-level code of the procedure may have some state to persist (e.g.
`protected void`	`setNextState(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)` Set the next state for the procedure.
`void`	`toStringClassDetails(StringBuilder sb)` Extend the toString() information with the procedure details e.g.
`private void`	`updateTableDescriptor(MasterProcedureEnv env)` Add the column family to the file system

Methods inherited from class org.apache.hadoop.hbase.procedure2.StateMachineProcedure
execute, isYieldAfterExecutionStep, isYieldBeforeExecuteFromState, rollback, toStringState

Methods inherited from class org.apache.hadoop.hbase.procedure2.Procedure
addStackIndex, beforeReplay, childrenCountDown, compareTo, completionCleanup, convert, convert, createProcedureInfo, doExecute, doRollback, elapsedTime, getException, getLastUpdate, getNonceKey, getOwner, getParentProcId, getProcId, getProcIdHashCode, getResult, getRootProcedureId, getStackIndexes, getStartTime, getState, getTimeout, getTimeRemaining, hasException, hasOwner, hasParent, hasTimeout, incChildrenLatch, isFailed, isFinished, isSuccess, isWaiting, newInstance, removeStackIndex, setAbortFailure, setChildrenLatch, setFailure, setFailure, setNonceKey, setOwner, setParentProcId, setProcId, setResult, setStackIndexes, setStartTime, setState, setTimeout, setTimeoutFailure, shouldWaitClientAck, toString, toStringClass, toStringDetails, toStringSimpleSB, updateTimestamp, validateClass, 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.apache.commons.logging.Log LOG
```
  - aborted
```
private final AtomicBoolean aborted
```
  - tableName
```
private TableName tableName
```
  - unmodifiedHTableDescriptor
```
private HTableDescriptor unmodifiedHTableDescriptor
```
  - cfDescriptor
```
private HColumnDescriptor cfDescriptor
```
  - user
```
private org.apache.hadoop.security.UserGroupInformation user
```
  - regionInfoList
```
private List<HRegionInfo> regionInfoList
```
  - traceEnabled
```
private Boolean traceEnabled
```
- Constructor Detail
  - AddColumnFamilyProcedure
```
public AddColumnFamilyProcedure()
```
  - AddColumnFamilyProcedure
```
public AddColumnFamilyProcedure(MasterProcedureEnv env,
                        TableName tableName,
                        HColumnDescriptor cfDescriptor)
```
- Method Detail
  - executeFromState
```
protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                          org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState 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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    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
  - rollbackState
```
protected void rollbackState(MasterProcedureEnv env,
                 org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState 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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    state - state to rollback
    
    Throws:
    
    IOException - temporary failure, the rollback will retry later
  - getState
```
protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState 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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Parameters:
    stateId - the ordinal() of the state enum (or state id)
    
    Returns:
    the state enum object
  - getStateId
```
protected int getStateId(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState 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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Parameters:
    state - the state enum object
    
    Returns:
    stateId the ordinal() of the state enum (or state id)
  - getInitialState
```
protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState 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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Returns:
    the initial state enum object
  - setNextState
```
protected void setNextState(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)
```
    Description copied from class: StateMachineProcedure
    
    Set the next state for the procedure.
    
    Overrides:
    
    setNextState in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Parameters:
    state - the state enum object
  - abort
```
public boolean abort(MasterProcedureEnv env)
```
    Description copied from class: Procedure
    
    The abort() call is asynchronous and each procedure must decide how to deal with that, if they want to be abortable. The simplest implementation is to have an AtomicBoolean set in the abort() method and then the execute() will check if the abort flag is set or not. abort() may be called multiple times from the client, so the implementation must be idempotent. NOTE: abort() is not like Thread.interrupt() it is just a notification that allows the procedure implementor where to abort to avoid leak and have a better control on what was executed and what not.
    
    Specified by:
    
    abort in class Procedure<MasterProcedureEnv>
  - acquireLock
```
protected boolean acquireLock(MasterProcedureEnv env)
```
    Description copied from class: Procedure
    
    The user should override this method, and try to take a lock if necessary. A lock can be anything, and it is up to the implementor. Example: in our Master we can execute request in parallel for different tables create t1 and create t2 can be executed at the same time. anything else on t1/t2 is queued waiting that specific table create to happen.
    
    Overrides:
    
    acquireLock in class Procedure<MasterProcedureEnv>
    
    Returns:
    true if the lock was acquired and false otherwise
  - releaseLock
```
protected void releaseLock(MasterProcedureEnv env)
```
    Description copied from class: Procedure
    
    The user should override this method, and release lock if necessary.
    
    Overrides:
    
    releaseLock in class Procedure<MasterProcedureEnv>
  - serializeStateData
```
public void serializeStateData(OutputStream stream)
                        throws IOException
```
    Description copied from class: Procedure
    
    The user-level code of the procedure may have some state to persist (e.g. input arguments) to be able to resume on failure.
    
    Overrides:
    
    serializeStateData in class StateMachineProcedure<MasterProcedureEnv,org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Parameters:
    stream - the stream that will contain the user serialized data
    
    Throws:
    
    IOException
  - deserializeStateData
```
public void deserializeStateData(InputStream stream)
                          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.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState>
    
    Parameters:
    stream - the stream that contains the user serialized data
    
    Throws:
    
    IOException
  - 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 Procedure<MasterProcedureEnv>
    
    Parameters:
    sb - the string builder to use to append the proc specific information
  - getTableName
```
public TableName getTableName()
```
    Specified by:
    
    getTableName in interface TableProcedureInterface
    
    Returns:
    the name of the table the procedure is operating on
  - 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
    
    Returns:
    the operation type that the procedure is executing.
  - prepareAdd
```
private void prepareAdd(MasterProcedureEnv env)
                 throws IOException
```
    Action before any real action of adding column family.
    
    Parameters:
    env - MasterProcedureEnv
    
    Throws:
    
    IOException
  - preAdd
```
private void preAdd(MasterProcedureEnv env,
          org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)
             throws IOException,
                    InterruptedException
```
    Action before adding column family.
    
    Parameters:
    env - MasterProcedureEnv
    state - the procedure state
    
    Throws:
    
    IOException
    
    InterruptedException
  - updateTableDescriptor
```
private void updateTableDescriptor(MasterProcedureEnv env)
                            throws IOException
```
    Add the column family to the file system
    
    Throws:
    
    IOException
  - restoreTableDescriptor
```
private void restoreTableDescriptor(MasterProcedureEnv env)
                             throws IOException
```
    Restore the table descriptor back to pre-add
    
    Parameters:
    env - MasterProcedureEnv
    
    Throws:
    
    IOException
  - postAdd
```
private void postAdd(MasterProcedureEnv env,
           org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)
              throws IOException,
                     InterruptedException
```
    Action after adding column family.
    
    Parameters:
    env - MasterProcedureEnv
    state - the procedure state
    
    Throws:
    
    IOException
    
    InterruptedException
  - reOpenAllRegionsIfTableIsOnline
```
private void reOpenAllRegionsIfTableIsOnline(MasterProcedureEnv env)
                                      throws IOException
```
    Last action from the procedure - executed when online schema change is supported.
    
    Parameters:
    env - MasterProcedureEnv
    
    Throws:
    
    IOException
  - isTraceEnabled
```
private Boolean isTraceEnabled()
```
    The procedure could be restarted from a different machine. If the variable is null, we need to retrieve it.
    
    Returns:
    traceEnabled
  - getColumnFamilyName
```
private String getColumnFamilyName()
```
  - runCoprocessorAction
```
private void runCoprocessorAction(MasterProcedureEnv env,
                        org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.AddColumnFamilyState state)
                           throws IOException,
                                  InterruptedException
```
    Coprocessor Action.
    
    Parameters:
    env - MasterProcedureEnv
    state - the procedure state
    
    Throws:
    
    IOException
    
    InterruptedException
  - getRegionInfoList
```
private List<HRegionInfo> getRegionInfoList(MasterProcedureEnv env)
                                     throws IOException
```
    Throws:
    
    IOException

Class AddColumnFamilyProcedure

Nested Class Summary

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

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

Field Summary

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Field Detail

LOG

aborted

tableName

unmodifiedHTableDescriptor

cfDescriptor

user

regionInfoList

traceEnabled

Constructor Detail

AddColumnFamilyProcedure

AddColumnFamilyProcedure

Method Detail

executeFromState

rollbackState

getState

getStateId

getInitialState

setNextState

abort

acquireLock

releaseLock

serializeStateData

deserializeStateData

toStringClassDetails

getTableName

getTableOperationType

prepareAdd

preAdd

updateTableDescriptor

restoreTableDescriptor

postAdd

reOpenAllRegionsIfTableIsOnline

isTraceEnabled

getColumnFamilyName

runCoprocessorAction

getRegionInfoList