CreateTableProcedure (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.CreateTableState>
  - - org.apache.hadoop.hbase.master.procedure.CreateTableProcedure

All Implemented Interfaces:: Comparable<Procedure>, TableProcedureInterface

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected static interface CreateTableProcedure.CreateHdfsRegions
- 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

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`CreateTableProcedure.CreateHdfsRegions`

Field Summary

Fields
Modifier and Type	Field and Description
`private AtomicBoolean`	`aborted`
`private HTableDescriptor`	`hTableDescriptor`
`private static org.apache.commons.logging.Log`	`LOG`
`private List<HRegionInfo>`	`newRegions`
`private ProcedurePrepareLatch`	`syncLatch`
`private org.apache.hadoop.security.UserGroupInformation`	`user`

Constructor Summary

Constructors
Constructor and Description
`CreateTableProcedure()`
`CreateTableProcedure(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, HRegionInfo[] newRegions)`
`CreateTableProcedure(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, HRegionInfo[] newRegions, ProcedurePrepareLatch syncLatch)`

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.
`protected static void`	`addRegionsToMeta(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, List<HRegionInfo> regionInfos)` Add the specified set of regions to the hbase:meta table.
`private static List<HRegionInfo>`	`addReplicas(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, List<HRegionInfo> regions)` Create any replicas for the regions (the default replicas that was already created is passed to the method)
`protected static List<HRegionInfo>`	`addTableToMeta(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, List<HRegionInfo> regions)`
`protected static void`	`assignRegions(MasterProcedureEnv env, TableName tableName, List<HRegionInfo> regions)`
`protected static List<HRegionInfo>`	`createFsLayout(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, List<HRegionInfo> newRegions)`
`protected static List<HRegionInfo>`	`createFsLayout(MasterProcedureEnv env, HTableDescriptor hTableDescriptor, List<HRegionInfo> newRegions, CreateTableProcedure.CreateHdfsRegions hdfsRegionHandler)`
`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.CreateTableState state)` called to perform a single step of the specified 'state' of the procedure
`protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState`	`getInitialState()` Return the initial state object that will be used for the first call to executeFromState().
`protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState`	`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.CreateTableState 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 void`	`postCreate(MasterProcedureEnv env)`
`private void`	`preCreate(MasterProcedureEnv env)`
`private boolean`	`prepareCreate(MasterProcedureEnv env)`
`protected void`	`releaseLock(MasterProcedureEnv env)` The user should override this method, and release lock if necessary.
`protected void`	`rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState state)` called to perform the rollback of the specified state
`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.CreateTableState state)` Set the next state for the procedure.
`protected boolean`	`shouldWaitClientAck(MasterProcedureEnv env)` By default, the executor will keep the procedure result around util the eviction TTL is expired.
`void`	`toStringClassDetails(StringBuilder sb)` Extend the toString() information with the procedure details e.g.
`protected static void`	`updateTableDescCache(MasterProcedureEnv env, TableName tableName)`

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, 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
```
  - syncLatch
```
private final ProcedurePrepareLatch syncLatch
```
  - hTableDescriptor
```
private HTableDescriptor hTableDescriptor
```
  - newRegions
```
private List<HRegionInfo> newRegions
```
  - user
```
private org.apache.hadoop.security.UserGroupInformation user
```
- Constructor Detail
  - CreateTableProcedure
```
public CreateTableProcedure()
```
  - CreateTableProcedure
```
public CreateTableProcedure(MasterProcedureEnv env,
                    HTableDescriptor hTableDescriptor,
                    HRegionInfo[] newRegions)
```
  - CreateTableProcedure
```
public CreateTableProcedure(MasterProcedureEnv env,
                    HTableDescriptor hTableDescriptor,
                    HRegionInfo[] newRegions,
                    ProcedurePrepareLatch syncLatch)
```
- Method Detail
  - executeFromState
```
protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                          org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState 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.CreateTableState>
    
    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.CreateTableState 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.CreateTableState>
    
    state - state to rollback
    
    Throws:
    
    IOException - temporary failure, the rollback will retry later
  - getState
```
protected org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState 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.CreateTableState>
    
    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.CreateTableState 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.CreateTableState>
    
    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.CreateTableState 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.CreateTableState>
    
    Returns:
    the initial state enum object
  - setNextState
```
protected void setNextState(org.apache.hadoop.hbase.protobuf.generated.MasterProcedureProtos.CreateTableState 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.CreateTableState>
    
    Parameters:
    state - the state enum object
  - 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.
  - 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>
  - 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
  - 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.CreateTableState>
    
    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.CreateTableState>
    
    Parameters:
    stream - the stream that contains the user serialized data
    
    Throws:
    
    IOException
  - 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>
  - prepareCreate
```
private boolean prepareCreate(MasterProcedureEnv env)
                       throws IOException
```
    Throws:
    
    IOException
  - preCreate
```
private void preCreate(MasterProcedureEnv env)
                throws IOException,
                       InterruptedException
```
    Throws:
    
    IOException
    
    InterruptedException
  - postCreate
```
private void postCreate(MasterProcedureEnv env)
                 throws IOException,
                        InterruptedException
```
    Throws:
    
    IOException
    
    InterruptedException
  - createFsLayout
```
protected static List<HRegionInfo> createFsLayout(MasterProcedureEnv env,
                               HTableDescriptor hTableDescriptor,
                               List<HRegionInfo> newRegions)
                                           throws IOException
```
    Throws:
    
    IOException
  - createFsLayout
```
protected static List<HRegionInfo> createFsLayout(MasterProcedureEnv env,
                               HTableDescriptor hTableDescriptor,
                               List<HRegionInfo> newRegions,
                               CreateTableProcedure.CreateHdfsRegions hdfsRegionHandler)
                                           throws IOException
```
    Throws:
    
    IOException
  - addTableToMeta
```
protected static List<HRegionInfo> addTableToMeta(MasterProcedureEnv env,
                               HTableDescriptor hTableDescriptor,
                               List<HRegionInfo> regions)
                                           throws IOException
```
    Throws:
    
    IOException
  - addReplicas
```
private static List<HRegionInfo> addReplicas(MasterProcedureEnv env,
                            HTableDescriptor hTableDescriptor,
                            List<HRegionInfo> regions)
```
    Create any replicas for the regions (the default replicas that was already created is passed to the method)
    
    Parameters:
    hTableDescriptor - descriptor to use
    regions - default replicas
    
    Returns:
    the combined list of default and non-default replicas
  - assignRegions
```
protected static void assignRegions(MasterProcedureEnv env,
                 TableName tableName,
                 List<HRegionInfo> regions)
                             throws HBaseException,
                                    IOException
```
    Throws:
    
    HBaseException
    
    IOException
  - addRegionsToMeta
```
protected static void addRegionsToMeta(MasterProcedureEnv env,
                    HTableDescriptor hTableDescriptor,
                    List<HRegionInfo> regionInfos)
                                throws IOException
```
    Add the specified set of regions to the hbase:meta table.
    
    Throws:
    
    IOException
  - updateTableDescCache
```
protected static void updateTableDescCache(MasterProcedureEnv env,
                        TableName tableName)
                                    throws IOException
```
    Throws:
    
    IOException
  - shouldWaitClientAck
```
protected boolean shouldWaitClientAck(MasterProcedureEnv env)
```
    Description copied from class: Procedure
    
    By default, the executor will keep the procedure result around util the eviction TTL is expired. The client can cut down the waiting time by requesting that the result is removed from the executor. In case of system started procedure, we can force the executor to auto-ack.
    
    Overrides:
    
    shouldWaitClientAck in class Procedure<MasterProcedureEnv>
    
    Parameters:
    env - the environment passed to the ProcedureExecutor
    
    Returns:
    true if the executor should wait the client ack for the result. Defaults to return true.

Class CreateTableProcedure

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

syncLatch

hTableDescriptor

newRegions

user

Constructor Detail

CreateTableProcedure

CreateTableProcedure

CreateTableProcedure

Method Detail

executeFromState

rollbackState

getState

getStateId

getInitialState

setNextState

getTableName

getTableOperationType

abort

toStringClassDetails

serializeStateData

deserializeStateData

acquireLock

releaseLock

prepareCreate

preCreate

postCreate

createFsLayout

createFsLayout

addTableToMeta

addReplicas

assignRegions

addRegionsToMeta

updateTableDescCache

shouldWaitClientAck