org.apache.hadoop.hbase.master

Interface MasterServices

All Superinterfaces:

Abortable, Server, Stoppable

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster

@InterfaceAudience.Private
public interface MasterServices
extends Server

A curated subset of services provided by HMaster. For use internally only. Passed to Managers, Services and Chores so can pass less-than-a full-on HMaster at test-time. Be judicious adding API. Changes cause ripples through the code base.

Method Summary

Modifier and Type	Method and Description
boolean	abortProcedure(long procId, boolean mayInterruptIfRunning) Abort a procedure.
long	addColumn(TableName tableName, ColumnFamilyDescriptor column, long nonceGroup, long nonce) Add a new column to an existing table
long	addReplicationPeer(String peerId, ReplicationPeerConfig peerConfig, boolean enabled) Add a new replication peer for replicating data to slave cluster
void	checkIfShouldMoveSystemRegionAsync() Called when a new RegionServer is added to the cluster.
void	checkTableModifiable(TableName tableName) Check table is modifiable; i.e.
long	createSystemTable(TableDescriptor tableDescriptor) Create a system table using the given table definition.
long	createTable(TableDescriptor desc, byte[][] splitKeys, long nonceGroup, long nonce) Create a table using the given table definition.
long	deleteColumn(TableName tableName, byte[] columnName, long nonceGroup, long nonce) Delete a column from an existing table
long	deleteTable(TableName tableName, long nonceGroup, long nonce) Delete a table
long	disableReplicationPeer(String peerId) Stop the replication stream to the specified peer
long	disableTable(TableName tableName, long nonceGroup, long nonce) Disable an existing table
long	enableReplicationPeer(String peerId) Restart the replication stream to the specified peer
long	enableTable(TableName tableName, long nonceGroup, long nonce) Enable an existing table
List<RegionPlan>	executeRegionPlansWithThrottling(List<RegionPlan> plans) Execute region plans with throttling
AccessChecker	getAccessChecker()
AssignmentManager	getAssignmentManager()
CatalogJanitor	getCatalogJanitor()
String	getClientIdAuditPrefix()
ClusterSchema	getClusterSchema()
ExecutorService	getExecutorService()
FavoredNodesManager	getFavoredNodesManager()
ProcedureEvent<?>	getInitializedEvent()
long	getLastMajorCompactionTimestamp(TableName table)
long	getLastMajorCompactionTimestampForRegion(byte[] regionName)
LoadBalancer	getLoadBalancer()
LockManager	getLockManager()
List<LockedResource>	getLocks() Get locks
MasterCoprocessorHost	getMasterCoprocessorHost()
MasterFileSystem	getMasterFileSystem()
MetricsMaster	getMasterMetrics()
ProcedureExecutor<MasterProcedureEnv>	getMasterProcedureExecutor()
MasterProcedureManagerHost	getMasterProcedureManagerHost()
MasterQuotaManager	getMasterQuotaManager()
MasterWalManager	getMasterWalManager()
List<Procedure<?>>	getProcedures() Get procedures
RegionNormalizer	getRegionNormalizer()
String	getRegionServerVersion(ServerName sn)
ReplicationPeerConfig	getReplicationPeerConfig(String peerId) Returns the configured ReplicationPeerConfig for the specified peer
ReplicationPeerManager	getReplicationPeerManager() Returns the ReplicationPeerManager.
ServerManager	getServerManager()
SnapshotManager	getSnapshotManager()
default SplitWALManager	getSplitWALManager()
SyncReplicationReplayWALManager	getSyncReplicationReplayWALManager() Returns the SyncReplicationReplayWALManager.
TableDescriptors	getTableDescriptors()
TableStateManager	getTableStateManager()
ZKPermissionWatcher	getZKPermissionWatcher()
boolean	isActiveMaster()
boolean	isClusterUp()
boolean	isInitialized()
boolean	isInMaintenanceMode()
boolean	isSplitOrMergeEnabled(MasterSwitchType switchType)
List<ReplicationPeerDescription>	listReplicationPeers(String regex) Return a list of replication peers.
List<TableDescriptor>	listTableDescriptorsByNamespace(String name) Get list of table descriptors by namespace
List<TableName>	listTableNamesByNamespace(String name) Get list of table names by namespace
long	mergeRegions(RegionInfo[] regionsToMerge, boolean forcible, long nonceGroup, long nonce) Merge regions in a table.
long	modifyColumn(TableName tableName, ColumnFamilyDescriptor descriptor, long nonceGroup, long nonce) Modify the column descriptor of an existing column in an existing table
long	modifyTable(TableName tableName, TableDescriptor descriptor, long nonceGroup, long nonce) Modify the descriptor of an existing table
boolean	registerService(com.google.protobuf.Service instance) Registers a new protocol buffer Service subclass as a master coprocessor endpoint.
long	removeReplicationPeer(String peerId) Removes a peer and stops the replication
long	splitRegion(RegionInfo regionInfo, byte[] splitRow, long nonceGroup, long nonce) Split a region.
long	transitReplicationPeerSyncReplicationState(String peerId, SyncReplicationState clusterState) Set current cluster state for a synchronous replication peer.
long	truncateTable(TableName tableName, boolean preserveSplits, long nonceGroup, long nonce) Truncate a table
long	updateReplicationPeerConfig(String peerId, ReplicationPeerConfig peerConfig) Update the peerConfig for the specified peer

