org.apache.hadoop.hbase.util

Class RegionMover

java.lang.Object

org.apache.hadoop.hbase.util.AbstractHBaseTool

org.apache.hadoop.hbase.util.RegionMover

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.conf.Configurable, org.apache.hadoop.util.Tool

@InterfaceAudience.Public
public class RegionMover
extends org.apache.hadoop.hbase.util.AbstractHBaseTool
implements Closeable

Tool for loading/unloading regions to/from given regionserver This tool can be run from Command line directly as a utility. Supports Ack/No Ack mode for loading/unloading operations.Ack mode acknowledges if regions are online after movement while noAck mode is best effort mode that improves performance but will still move on if region is stuck/not moved. Motivation behind noAck mode being RS shutdown where even if a Region is stuck, upon shutdown master will move it anyways. This can also be used by constructiong an Object using the builder and then calling load() or unload() methods for the desired operations.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MOVE_RETRIES_MAX
static int	DEFAULT_MOVE_WAIT_MAX
static int	DEFAULT_SERVERSTART_WAIT_MAX
static String	MOVE_RETRIES_MAX_KEY
static String	MOVE_WAIT_MAX_KEY
static String	SERVERSTART_WAIT_MAX_KEY

Fields inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

cmdLineArgs, conf, EXIT_FAILURE, EXIT_SUCCESS, LONG_HELP_OPTION, options, SHORT_HELP_OPTION

Method Summary

Modifier and Type	Method and Description
protected void	addOptions() Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.
void	close()
protected int	doWork() The "main function" of the tool
boolean	load() Loads the specified hostname with regions listed in the filename RegionMover Object has to be created using RegionMover(RegionMoverBuilder)
static void	main(String[] args)
protected void	processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd) This method is called to process the options after they have been parsed.
boolean	unload() Unload regions from given hostname using ack/noAck mode and maxthreads.In noAck mode we do not make sure that region is successfully online on the target region server,hence it is best effort.We do not unload regions to hostnames given in excludeFile.

Methods inherited from class org.apache.hadoop.hbase.util.AbstractHBaseTool

addOption, addOptNoArg, addOptNoArg, addOptWithArg, addOptWithArg, addRequiredOption, addRequiredOptWithArg, addRequiredOptWithArg, doStaticMain, getConf, getOptionAsDouble, getOptionAsInt, getOptionAsLong, newParser, parseArgs, parseInt, parseLong, printUsage, printUsage, processOldArgs, run, setConf

Methods inherited from class java.lang.Object

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

Field Detail

MOVE_RETRIES_MAX_KEY

public static final String MOVE_RETRIES_MAX_KEY

See Also:

Constant Field Values

MOVE_WAIT_MAX_KEY

public static final String MOVE_WAIT_MAX_KEY

See Also:

Constant Field Values

SERVERSTART_WAIT_MAX_KEY

public static final String SERVERSTART_WAIT_MAX_KEY

See Also:

Constant Field Values

DEFAULT_MOVE_RETRIES_MAX

public static final int DEFAULT_MOVE_RETRIES_MAX

See Also:

Constant Field Values

DEFAULT_MOVE_WAIT_MAX

public static final int DEFAULT_MOVE_WAIT_MAX

See Also:

Constant Field Values

DEFAULT_SERVERSTART_WAIT_MAX

public static final int DEFAULT_SERVERSTART_WAIT_MAX

See Also:

Constant Field Values

Method Detail

close

public void close()

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

load

public boolean load()
             throws ExecutionException,
                    InterruptedException,
                    TimeoutException

Loads the specified hostname with regions listed in the filename RegionMover Object has to be created using RegionMover(RegionMoverBuilder)

Returns:

true if loading succeeded, false otherwise

Throws:

ExecutionException

InterruptedException

TimeoutException

unload

public boolean unload()
               throws InterruptedException,
                      ExecutionException,
                      TimeoutException

Unload regions from given hostname using ack/noAck mode and maxthreads.In noAck mode we do not make sure that region is successfully online on the target region server,hence it is best effort.We do not unload regions to hostnames given in excludeFile. If designatedFile is present with some contents, we will unload regions to hostnames provided in designatedFile

Returns:

true if unloading succeeded, false otherwise

Throws:

InterruptedException

ExecutionException

TimeoutException

addOptions

protected void addOptions()

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

Override this to add command-line options using AbstractHBaseTool.addOptWithArg(java.lang.String, java.lang.String) and similar methods.

Specified by:

addOptions in class org.apache.hadoop.hbase.util.AbstractHBaseTool

processOptions

protected void processOptions(org.apache.hbase.thirdparty.org.apache.commons.cli.CommandLine cmd)

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

This method is called to process the options after they have been parsed.

Specified by:

processOptions in class org.apache.hadoop.hbase.util.AbstractHBaseTool

doWork

protected int doWork()
              throws Exception

Description copied from class: org.apache.hadoop.hbase.util.AbstractHBaseTool

The "main function" of the tool

Specified by:

doWork in class org.apache.hadoop.hbase.util.AbstractHBaseTool

Throws:

Exception

main

public static void main(String[] args)