org.apache.hadoop.hbase.rsgroup

Interface RSGroupAdmin

All Known Implementing Classes:

RSGroupAdminClient, RSGroupAdminServer

@InterfaceAudience.Private
public interface RSGroupAdmin

Group user API interface used between client and server.

Method Summary

Modifier and Type	Method and Description
void	addRSGroup(String groupName) Creates a new RegionServer group with the given name.
default BalanceResponse	balanceRSGroup(String groupName) Balance regions in the given RegionServer group.
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 groupName) 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

Method Detail

getRSGroupInfo

RSGroupInfo getRSGroupInfo(String groupName)
                    throws IOException

Gets RSGroupInfo for given group name.

Throws:

IOException

getRSGroupInfoOfTable

RSGroupInfo getRSGroupInfoOfTable(TableName tableName)
                           throws IOException

Gets RSGroupInfo for the given table's group.

Throws:

IOException

moveServers

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

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

Throws:

IOException

moveTables

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

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.

Throws:

IOException

addRSGroup

void addRSGroup(String groupName)
         throws IOException

Creates a new RegionServer group with the given name.

Throws:

IOException

removeRSGroup

void removeRSGroup(String groupName)
            throws IOException

Removes RegionServer group associated with the given name.

Throws:

IOException

balanceRSGroup

default BalanceResponse balanceRSGroup(String groupName)
                                throws IOException

Balance regions in the given RegionServer group.

Returns:

boolean Whether balance ran or not

Throws:

IOException

balanceRSGroup

BalanceResponse balanceRSGroup(String groupName,
                               BalanceRequest request)
                        throws IOException

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

Returns:

boolean Whether balance ran or not

Throws:

IOException

listRSGroups

List<RSGroupInfo> listRSGroups()
                        throws IOException

Lists current set of RegionServer groups.

Throws:

IOException

getRSGroupOfServer

RSGroupInfo getRSGroupOfServer(Address hostPort)
                        throws IOException

Retrieve the RSGroupInfo a server is affiliated to

Parameters:

hostPort - HostPort to get RSGroupInfo for

Throws:

IOException

moveServersAndTables

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

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

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

void removeServers(Set<Address> servers)
            throws IOException

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.

Parameters:

servers - set of servers to remove

Throws:

IOException

renameRSGroup

void renameRSGroup(String oldName,
                   String newName)
            throws IOException

Rename rsgroup.

Parameters:

oldName - old rsgroup name

newName - new rsgroup name

Throws:

IOException

updateRSGroupConfig

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

Update RSGroup configuration

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

void updateConfiguration(String groupName)
                  throws IOException

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

Parameters:

groupName - the group name

Throws:

IOException - if a remote or network exception occurs