Methods inherited from interface org.apache.hadoop.hbase.Server

createConnection, getAsyncClusterConnection, getAsyncConnection, getChoreService, getConfiguration, getConnection, getCoordinatedStateManager, getFileSystem, getServerName, getZooKeeper, isStopping

Methods inherited from interface org.apache.hadoop.hbase.Abortable

abort, isAborted

Methods inherited from interface org.apache.hadoop.hbase.Stoppable

isStopped, stop

Method Detail

getSnapshotManager

SnapshotManager getSnapshotManager()

Returns:

the underlying snapshot manager

getMasterProcedureManagerHost

MasterProcedureManagerHost getMasterProcedureManagerHost()

Returns:

the underlying MasterProcedureManagerHost

getClusterSchema

ClusterSchema getClusterSchema()

Returns:

Master's instance of ClusterSchema

getAssignmentManager

AssignmentManager getAssignmentManager()

Returns:

Master's instance of the AssignmentManager

getMasterFileSystem

MasterFileSystem getMasterFileSystem()

Returns:

Master's filesystem MasterFileSystem utility class.

getMasterWalManager

MasterWalManager getMasterWalManager()

Returns:

Master's WALs MasterWalManager utility class.

getServerManager

ServerManager getServerManager()

Returns:

Master's ServerManager instance.

getExecutorService

ExecutorService getExecutorService()

Returns:

Master's instance of ExecutorService

getTableStateManager

TableStateManager getTableStateManager()

Returns:

Master's instance of TableStateManager

getMasterCoprocessorHost

MasterCoprocessorHost getMasterCoprocessorHost()

Returns:

Master's instance of MasterCoprocessorHost

getMasterQuotaManager

MasterQuotaManager getMasterQuotaManager()

Returns:

Master's instance of MasterQuotaManager

getRegionNormalizer

RegionNormalizer getRegionNormalizer()

Returns:

Master's instance of RegionNormalizer

getCatalogJanitor

CatalogJanitor getCatalogJanitor()

Returns:

Master's instance of CatalogJanitor

getMasterProcedureExecutor

ProcedureExecutor<MasterProcedureEnv> getMasterProcedureExecutor()

Returns:

Master's instance of ProcedureExecutor

getInitializedEvent

ProcedureEvent<?> getInitializedEvent()

Returns:

Tripped when Master has finished initialization.

getMasterMetrics

MetricsMaster getMasterMetrics()

Returns:

Master's instance of MetricsMaster

checkTableModifiable

void checkTableModifiable(TableName tableName)
                   throws IOException,
                          TableNotFoundException,
                          TableNotDisabledException

Check table is modifiable; i.e. exists and is offline.

Parameters:

tableName - Name of table to check.

Throws:

TableNotDisabledException

TableNotFoundException

IOException

createTable

long createTable(TableDescriptor desc,
                 byte[][] splitKeys,
                 long nonceGroup,
                 long nonce)
          throws IOException

Create a table using the given table definition.

Parameters:

desc - The table definition

splitKeys - Starting row keys for the initial table regions. If null

nonceGroup -

nonce - a single region is created.

Throws:

IOException

createSystemTable

long createSystemTable(TableDescriptor tableDescriptor)
                throws IOException

Create a system table using the given table definition.

Parameters:

tableDescriptor - The system table definition a single region is created.

Throws:

IOException

deleteTable

long deleteTable(TableName tableName,
                 long nonceGroup,
                 long nonce)
          throws IOException

Delete a table

Parameters:

tableName - The table name

nonceGroup -

nonce -

Throws:

IOException

truncateTable

long truncateTable(TableName tableName,
                   boolean preserveSplits,
                   long nonceGroup,
                   long nonce)
            throws IOException

Truncate a table

Parameters:

tableName - The table name

preserveSplits - True if the splits should be preserved

nonceGroup -

nonce -

Throws:

IOException

modifyTable

