org.apache.hadoop.hbase.master

Interface MasterServices

All Superinterfaces:

Abortable, Server, Stoppable

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster, TestAssignmentManagerOnCluster.MyMaster, TestMasterMetrics.MyMaster, TestSplitTransactionOnCluster.MockMasterWithoutCatalogJanitor

@InterfaceAudience.Private
public interface MasterServices
extends Server

Services Master supplies

Method Summary

Modifier and Type	Method and Description
boolean	abortProcedure(long procId, boolean mayInterruptIfRunning) Abort a procedure.
void	addColumn(TableName tableName, HColumnDescriptor column, long nonceGroup, long nonce) Add a new column to an existing table
Pair<Long,String>	backupTables(BackupType type, List<TableName> tableList, String targetRootDir, int workers, long bandwidth) Full backup given list of tables
void	checkTableModifiable(TableName tableName) Check table is modifiable; i.e.
void	createNamespace(NamespaceDescriptor descriptor) Create a new namespace
long	createTable(HTableDescriptor desc, byte[][] splitKeys, long nonceGroup, long nonce) Create a table using the given table definition.
void	deleteColumn(TableName tableName, byte[] columnName, long nonceGroup, long nonce) Delete a column from an existing table
void	deleteNamespace(String name) Delete an existing namespace.
long	deleteTable(TableName tableName, long nonceGroup, long nonce) Delete a table
long	disableTable(TableName tableName, long nonceGroup, long nonce) Disable an existing table
void	dispatchMergingRegions(HRegionInfo region_a, HRegionInfo region_b, boolean forcible) Merge two regions.
long	enableTable(TableName tableName, long nonceGroup, long nonce) Enable an existing table
AssignmentManager	getAssignmentManager()
ExecutorService	getExecutorService()
long	getLastMajorCompactionTimestamp(TableName table)
long	getLastMajorCompactionTimestampForRegion(byte[] regionName)
LoadBalancer	getLoadBalancer()
MasterCoprocessorHost	getMasterCoprocessorHost()
MasterFileSystem	getMasterFileSystem()
ProcedureExecutor<MasterProcedureEnv>	getMasterProcedureExecutor()
MasterProcedureManagerHost	getMasterProcedureManagerHost()
MasterQuotaManager	getMasterQuotaManager()
NamespaceDescriptor	getNamespaceDescriptor(String name) Get a namespace descriptor by name
ServerManager	getServerManager()
SnapshotManager	getSnapshotManager()
TableDescriptors	getTableDescriptors()
TableLockManager	getTableLockManager()
TableStateManager	getTableStateManager()
boolean	isInitialized()
boolean	isInMaintenanceMode()
boolean	isMasterProcedureExecutorEnabled() Check whether the procedure executor is enabled
boolean	isServerShutdownHandlerEnabled()
List<NamespaceDescriptor>	listNamespaceDescriptors() List available namespace descriptors
List<ProcedureInfo>	listProcedures() List procedures
List<HTableDescriptor>	listTableDescriptorsByNamespace(String name) Get list of table descriptors by namespace
List<TableName>	listTableNamesByNamespace(String name) Get list of table names by namespace
void	modifyColumn(TableName tableName, HColumnDescriptor descriptor, long nonceGroup, long nonce) Modify the column descriptor of an existing column in an existing table
void	modifyNamespace(NamespaceDescriptor descriptor) Modify an existing namespace
void	modifyTable(TableName tableName, HTableDescriptor descriptor, long nonceGroup, long nonce) Modify the descriptor of an existing table
boolean	registerService(Service instance) Registers a new protocol buffer Service subclass as a master coprocessor endpoint.
void	truncateTable(TableName tableName, boolean preserveSplits, long nonceGroup, long nonce) Truncate a table

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

getChoreService, getConfiguration, getConnection, getCoordinatedStateManager, getMetaTableLocator, getServerName, getZooKeeper

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

getAssignmentManager

AssignmentManager getAssignmentManager()

Returns:

Master's instance of the AssignmentManager

getMasterFileSystem

MasterFileSystem getMasterFileSystem()

Returns:

