org.apache.hadoop.hbase.master.procedure

Class CreateNamespaceProcedure

java.lang.Object

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

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

org.apache.hadoop.hbase.master.procedure.AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState>

org.apache.hadoop.hbase.master.procedure.CreateNamespaceProcedure

All Implemented Interfaces:

Comparable<Procedure<MasterProcedureEnv>>, TableProcedureInterface

@InterfaceAudience.Private
public class CreateNamespaceProcedure
extends AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState>

The procedure to create a new namespace.

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 and Description
private static org.slf4j.Logger	LOG
private NamespaceDescriptor	nsDescriptor
private Boolean	traceEnabled

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

NO_PROC_ID, NO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
CreateNamespaceProcedure()
CreateNamespaceProcedure(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor)
CreateNamespaceProcedure(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor, ProcedurePrepareLatch latch)

Method Summary

Modifier and Type	Method and Description
protected Procedure.LockState	acquireLock(MasterProcedureEnv env) The user should override this method if they need a lock on an Entity.
protected static void	createDirectory(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor) Create the namespace directory
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.CreateNamespaceState state) called to perform a single step of the specified 'state' of the procedure
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState	getInitialState() Return the initial state object that will be used for the first call to executeFromState().
protected String	getNamespaceName()
protected org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState	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.CreateNamespaceState state) Convert the Enum (or more descriptive) state object to an ordinal (or state id).
private static TableNamespaceManager	getTableNamespaceManager(MasterProcedureEnv env)
TableProcedureInterface.TableOperationType	getTableOperationType() Given an operation type we can take decisions about what to do with pending operations.
protected static void	insertIntoNSTable(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor) Insert the row into ns table
private boolean	isBootstrapNamespace()
protected boolean	isRollbackSupported(org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState state) Used by the default implementation of abort() to know if the current state can be aborted and rollback can be triggered.
private Boolean	isTraceEnabled() The procedure could be restarted from a different machine.
private boolean	prepareCreate(MasterProcedureEnv env) Action before any real action of creating namespace.
protected void	rollbackState(MasterProcedureEnv env, org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState 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.
protected static void	setNamespaceQuota(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor) Set quota for the namespace
protected boolean	shouldWaitClientAck(MasterProcedureEnv env) By default, the executor will keep the procedure result around util the eviction TTL is expired.
protected static void	updateZKNamespaceManager(MasterProcedureEnv env, NamespaceDescriptor nsDescriptor) Update ZooKeeper.
protected boolean	waitInitialized(MasterProcedureEnv env) The Procedure.doAcquireLock(Object, ProcedureStore) will be split into two steps, first, it will call us to determine whether we need to wait for initialization, second, it will call Procedure.acquireLock(Object) to actually handle the lock for this procedure.

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

getTableName, releaseLock, releaseSyncLatch, toStringClassDetails

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

abort, addChildProcedure, execute, failIfAborted, getCurrentState, getCurrentStateId, getCycles, 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, 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

nsDescriptor

private NamespaceDescriptor nsDescriptor

traceEnabled

private Boolean traceEnabled

Constructor Detail

CreateNamespaceProcedure

public CreateNamespaceProcedure()

CreateNamespaceProcedure

public CreateNamespaceProcedure(MasterProcedureEnv env,
                                NamespaceDescriptor nsDescriptor)

CreateNamespaceProcedure

public CreateNamespaceProcedure(MasterProcedureEnv env,
                                NamespaceDescriptor nsDescriptor,
                                ProcedurePrepareLatch latch)

Method Detail

executeFromState

protected StateMachineProcedure.Flow executeFromState(MasterProcedureEnv env,
                                                      org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState 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.CreateNamespaceState>

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.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState 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.CreateNamespaceState>

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

getState

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

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

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

Returns:

the initial state enum object

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

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

Parameters:

serializer - contains the serialized state

Throws:

IOException

isBootstrapNamespace

private boolean isBootstrapNamespace()

waitInitialized

protected boolean waitInitialized(MasterProcedureEnv env)

Description copied from class: Procedure

The Procedure.doAcquireLock(Object, ProcedureStore) will be split into two steps, first, it will call us to determine whether we need to wait for initialization, second, it will call Procedure.acquireLock(Object) to actually handle the lock for this procedure.

This is because that when master restarts, we need to restore the lock state for all the procedures to not break the semantic if Procedure.holdLock(Object) is true. But the ProcedureExecutor will be started before the master finish initialization(as it is part of the initialization!), so we need to split the code into two steps, and when restore, we just restore the lock part and ignore the waitInitialized part. Otherwise there will be dead lock.

Overrides:

waitInitialized in class AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState>

Returns:

true means we need to wait until the environment has been initialized, otherwise true.

acquireLock

protected Procedure.LockState acquireLock(MasterProcedureEnv env)

Description copied from class: Procedure

The user should override this method if they need a lock on an Entity. A lock can be anything, and it is up to the implementor. The Procedure Framework will call this method just before it invokes Procedure.execute(Object). It calls Procedure.releaseLock(Object) after the call to execute.

If you need to hold the lock for the life of the Procedure -- i.e. you do not want any other Procedure interfering while this Procedure is running, see Procedure.holdLock(Object).

Example: in our Master we can execute request in parallel for different tables. We can create t1 and create t2 and these creates can be executed at the same time. Anything else on t1/t2 is queued waiting that specific table create to happen.

There are 3 LockState:

• LOCK_ACQUIRED should be returned when the proc has the lock and the proc is ready to execute.
• LOCK_YIELD_WAIT should be returned when the proc has not the lock and the framework should take care of readding the procedure back to the runnable set for retry
• LOCK_EVENT_WAIT should be returned when the proc has not the lock and someone will take care of readding the procedure back to the runnable set when the lock is available.

Overrides:

acquireLock in class AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState>

Returns:

the lock state as described above.

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

Returns:

the operation type that the procedure is executing.

getNamespaceName

protected String getNamespaceName()

Specified by:

getNamespaceName in class AbstractStateMachineNamespaceProcedure<org.apache.hadoop.hbase.shaded.protobuf.generated.MasterProcedureProtos.CreateNamespaceState>

prepareCreate

private boolean prepareCreate(MasterProcedureEnv env)
                       throws IOException

Action before any real action of creating namespace.

Parameters:

env - MasterProcedureEnv

Throws:

IOException

createDirectory

protected static void createDirectory(MasterProcedureEnv env,
                                      NamespaceDescriptor nsDescriptor)
                               throws IOException

Create the namespace directory

Parameters:

env - MasterProcedureEnv

nsDescriptor - NamespaceDescriptor

Throws:

IOException

insertIntoNSTable

protected static void insertIntoNSTable(MasterProcedureEnv env,
                                        NamespaceDescriptor nsDescriptor)
                                 throws IOException

Insert the row into ns table

Parameters:

env - MasterProcedureEnv

nsDescriptor - NamespaceDescriptor

Throws:

IOException

updateZKNamespaceManager

protected static void updateZKNamespaceManager(MasterProcedureEnv env,
                                               NamespaceDescriptor nsDescriptor)
                                        throws IOException

Update ZooKeeper.

Parameters:

env - MasterProcedureEnv

nsDescriptor - NamespaceDescriptor

Throws:

IOException

setNamespaceQuota

protected static void setNamespaceQuota(MasterProcedureEnv env,
                                        NamespaceDescriptor nsDescriptor)
                                 throws IOException

Set quota for the namespace

Parameters:

env - MasterProcedureEnv

nsDescriptor - NamespaceDescriptor

Throws:

IOException

getTableNamespaceManager

private static TableNamespaceManager getTableNamespaceManager(MasterProcedureEnv env)

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

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.