long modifyTable(TableName tableName,
                 TableDescriptor descriptor,
                 long nonceGroup,
                 long nonce)
          throws IOException

Modify the descriptor of an existing table

Parameters:

tableName - The table name

descriptor - The updated table descriptor

nonceGroup -

nonce -

Throws:

IOException

enableTable

long enableTable(TableName tableName,
                 long nonceGroup,
                 long nonce)
          throws IOException

Enable an existing table

Parameters:

tableName - The table name

nonceGroup -

nonce -

Throws:

IOException

disableTable

long disableTable(TableName tableName,
                  long nonceGroup,
                  long nonce)
           throws IOException

Disable an existing table

Parameters:

tableName - The table name

nonceGroup -

nonce -

Throws:

IOException

addColumn

long addColumn(TableName tableName,
               ColumnFamilyDescriptor column,
               long nonceGroup,
               long nonce)
        throws IOException

Add a new column to an existing table

Parameters:

tableName - The table name

column - The column definition

nonceGroup -

nonce -

Throws:

IOException

modifyColumn

long modifyColumn(TableName tableName,
                  ColumnFamilyDescriptor descriptor,
                  long nonceGroup,
                  long nonce)
           throws IOException

Modify the column descriptor of an existing column in an existing table

Parameters:

tableName - The table name

descriptor - The updated column definition

nonceGroup -

nonce -

Throws:

IOException

deleteColumn

long deleteColumn(TableName tableName,
                  byte[] columnName,
                  long nonceGroup,
                  long nonce)
           throws IOException

Delete a column from an existing table

Parameters:

tableName - The table name

columnName - The column name

nonceGroup -

nonce -

Throws:

IOException

mergeRegions

long mergeRegions(RegionInfo[] regionsToMerge,
                  boolean forcible,
                  long nonceGroup,
                  long nonce)
           throws IOException

Merge regions in a table.

Parameters:

regionsToMerge - daughter regions to merge

forcible - whether to force to merge even two regions are not adjacent

nonceGroup - used to detect duplicate

nonce - used to detect duplicate

Returns:

procedure Id

Throws:

IOException

splitRegion

long splitRegion(RegionInfo regionInfo,
                 byte[] splitRow,
                 long nonceGroup,
                 long nonce)
          throws IOException

Split a region.

Parameters:

regionInfo - region to split

splitRow - split point

nonceGroup - used to detect duplicate

nonce - used to detect duplicate

Returns:

procedure Id

Throws:

IOException

getTableDescriptors

TableDescriptors getTableDescriptors()

Returns:

Return table descriptors implementation.

registerService

boolean registerService(com.google.protobuf.Service instance)

Registers a new protocol buffer Service subclass as a master coprocessor endpoint.

