org.apache.hadoop.hbase.rsgroup

Class RSGroupAdminClient

java.lang.Object

org.apache.hadoop.hbase.rsgroup.RSGroupAdminClient

All Implemented Interfaces:

RSGroupAdmin

@InterfaceAudience.Private
public class RSGroupAdminClient
extends Object
implements RSGroupAdmin

Client used for managing region server group information.

Field Summary

Fields

Modifier and Type	Field and Description
private Admin	admin
private org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService.BlockingInterface	stub

Constructor Summary

Constructors

Constructor and Description
RSGroupAdminClient(Connection conn)

Method Summary

Modifier and Type	Method and Description
void	addRSGroup(String groupName) Creates a new RegionServer group with the given name.
BalanceResponse	balanceRSGroup(String groupName, BalanceRequest request) Balance regions in the given RegionServer group, running based on the given BalanceRequest.
RSGroupInfo	getRSGroupInfo(String groupName) Gets RSGroupInfo for given group name.
RSGroupInfo	getRSGroupInfoOfTable(TableName tableName) Gets RSGroupInfo for the given table's group.
RSGroupInfo	getRSGroupOfServer(Address hostPort) Retrieve the RSGroupInfo a server is affiliated to
List<RSGroupInfo>	listRSGroups() Lists current set of RegionServer groups.
void	moveServers(Set<Address> servers, String targetGroup) Move given set of servers to the specified target RegionServer group.
void	moveServersAndTables(Set<Address> servers, Set<TableName> tables, String targetGroup) Move given set of servers and tables to the specified target RegionServer group.
void	moveTables(Set<TableName> tables, String targetGroup) Move given set of tables to the specified target RegionServer group.
void	removeRSGroup(String name) Removes RegionServer group associated with the given name.
void	removeServers(Set<Address> servers) Remove decommissioned servers from rsgroup.
void	renameRSGroup(String oldName, String newName) Rename rsgroup.
void	updateConfiguration(String groupName) Update the configuration and trigger an online config change on all the regionservers in the RSGroup.
void	updateRSGroupConfig(String groupName, Map<String,String> configuration) Update RSGroup configuration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.hbase.rsgroup.RSGroupAdmin

balanceRSGroup

Field Detail

stub

private org.apache.hadoop.hbase.protobuf.generated.RSGroupAdminProtos.RSGroupAdminService.BlockingInterface stub

admin

private Admin admin

Constructor Detail

RSGroupAdminClient

public RSGroupAdminClient(Connection conn)
                   throws IOException

Throws:

IOException

Method Detail

getRSGroupInfo

public RSGroupInfo getRSGroupInfo(String groupName)
                           throws IOException

Description copied from interface: RSGroupAdmin

Gets RSGroupInfo for given group name.

Specified by:

getRSGroupInfo in interface RSGroupAdmin

Throws:

IOException

getRSGroupInfoOfTable

public RSGroupInfo getRSGroupInfoOfTable(TableName tableName)
                                  throws IOException

Description copied from interface: RSGroupAdmin

Gets RSGroupInfo for the given table's group.

Specified by:

getRSGroupInfoOfTable in interface RSGroupAdmin

Throws:

IOException

moveServers

public void moveServers(Set<Address> servers,
                        String targetGroup)
                 throws IOException

Description copied from interface: RSGroupAdmin

Move given set of servers to the specified target RegionServer group.

Specified by:

moveServers in interface RSGroupAdmin

Throws:

IOException

moveTables

public void moveTables(Set<TableName> tables,
                       String targetGroup)
                throws IOException

Description copied from interface: RSGroupAdmin

Move given set of tables to the specified target RegionServer group. This will unassign all of a table's region so it can be reassigned to the correct group.

Specified by:

moveTables in interface RSGroupAdmin

Throws:

IOException

addRSGroup

public void addRSGroup(String groupName)
                throws IOException

Description copied from interface: RSGroupAdmin

Creates a new RegionServer group with the given name.

Specified by:

addRSGroup in interface RSGroupAdmin

Throws:

IOException

removeRSGroup

public void removeRSGroup(String name)
                   throws IOException

Description copied from interface: RSGroupAdmin

Removes RegionServer group associated with the given name.

Specified by:

removeRSGroup in interface RSGroupAdmin

Throws:

IOException

balanceRSGroup

public BalanceResponse balanceRSGroup(String groupName,
                                      BalanceRequest request)
                               throws IOException

Description copied from interface: RSGroupAdmin

Balance regions in the given RegionServer group, running based on the given BalanceRequest.

Specified by:

balanceRSGroup in interface RSGroupAdmin

Returns:

boolean Whether balance ran or not

Throws:

IOException

listRSGroups

public List<RSGroupInfo> listRSGroups()
                               throws IOException

Description copied from interface: RSGroupAdmin

Lists current set of RegionServer groups.

Specified by:

listRSGroups in interface RSGroupAdmin

Throws:

IOException

getRSGroupOfServer

public RSGroupInfo getRSGroupOfServer(Address hostPort)
                               throws IOException

Description copied from interface: RSGroupAdmin

Retrieve the RSGroupInfo a server is affiliated to

Specified by:

getRSGroupOfServer in interface RSGroupAdmin

Parameters:

hostPort - HostPort to get RSGroupInfo for

Throws:

IOException

moveServersAndTables

public void moveServersAndTables(Set<Address> servers,
                                 Set<TableName> tables,
                                 String targetGroup)
                          throws IOException

Description copied from interface: RSGroupAdmin

Move given set of servers and tables to the specified target RegionServer group.

Specified by:

moveServersAndTables in interface RSGroupAdmin

Parameters:

servers - set of servers to move

tables - set of tables to move

targetGroup - the target group name

Throws:

IOException - if moving the server and tables fail

removeServers

public void removeServers(Set<Address> servers)
                   throws IOException

Description copied from interface: RSGroupAdmin

Remove decommissioned servers from rsgroup. 1. Sometimes we may find the server aborted due to some hardware failure and we must offline the server for repairing. Or we need to move some servers to join other clusters. So we need to remove these servers from the rsgroup. 2. Dead/recovering/live servers will be disallowed.

Specified by:

removeServers in interface RSGroupAdmin

Parameters:

servers - set of servers to remove

Throws:

IOException

renameRSGroup

public void renameRSGroup(String oldName,
                          String newName)
                   throws IOException

Description copied from interface: RSGroupAdmin

Rename rsgroup.

Specified by:

renameRSGroup in interface RSGroupAdmin

Parameters:

oldName - old rsgroup name

newName - new rsgroup name

Throws:

IOException

updateRSGroupConfig

public void updateRSGroupConfig(String groupName,
                                Map<String,String> configuration)
                         throws IOException

Description copied from interface: RSGroupAdmin

Update RSGroup configuration

Specified by:

updateRSGroupConfig in interface RSGroupAdmin

Parameters:

groupName - the group name

configuration - new configuration of the group name to be set

Throws:

IOException - if a remote or network exception occurs

updateConfiguration

public void updateConfiguration(String groupName)
                         throws IOException

Description copied from interface: RSGroupAdmin

Update the configuration and trigger an online config change on all the regionservers in the RSGroup.

Specified by:

updateConfiguration in interface RSGroupAdmin

Parameters:

groupName - the group name

Throws:

IOException - if a remote or network exception occurs