org.apache.hadoop.hbase

Interface TableStateManager

All Known Implementing Classes:

ZKTableStateManager

@InterfaceAudience.Private
public interface TableStateManager

Helper class for table state management for operations running inside RegionServer or HMaster. Depending on implementation, fetches information from HBase system table, local data store, ZooKeeper ensemble or somewhere else. Code running on client side (with no coordinated state context) shall instead use ZKTableStateClientSideReader

Method Summary

Modifier and Type	Method and Description
void	checkAndRemoveTableState(TableName tableName, ZooKeeperProtos.Table.State states, boolean deletePermanentState) If the table is found in the given state the in-memory state is removed.
Set<TableName>	getTablesInStates(ZooKeeperProtos.Table.State... states)
boolean	isTablePresent(TableName tableName) Checks if table is present.
boolean	isTableState(TableName tableName, boolean checkSource, ZooKeeperProtos.Table.State... states)
boolean	isTableState(TableName tableName, ZooKeeperProtos.Table.State... states)
void	setDeletedTable(TableName tableName) Mark table as deleted.
void	setTableState(TableName tableName, ZooKeeperProtos.Table.State state) Sets the table into desired state.
boolean	setTableStateIfInStates(TableName tableName, ZooKeeperProtos.Table.State newState, ZooKeeperProtos.Table.State... states) Sets the specified table into the newState, but only if the table is already in one of the possibleCurrentStates (otherwise no operation is performed).
boolean	setTableStateIfNotInStates(TableName tableName, ZooKeeperProtos.Table.State newState, ZooKeeperProtos.Table.State... states) Sets the specified table into the newState, but only if the table is NOT in one of the possibleCurrentStates (otherwise no operation is performed).

Method Detail

setTableState

void setTableState(TableName tableName,
                   ZooKeeperProtos.Table.State state)
            throws CoordinatedStateException

Sets the table into desired state. Fails silently if the table is already in this state.

Parameters:

tableName - table to process

state - new state of this table

Throws:

CoordinatedStateException - if error happened when trying to set table state

setTableStateIfInStates

boolean setTableStateIfInStates(TableName tableName,
                                ZooKeeperProtos.Table.State newState,
                                ZooKeeperProtos.Table.State... states)
                         throws CoordinatedStateException

Sets the specified table into the newState, but only if the table is already in one of the possibleCurrentStates (otherwise no operation is performed).

Parameters:

tableName - table to process

newState - new state for the table

states - table should be in one of these states for the operation to be performed

Returns:

true if operation succeeded, false otherwise

Throws:

CoordinatedStateException - if error happened while performing operation

setTableStateIfNotInStates

boolean setTableStateIfNotInStates(TableName tableName,
                                   ZooKeeperProtos.Table.State newState,
                                   ZooKeeperProtos.Table.State... states)
                            throws CoordinatedStateException

Sets the specified table into the newState, but only if the table is NOT in one of the possibleCurrentStates (otherwise no operation is performed).

Parameters:

tableName - table to process

newState - new state for the table

states - table should NOT be in one of these states for the operation to be performed

Returns:

true if operation succeeded, false otherwise

Throws:

CoordinatedStateException - if error happened while performing operation

isTableState

boolean isTableState(TableName tableName,
                     ZooKeeperProtos.Table.State... states)

Returns:

true if the table is in any one of the listed states, false otherwise.

isTableState

boolean isTableState(TableName tableName,
                     boolean checkSource,
                     ZooKeeperProtos.Table.State... states)

Returns:

true if the table is in any one of the listed states, false otherwise.

setDeletedTable

void setDeletedTable(TableName tableName)
              throws CoordinatedStateException

Mark table as deleted. Fails silently if the table is not currently marked as disabled.

Parameters:

tableName - table to be deleted

Throws:

CoordinatedStateException - if error happened while performing operation

isTablePresent

boolean isTablePresent(TableName tableName)

Checks if table is present.

Parameters:

tableName - table we're checking

Returns:

true if the table is present, false otherwise

getTablesInStates

Set<TableName> getTablesInStates(ZooKeeperProtos.Table.State... states)
                          throws InterruptedIOException,
                                 CoordinatedStateException

Returns:

set of tables which are in any one of the listed states, empty Set if none

Throws:

InterruptedIOException

CoordinatedStateException

checkAndRemoveTableState

void checkAndRemoveTableState(TableName tableName,
                              ZooKeeperProtos.Table.State states,
                              boolean deletePermanentState)
                       throws CoordinatedStateException

If the table is found in the given state the in-memory state is removed. This helps in cases where CreateTable is to be retried by the client in case of failures. If deletePermanentState is true - the flag kept permanently is also reset.

Parameters:

tableName - table we're working on

states - if table isn't in any one of these states, operation aborts

deletePermanentState - if true, reset the permanent flag

Throws:

CoordinatedStateException - if error happened in underlying coordination engine