Only a single instance may be registered for a given Service subclass (the instances are keyed on Descriptors.ServiceDescriptor.getFullName(). After the first registration, subsequent calls with the same service name will fail with a return value of false.

Parameters:

instance - the Service subclass instance to expose as a coprocessor endpoint

Returns:

true if the registration was successful, false otherwise

isActiveMaster

boolean isActiveMaster()

Returns:

true if master is the active one

isInitialized

boolean isInitialized()

Returns:

true if master is initialized

isInMaintenanceMode

boolean isInMaintenanceMode()

Returns:

true if master is in maintanceMode

Throws:

IOException - if the inquiry failed due to an IO problem

abortProcedure

boolean abortProcedure(long procId,
                       boolean mayInterruptIfRunning)
                throws IOException

Abort a procedure.

Parameters:

procId - ID of the procedure

mayInterruptIfRunning - if the proc completed at least one step, should it be aborted?

Returns:

true if aborted, false if procedure already completed or does not exist

Throws:

IOException

getProcedures

List<Procedure<?>> getProcedures()
                          throws IOException

Get procedures

Returns:

procedure list

Throws:

IOException

getLocks

List<LockedResource> getLocks()
                       throws IOException

Get locks

Returns:

lock list

Throws:

IOException

listTableDescriptorsByNamespace

List<TableDescriptor> listTableDescriptorsByNamespace(String name)
                                               throws IOException

Get list of table descriptors by namespace

Parameters:

name - namespace name

Returns:

descriptors

Throws:

IOException

listTableNamesByNamespace

List<TableName> listTableNamesByNamespace(String name)
                                   throws IOException

Get list of table names by namespace

Parameters:

name - namespace name

Returns:

table names

Throws:

IOException

getLastMajorCompactionTimestamp

long getLastMajorCompactionTimestamp(TableName table)
                              throws IOException

Parameters:

table - the table for which last successful major compaction time is queried

Returns:

the timestamp of the last successful major compaction for the passed table, or 0 if no HFile resulting from a major compaction exists

Throws:

IOException

getLastMajorCompactionTimestampForRegion

long getLastMajorCompactionTimestampForRegion(byte[] regionName)
                                       throws IOException

Parameters:

regionName -

Returns:

the timestamp of the last successful major compaction for the passed region or 0 if no HFile resulting from a major compaction exists

Throws:

IOException

getLoadBalancer

LoadBalancer getLoadBalancer()

Returns:

load balancer

isSplitOrMergeEnabled

boolean isSplitOrMergeEnabled(MasterSwitchType switchType)

getFavoredNodesManager

FavoredNodesManager getFavoredNodesManager()

Returns:

Favored Nodes Manager

addReplicationPeer

long addReplicationPeer(String peerId,
                        ReplicationPeerConfig peerConfig,
                        boolean enabled)
                 throws ReplicationException,
                        IOException

Add a new replication peer for replicating data to slave cluster

Parameters:

peerId - a short name that identifies the peer

peerConfig - configuration for the replication slave cluster

enabled - peer state, true if ENABLED and false if DISABLED

Throws:

ReplicationException

IOException

removeReplicationPeer

long removeReplicationPeer(String peerId)
                    throws ReplicationException,
                           IOException

Removes a peer and stops the replication

Parameters:

peerId - a short name that identifies the peer

Throws:

ReplicationException

IOException

enableReplicationPeer

long enableReplicationPeer(String peerId)
                    throws ReplicationException,
                           IOException

Restart the replication stream to the specified peer

Parameters:

peerId - a short name that identifies the peer

Throws:

ReplicationException

IOException

disableReplicationPeer

long disableReplicationPeer(String peerId)
                     throws ReplicationException,
                            IOException

Stop the replication stream to the specified peer

Parameters:

peerId - a short name that identifies the peer

Throws:

ReplicationException

IOException

getReplicationPeerConfig

ReplicationPeerConfig getReplicationPeerConfig(String peerId)
                                        throws ReplicationException,
                                               IOException

Returns the configured ReplicationPeerConfig for the specified peer

Parameters:

peerId - a short name that identifies the peer

Returns:

ReplicationPeerConfig for the peer

Throws:

ReplicationException

IOException

getReplicationPeerManager

ReplicationPeerManager getReplicationPeerManager()

Returns the ReplicationPeerManager.

getSyncReplicationReplayWALManager

SyncReplicationReplayWALManager getSyncReplicationReplayWALManager()

Returns the SyncReplicationReplayWALManager.

updateReplicationPeerConfig

long updateReplicationPeerConfig(String peerId,
                                 ReplicationPeerConfig peerConfig)
                          throws ReplicationException,
                                 IOException

Update the peerConfig for the specified peer

Parameters:

peerId - a short name that identifies the peer

peerConfig - new config for the peer

Throws:

ReplicationException

IOException

listReplicationPeers

List<ReplicationPeerDescription> listReplicationPeers(String regex)
                                               throws ReplicationException,
                                                      IOException

Return a list of replication peers.

Parameters:

regex - The regular expression to match peer id

Returns:

a list of replication peers description

Throws:

ReplicationException

IOException

transitReplicationPeerSyncReplicationState

long transitReplicationPeerSyncReplicationState(String peerId,
                                                SyncReplicationState clusterState)
                                         throws ReplicationException,
                                                IOException

Set current cluster state for a synchronous replication peer.

Parameters:

peerId - a short name that identifies the peer

clusterState - state of current cluster

Throws:

ReplicationException

IOException

getLockManager

LockManager getLockManager()

Returns:

LockManager to lock namespaces/tables/regions.

getRegionServerVersion

String getRegionServerVersion(ServerName sn)

checkIfShouldMoveSystemRegionAsync

void checkIfShouldMoveSystemRegionAsync()

Called when a new RegionServer is added to the cluster. Checks if new server has a newer version than any existing server and will move system tables there if so.

getClientIdAuditPrefix

String getClientIdAuditPrefix()

isClusterUp

boolean isClusterUp()

Returns:

True if cluster is up; false if cluster is not up (we are shutting down).

getSplitWALManager

default SplitWALManager getSplitWALManager()

Returns:

return null if current is zk-based WAL splitting

getAccessChecker

AccessChecker getAccessChecker()

Returns:

the AccessChecker

getZKPermissionWatcher

ZKPermissionWatcher getZKPermissionWatcher()

Returns:

the ZKPermissionWatcher

executeRegionPlansWithThrottling

List<RegionPlan> executeRegionPlansWithThrottling(List<RegionPlan> plans)

Execute region plans with throttling

Parameters:

plans - to execute

Returns:

succeeded plans