org.apache.hadoop.hbase.testing

Class TestingHBaseClusterOption

java.lang.Object

org.apache.hadoop.hbase.testing.TestingHBaseClusterOption

@InterfaceAudience.Public
public final class TestingHBaseClusterOption
extends Object

Options for starting up a mini testing cluster TestingHBaseCluster (including an hbase, dfs and zookeeper clusters) in test. The options include HDFS options to build mini dfs cluster, Zookeeper options to build mini zk cluster, and mostly HBase options to build mini hbase cluster. To create an object, use a TestingHBaseClusterOption.Builder. Example usage:

    TestingHBaseClusterOption option = TestingHBaseClusterOption.builder().
        .numMasters(3).createWALDir(true).build();
 

Default values can be found in TestingHBaseClusterOption.Builder.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestingHBaseClusterOption.Builder Builder pattern for creating an TestingHBaseClusterOption.

Field Summary

Fields

Modifier and Type	Field and Description
private org.apache.hadoop.conf.Configuration	conf Configuration for this testing cluster.
private boolean	createRootDir Whether to create a new root or data directory path.
private boolean	createWALDir Whether to create a new WAL directory.
private String[]	dataNodeHosts The hostnames of DataNodes to run on.
private String	externalDfsUri
private String	externalZkConnectString
private int	numAlwaysStandByMasters Number of masters that always remain standby.
private int	numDataNodes Number of datanodes.
private int	numMasters Number of masters to start up.
private int	numRegionServers Number of region servers to start up.
private int	numZkServers Number of Zookeeper servers.
private List<Integer>	rsPorts Ports that RegionServer should use.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	TestingHBaseClusterOption(org.apache.hadoop.conf.Configuration conf, int numMasters, int numAlwaysStandByMasters, int numRegionServers, List<Integer> rsPorts, int numDataNodes, String[] dataNodeHosts, int numZkServers, boolean createRootDir, boolean createWALDir, String externalDfsUri, String externalZkConnectString) Private constructor.

Method Summary

Modifier and Type	Method and Description
static TestingHBaseClusterOption.Builder	builder() Returns a new builder.
org.apache.hadoop.conf.Configuration	conf()
(package private) StartMiniClusterOption	convert() Convert to the internal option.
String[]	getDataNodeHosts()
String	getExternalDfsUri()
String	getExternalZkConnectString()
int	getNumAlwaysStandByMasters()
int	getNumDataNodes()
int	getNumMasters()
int	getNumRegionServers()
int	getNumZkServers()
List<Integer>	getRsPorts()
boolean	isCreateRootDir()
boolean	isCreateWALDir()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

conf

private final org.apache.hadoop.conf.Configuration conf

Configuration for this testing cluster. Can be null.

numMasters

private final int numMasters

Number of masters to start up. We'll start this many hbase masters.

numAlwaysStandByMasters

private final int numAlwaysStandByMasters

Number of masters that always remain standby. These set of masters never transition to active even if an active master does not exist.

numRegionServers

private final int numRegionServers

Number of region servers to start up. If this value is > 1, then make sure config "hbase.regionserver.info.port" is -1 (i.e. no ui per regionserver) otherwise bind errors.

rsPorts

private final List<Integer> rsPorts

Ports that RegionServer should use. Pass ports if you want to test cluster restart where for sure the regionservers come up on same address+port (but just with different startcode); by default mini hbase clusters choose new arbitrary ports on each cluster start.

numDataNodes

private final int numDataNodes

Number of datanodes. Used to create mini DSF cluster. Surpassed by dataNodeHosts size.

dataNodeHosts

private final String[] dataNodeHosts

The hostnames of DataNodes to run on. This is useful if you want to run datanode on distinct hosts for things like HDFS block location verification. If you start MiniDFSCluster without host names, all instances of the datanodes will have the same host name.

numZkServers

private final int numZkServers

Number of Zookeeper servers.

createRootDir

private final boolean createRootDir

Whether to create a new root or data directory path. If true, the newly created data directory will be configured as HBase rootdir. This will overwrite existing root directory config.

createWALDir

private final boolean createWALDir

Whether to create a new WAL directory. If true, the newly created directory will be configured as HBase wal.dir which is separate from HBase rootdir.

externalDfsUri

private final String externalDfsUri

externalZkConnectString

private final String externalZkConnectString

Constructor Detail

TestingHBaseClusterOption

private TestingHBaseClusterOption(org.apache.hadoop.conf.Configuration conf,
                                  int numMasters,
                                  int numAlwaysStandByMasters,
                                  int numRegionServers,
                                  List<Integer> rsPorts,
                                  int numDataNodes,
                                  String[] dataNodeHosts,
                                  int numZkServers,
                                  boolean createRootDir,
                                  boolean createWALDir,
                                  String externalDfsUri,
                                  String externalZkConnectString)

Private constructor. Use TestingHBaseClusterOption.Builder.build().

Method Detail

conf

public org.apache.hadoop.conf.Configuration conf()

getNumMasters

public int getNumMasters()

getNumAlwaysStandByMasters

public int getNumAlwaysStandByMasters()

getNumRegionServers

public int getNumRegionServers()

getRsPorts

public List<Integer> getRsPorts()

getNumDataNodes

public int getNumDataNodes()

getDataNodeHosts

public String[] getDataNodeHosts()

getNumZkServers

public int getNumZkServers()

isCreateRootDir

public boolean isCreateRootDir()

isCreateWALDir

public boolean isCreateWALDir()

getExternalDfsUri

public String getExternalDfsUri()

getExternalZkConnectString

public String getExternalZkConnectString()

toString

public String toString()

Overrides:

toString in class Object

convert

StartMiniClusterOption convert()

Convert to the internal option. Not for public use so package private.

builder

public static TestingHBaseClusterOption.Builder builder()

Returns a new builder.