MasterServices (Apache HBase 1.4.11 API)

All Superinterfaces:

Abortable, Server, Stoppable

All Known Implementing Classes:

HMaster, HMasterCommandLine.LocalHMaster
```
@InterfaceAudience.Private
public interface MasterServices
extends Server
```
Services Master supplies

Method Summary

Methods
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
`void`	`checkIfShouldMoveSystemRegionAsync()`
`void`	`checkTableModifiable(TableName tableName)` Check table is modifiable; i.e.
`void`	`createNamespace(NamespaceDescriptor descriptor, long nonceGroup, long nonce)` Create a new namespace
`void`	`createNamespaceSync(NamespaceDescriptor descriptor, long nonceGroup, long nonce, boolean executeCoprocessor)` Create a new namespace synchronously.
`long`	`createSystemTable(HTableDescriptor hTableDescriptor)` Create a system table using the given table definition.
`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, long nonceGroup, long nonce)` 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, User user)` 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
`String`	`getRegionServerVersion(ServerName sn)`
`ServerManager`	`getServerManager()`
`SnapshotManager`	`getSnapshotManager()`
`TableDescriptors`	`getTableDescriptors()`
`TableLockManager`	`getTableLockManager()`
`TableNamespaceManager`	`getTableNamespaceManager()`
`boolean`	`isInitialized()`
`boolean`	`isInMaintenanceMode()`
`boolean`	`isServerCrashProcessingEnabled()`
`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, long nonceGroup, long nonce)` Modify an existing namespace
`void`	`modifyTable(TableName tableName, HTableDescriptor 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.
`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
  - getTableNamespaceManager
```
TableNamespaceManager getTableNamespaceManager()
```
    Returns:
    Master's instance of TableNamespaceManager
  - 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
  - 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
  - createSystemTable
```
long createSystemTable(HTableDescriptor hTableDescriptor)
                       throws IOException
```
    Create a system table using the given table definition.
    
    Parameters:
    hTableDescriptor - 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
```
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
  - 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.
  - isServerCrashProcessingEnabled
```
boolean isServerCrashProcessingEnabled()
```
    Returns:
    true if master enables ServerShutdownHandler;
  - 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
  - dispatchMergingRegions
```
void dispatchMergingRegions(HRegionInfo region_a,
                          HRegionInfo region_b,
                          boolean forcible,
                          User user)
                            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
    user - effective user
    
    Throws:
    
    IOException
  - isInitialized
```
boolean isInitialized()
```
    Returns:
    true if master is initialized
  - createNamespace
```
void createNamespace(NamespaceDescriptor descriptor,
                   long nonceGroup,
                   long nonce)
                     throws IOException
```
    Create a new namespace
    
    Parameters:
    descriptor - descriptor which describes the new namespace
    nonceGroup -
    nonce -
    
    Throws:
    
    IOException
  - createNamespaceSync
```
void createNamespaceSync(NamespaceDescriptor descriptor,
                       long nonceGroup,
                       long nonce,
                       boolean executeCoprocessor)
                         throws IOException
```
    Create a new namespace synchronously.
    
    Parameters:
    descriptor - descriptor which describes the new namespace
    nonceGroup -
    nonce -
    
    Throws:
    
    IOException
  - modifyNamespace
```
void modifyNamespace(NamespaceDescriptor descriptor,
                   long nonceGroup,
                   long nonce)
                     throws IOException
```
    Modify an existing namespace
    
    Parameters:
    descriptor - descriptor which updates the existing namespace
    nonceGroup -
    nonce -
    
    Throws:
    
    IOException
  - deleteNamespace
```
void deleteNamespace(String name,
                   long nonceGroup,
                   long nonce)
                     throws IOException
```
    Delete an existing namespace. Only empty namespaces (no tables) can be removed.
    
    Parameters:
    name - namespace name
    nonceGroup -
    nonce -
    
    Throws:
    
    IOException
  - isInMaintenanceMode
```
boolean isInMaintenanceMode()
                            throws IOException
```
    Returns:
    true if master is in maintanceMode
    
    Throws:
    
    IOException
  - 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 - 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
  - getRegionServerVersion
```
String getRegionServerVersion(ServerName sn)
```
  - checkIfShouldMoveSystemRegionAsync
```
void checkIfShouldMoveSystemRegionAsync()
```
  - getLoadBalancer
```
LoadBalancer getLoadBalancer()
```
    Returns:
    load balancer

Interface MasterServices

Method Summary

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

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

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

Method Detail

getSnapshotManager

getMasterProcedureManagerHost

getAssignmentManager

getMasterFileSystem

getServerManager

getExecutorService

getTableLockManager

getMasterCoprocessorHost

getTableNamespaceManager

getMasterQuotaManager

getMasterProcedureExecutor

checkTableModifiable

createTable

createSystemTable

deleteTable

truncateTable

modifyTable

enableTable

disableTable

addColumn

modifyColumn

deleteColumn

getTableDescriptors

isServerCrashProcessingEnabled

registerService

dispatchMergingRegions

isInitialized

createNamespace

createNamespaceSync

modifyNamespace

deleteNamespace

isInMaintenanceMode

abortProcedure

listProcedures

getNamespaceDescriptor

listNamespaceDescriptors

listTableDescriptorsByNamespace

listTableNamesByNamespace

getLastMajorCompactionTimestamp

getLastMajorCompactionTimestampForRegion

getRegionServerVersion

checkIfShouldMoveSystemRegionAsync

getLoadBalancer