Master's filesystem MasterFileSystem utility class.

getServerManager

ServerManager getServerManager()

Returns:

Master's ServerManager instance.

getExecutorService

ExecutorService getExecutorService()

Returns:

Master's instance of ExecutorService

getTableLockManager

TableLockManager getTableLockManager()

Returns:

Master's instance of TableLockManager

getMasterCoprocessorHost

MasterCoprocessorHost getMasterCoprocessorHost()

Returns:

Master's instance of MasterCoprocessorHost

getMasterQuotaManager

MasterQuotaManager getMasterQuotaManager()

Returns:

Master's instance of MasterQuotaManager

getMasterProcedureExecutor

ProcedureExecutor<MasterProcedureEnv> getMasterProcedureExecutor()

Returns:

Master's instance of ProcedureExecutor

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

isMasterProcedureExecutorEnabled

boolean isMasterProcedureExecutorEnabled()

Check whether the procedure executor is enabled

createTable

long createTable(HTableDescriptor 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

deleteTable

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

Delete a table

Parameters:

tableName - The table name

nonceGroup -

nonce -

Throws:

IOException

truncateTable

void 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

void modifyTable(TableName tableName,
                 HTableDescriptor 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

backupTables

Pair<Long,String> backupTables(BackupType type,
                               List<TableName> tableList,
                               String targetRootDir,
                               int workers,
                               long bandwidth)
                        throws IOException

Full backup given list of tables

Parameters:

type - whether the backup is full or incremental

tableList - list of tables to backup

targetRootDir - root dir for saving the backup

workers - number of paralle workers. -1 - system defined

bandwidth - bandwidth per worker in MB per sec. -1 - unlimited

Returns:

pair of procedure Id and backupId

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

void addColumn(TableName tableName,
               HColumnDescriptor 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

void modifyColumn(TableName tableName,
                  HColumnDescriptor 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

void 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

getTableDescriptors

TableDescriptors getTableDescriptors()

Returns:

Return table descriptors implementation.

isServerShutdownHandlerEnabled

boolean isServerShutdownHandlerEnabled()

Returns:

true if master enables ServerShutdownHandler;

registerService

boolean registerService(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 com.google.protobuf.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

dispatchMergingRegions

void dispatchMergingRegions(HRegionInfo region_a,
                            HRegionInfo region_b,
                            boolean forcible)
                     throws IOException

Merge two regions. The real implementation is on the regionserver, master just move the regions together and send MERGE RPC to regionserver

Parameters:

region_a - region to merge

region_b - region to merge

forcible - true if do a compulsory merge, otherwise we will only merge two adjacent regions

Throws:

IOException

isInitialized

boolean isInitialized()

Returns:

true if master is initialized

createNamespace

void createNamespace(NamespaceDescriptor descriptor)
              throws IOException

Create a new namespace

Parameters:

descriptor - descriptor which describes the new namespace

Throws:

IOException

modifyNamespace

void modifyNamespace(NamespaceDescriptor descriptor)
              throws IOException

Modify an existing namespace

Parameters:

descriptor - descriptor which updates the existing namespace

Throws:

IOException

deleteNamespace

void deleteNamespace(String name)
              throws IOException

Delete an existing namespace. Only empty namespaces (no tables) can be removed.

Parameters:

name - namespace name

Throws:

IOException

isInMaintenanceMode

boolean isInMaintenanceMode()

Returns:

true if master is in maintanceMode

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

listProcedures

List<ProcedureInfo> listProcedures()
                            throws IOException

List procedures

Returns:

procedure list

Throws:

IOException

getNamespaceDescriptor

NamespaceDescriptor getNamespaceDescriptor(String name)
                                    throws IOException

Get a namespace descriptor by name

Parameters:

name - name of namespace descriptor

Returns:

A descriptor

Throws:

IOException

listNamespaceDescriptors

List<NamespaceDescriptor> listNamespaceDescriptors()
                                            throws IOException

List available namespace descriptors

Returns:

A descriptor

Throws:

IOException

listTableDescriptorsByNamespace

List<HTableDescriptor> 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 -

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

getTableStateManager

TableStateManager getTableStateManager()