org.apache.hadoop.hbase

Class MiniHBaseCluster

java.lang.Object

org.apache.hadoop.hbase.HBaseCluster

org.apache.hadoop.hbase.MiniHBaseCluster

All Implemented Interfaces:

Closeable, AutoCloseable

@InterfaceAudience.Public
 @InterfaceStability.Evolving
public class MiniHBaseCluster
extends HBaseCluster

This class creates a single process HBase cluster. each server. The master uses the 'default' FileSystem. The RegionServers, if we are running on DistributedFilesystem, create a FileSystem instance each and will close down their instance on the way out.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MiniHBaseCluster.MiniHBaseClusterRegionServer Subclass so can get at protected methods (none at moment).

Field Summary

Fields

Modifier and Type	Field and Description
LocalHBaseCluster	hbaseCluster

Fields inherited from class org.apache.hadoop.hbase.HBaseCluster

conf, initialClusterStatus

Constructor Summary

Constructors

Constructor and Description
MiniHBaseCluster(Configuration conf, int numRegionServers) Start a MiniHBaseCluster.
MiniHBaseCluster(Configuration conf, int numMasters, int numRegionServers) Start a MiniHBaseCluster.
MiniHBaseCluster(Configuration conf, int numMasters, int numRegionServers, Class<? extends HMaster> masterClass, Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> regionserverClass)

Method Summary

Modifier and Type	Method and Description
String	abortMaster(int serverNumber) Cause a master to exit without shutting down entire cluster.
String	abortRegionServer(int serverNumber) Cause a region server to exit doing basic clean up only on its way out.
void	close() Closes all the resources held open for this cluster.
void	compact(boolean major) Call flushCache on all regions on all participating regionservers.
void	compact(TableName tableName, boolean major) Call flushCache on all regions of the specified table.
long	countServedRegions() Counts the total numbers of regions being served by the currently online region servers by asking each how many regions they have.
List<HRegion>	findRegionsForTable(TableName tableName)
void	flushcache() Call flushCache on all regions on all participating regionservers.
void	flushcache(TableName tableName) Call flushCache on all regions of the specified table.
AdminProtos.AdminService.BlockingInterface	getAdminProtocol(ServerName serverName) Returns an AdminProtocol interface to the regionserver
ClientProtos.ClientService.BlockingInterface	getClientProtocol(ServerName serverName) Returns a ClientProtocol interface to the regionserver
ClusterStatus	getClusterStatus() Returns a ClusterStatus for this HBase cluster.
Configuration	getConfiguration()
List<JVMClusterUtil.MasterThread>	getLiveMasterThreads()
List<JVMClusterUtil.RegionServerThread>	getLiveRegionServerThreads()
HMaster	getMaster() Returns the current active master, if available.
HMaster	getMaster(int serverNumber) Returns the master at the specified index, if available.
MasterProtos.MasterService.BlockingInterface	getMasterAdminService() Returns the current active master, if available.
protected int	getMasterIndex(ServerName serverName)
JVMClusterUtil.MasterThread	getMasterThread() Returns the current active master thread, if available.
List<JVMClusterUtil.MasterThread>	getMasterThreads()
List<HRegion>	getRegions(byte[] tableName)
List<HRegion>	getRegions(TableName tableName)
HRegionServer	getRegionServer(int serverNumber) Grab a numbered region server of your choice.
protected int	getRegionServerIndex(ServerName serverName)
List<JVMClusterUtil.RegionServerThread>	getRegionServerThreads()
ServerName	getServerHoldingRegion(TableName tn, byte[] regionName) Get the ServerName of region server serving the specified region
int	getServerWith(byte[] regionName) Get the location of the specified region
int	getServerWithMeta()
void	join() Wait for Mini HBase Cluster to shut down.
void	killAll() Do a simulated kill all masters and regionservers.
void	killMaster(ServerName serverName) Kills the master process if this is a distributed cluster, otherwise, this causes master to exit doing basic clean up only.
void	killRegionServer(ServerName serverName) Kills the region server process if this is a distributed cluster, otherwise this causes the region server to exit doing basic clean up only.
void	shutdown() Shut down the mini HBase cluster
JVMClusterUtil.MasterThread	startMaster() Starts a master thread running
void	startMaster(String hostname, int port) Starts a new master on the given hostname or if this is a mini/local cluster, starts a master locally.
JVMClusterUtil.RegionServerThread	startRegionServer() Starts a region server thread running
void	startRegionServer(String hostname, int port) Starts a new region server on the given hostname or if this is a mini/local cluster, starts a region server locally.
JVMClusterUtil.MasterThread	stopMaster(int serverNumber) Shut down the specified master cleanly
JVMClusterUtil.MasterThread	stopMaster(int serverNumber, boolean shutdownFS) Shut down the specified master cleanly
void	stopMaster(ServerName serverName) Stops the given master, by attempting a gradual stop.
JVMClusterUtil.RegionServerThread	stopRegionServer(int serverNumber) Shut down the specified region server cleanly
JVMClusterUtil.RegionServerThread	stopRegionServer(int serverNumber, boolean shutdownFS) Shut down the specified region server cleanly
void	stopRegionServer(ServerName serverName) Stops the given region server, by attempting a gradual stop.
boolean	waitForActiveAndReadyMaster(long timeout) Blocks until there is an active master and that master has completed initialization.
void	waitForMasterToStop(ServerName serverName, long timeout) Wait for the specified master to stop the thread / process.
void	waitForRegionServerToStop(ServerName serverName, long timeout) Wait for the specified region server to stop the thread / process.
String	waitOnMaster(int serverNumber) Wait for the specified master to stop.
String	waitOnRegionServer(int serverNumber) Wait for the specified region server to stop.
void	waitUntilShutDown() Wait for HBase Cluster to shut down.

Methods inherited from class org.apache.hadoop.hbase.HBaseCluster

getConf, getInitialClusterStatus, getServerHoldingMeta, isDistributedCluster, restoreClusterStatus, restoreInitialStatus, setConf, waitForActiveAndReadyMaster, waitForDatanodesRegistered, waitForNamenodeAvailable, waitForRegionServerToStart

Methods inherited from class java.lang.Object

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

Field Detail

hbaseCluster

public LocalHBaseCluster hbaseCluster

Constructor Detail

MiniHBaseCluster

public MiniHBaseCluster(Configuration conf,
                        int numRegionServers)
                 throws IOException,
                        InterruptedException

Start a MiniHBaseCluster.

Parameters:

conf - Configuration to be used for cluster

numRegionServers - initial number of region servers to start.

Throws:

IOException

InterruptedException

MiniHBaseCluster

public MiniHBaseCluster(Configuration conf,
                        int numMasters,
                        int numRegionServers)
                 throws IOException,
                        InterruptedException

Start a MiniHBaseCluster.

Parameters:

conf - Configuration to be used for cluster

numMasters - initial number of masters to start.

numRegionServers - initial number of region servers to start.

Throws:

IOException

InterruptedException

MiniHBaseCluster

public MiniHBaseCluster(Configuration conf,
                        int numMasters,
                        int numRegionServers,
                        Class<? extends HMaster> masterClass,
                        Class<? extends MiniHBaseCluster.MiniHBaseClusterRegionServer> regionserverClass)
                 throws IOException,
                        InterruptedException

Throws:

IOException

InterruptedException

Method Detail

getConfiguration

public Configuration getConfiguration()

startRegionServer

public void startRegionServer(String hostname,
                              int port)
                       throws IOException

Description copied from class: HBaseCluster

Starts a new region server on the given hostname or if this is a mini/local cluster, starts a region server locally.

Specified by:

startRegionServer in class HBaseCluster

Parameters:

hostname - the hostname to start the regionserver on

Throws:

IOException - if something goes wrong

killRegionServer

public void killRegionServer(ServerName serverName)
                      throws IOException

Description copied from class: HBaseCluster

Kills the region server process if this is a distributed cluster, otherwise this causes the region server to exit doing basic clean up only.

Specified by:

killRegionServer in class HBaseCluster

Throws:

IOException - if something goes wrong

stopRegionServer

public void stopRegionServer(ServerName serverName)
                      throws IOException

Description copied from class: HBaseCluster

Stops the given region server, by attempting a gradual stop.

Specified by:

stopRegionServer in class HBaseCluster

Throws:

IOException - if something goes wrong

waitForRegionServerToStop

public void waitForRegionServerToStop(ServerName serverName,
                                      long timeout)
                               throws IOException

Description copied from class: HBaseCluster

Wait for the specified region server to stop the thread / process.

Specified by:

waitForRegionServerToStop in class HBaseCluster

Throws:

IOException - if something goes wrong or timeout occurs

startMaster

public void startMaster(String hostname,
                        int port)
                 throws IOException

Description copied from class: HBaseCluster

Starts a new master on the given hostname or if this is a mini/local cluster, starts a master locally.

Specified by:

startMaster in class HBaseCluster

Parameters:

hostname - the hostname to start the master on

Throws:

IOException - if something goes wrong

killMaster

public void killMaster(ServerName serverName)
                throws IOException

Description copied from class: HBaseCluster

Kills the master process if this is a distributed cluster, otherwise, this causes master to exit doing basic clean up only.

Specified by:

killMaster in class HBaseCluster

Throws:

IOException - if something goes wrong

stopMaster

public void stopMaster(ServerName serverName)
                throws IOException

Description copied from class: HBaseCluster

Stops the given master, by attempting a gradual stop.

Specified by:

stopMaster in class HBaseCluster

Throws:

IOException - if something goes wrong

waitForMasterToStop

public void waitForMasterToStop(ServerName serverName,
                                long timeout)
                         throws IOException

Description copied from class: HBaseCluster

Wait for the specified master to stop the thread / process.

Specified by:

waitForMasterToStop in class HBaseCluster

Throws:

IOException - if something goes wrong or timeout occurs

startRegionServer

public JVMClusterUtil.RegionServerThread startRegionServer()
                                                    throws IOException

Starts a region server thread running

Returns:

New RegionServerThread

Throws:

IOException

abortRegionServer

public String abortRegionServer(int serverNumber)

Cause a region server to exit doing basic clean up only on its way out.

Parameters:

serverNumber - Used as index into a list.

stopRegionServer

public JVMClusterUtil.RegionServerThread stopRegionServer(int serverNumber)

Shut down the specified region server cleanly

Parameters:

serverNumber - Used as index into a list.

Returns:

the region server that was stopped

stopRegionServer

public JVMClusterUtil.RegionServerThread stopRegionServer(int serverNumber,
                                                          boolean shutdownFS)

Shut down the specified region server cleanly

Parameters:

serverNumber - Used as index into a list.

shutdownFS - True is we are to shutdown the filesystem as part of this regionserver's shutdown. Usually we do but you do not want to do this if you are running multiple regionservers in a test and you shut down one before end of the test.

Returns:

the region server that was stopped

waitOnRegionServer

public String waitOnRegionServer(int serverNumber)

Wait for the specified region server to stop. Removes this thread from list of running threads.

Parameters:

serverNumber -

Returns:

Name of region server that just went down.

startMaster

public JVMClusterUtil.MasterThread startMaster()
                                        throws IOException

Starts a master thread running

Returns:

New RegionServerThread

Throws:

IOException

getMasterAdminService

public MasterProtos.MasterService.BlockingInterface getMasterAdminService()

Returns the current active master, if available.

Specified by:

getMasterAdminService in class HBaseCluster

Returns:

the active HMaster, null if none is active.

getMaster

public HMaster getMaster()

Returns the current active master, if available.

Returns:

the active HMaster, null if none is active.

getMasterThread

public JVMClusterUtil.MasterThread getMasterThread()

Returns the current active master thread, if available.

Returns:

the active MasterThread, null if none is active.

getMaster

public HMaster getMaster(int serverNumber)

Returns the master at the specified index, if available.

Returns:

the active HMaster, null if none is active.

abortMaster

public String abortMaster(int serverNumber)

Cause a master to exit without shutting down entire cluster.

Parameters:

serverNumber - Used as index into a list.

stopMaster

public JVMClusterUtil.MasterThread stopMaster(int serverNumber)

Shut down the specified master cleanly

Parameters:

serverNumber - Used as index into a list.

Returns:

the region server that was stopped

stopMaster

public JVMClusterUtil.MasterThread stopMaster(int serverNumber,
                                              boolean shutdownFS)

Shut down the specified master cleanly

Parameters:

serverNumber - Used as index into a list.

shutdownFS - True is we are to shutdown the filesystem as part of this master's shutdown. Usually we do but you do not want to do this if you are running multiple master in a test and you shut down one before end of the test.

Returns:

the master that was stopped

waitOnMaster

public String waitOnMaster(int serverNumber)

Wait for the specified master to stop. Removes this thread from list of running threads.

Parameters:

serverNumber -

Returns:

Name of master that just went down.

waitForActiveAndReadyMaster

public boolean waitForActiveAndReadyMaster(long timeout)
                                    throws IOException

Blocks until there is an active master and that master has completed initialization.

Specified by:

waitForActiveAndReadyMaster in class HBaseCluster

Parameters:

timeout - the timeout limit in ms

Returns:

true if an active master becomes available. false if there are no masters left.

Throws:

InterruptedException

IOException

getMasterThreads

public List<JVMClusterUtil.MasterThread> getMasterThreads()

Returns:

List of master threads.

getLiveMasterThreads

public List<JVMClusterUtil.MasterThread> getLiveMasterThreads()

Returns:

List of live master threads (skips the aborted and the killed)

join

public void join()

Wait for Mini HBase Cluster to shut down.

shutdown

public void shutdown()
              throws IOException

Shut down the mini HBase cluster

Specified by:

shutdown in class HBaseCluster

Throws:

IOException

close

public void close()
           throws IOException

Description copied from class: HBaseCluster

Closes all the resources held open for this cluster. Note that this call does not shutdown the cluster.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class HBaseCluster

Throws:

IOException

See Also:

HBaseCluster.shutdown()

getClusterStatus

public ClusterStatus getClusterStatus()
                               throws IOException

Description copied from class: HBaseCluster

Returns a ClusterStatus for this HBase cluster.

Specified by:

getClusterStatus in class HBaseCluster

Throws:

IOException

See Also:

HBaseCluster.getInitialClusterStatus()

flushcache

public void flushcache()
                throws IOException

Call flushCache on all regions on all participating regionservers.

Throws:

IOException

flushcache

public void flushcache(TableName tableName)
                throws IOException

Call flushCache on all regions of the specified table.

Throws:

IOException

compact

public void compact(boolean major)
             throws IOException

Call flushCache on all regions on all participating regionservers.

Throws:

IOException

compact

public void compact(TableName tableName,
                    boolean major)
             throws IOException

Call flushCache on all regions of the specified table.

Throws:

IOException

getRegionServerThreads

public List<JVMClusterUtil.RegionServerThread> getRegionServerThreads()

Returns:

List of region server threads.

getLiveRegionServerThreads

public List<JVMClusterUtil.RegionServerThread> getLiveRegionServerThreads()

Returns:

List of live region server threads (skips the aborted and the killed)

getRegionServer

public HRegionServer getRegionServer(int serverNumber)

Grab a numbered region server of your choice.

Parameters:

serverNumber -

Returns:

region server

getRegions

public List<HRegion> getRegions(byte[] tableName)

getRegions

public List<HRegion> getRegions(TableName tableName)

getServerWithMeta

public int getServerWithMeta()

Returns:

Index into List of getRegionServerThreads() of HRS carrying regionName. Returns -1 if none found.

getServerWith

public int getServerWith(byte[] regionName)

Get the location of the specified region

Parameters:

regionName - Name of the region in bytes

Returns:

Index into List of getRegionServerThreads() of HRS carrying hbase:meta. Returns -1 if none found.

getServerHoldingRegion

public ServerName getServerHoldingRegion(TableName tn,
                                         byte[] regionName)
                                  throws IOException

Description copied from class: HBaseCluster

Get the ServerName of region server serving the specified region

Specified by:

getServerHoldingRegion in class HBaseCluster

Parameters:

tn - Table name that has the region.

regionName - Name of the region in bytes

Returns:

ServerName that hosts the region or null

Throws:

IOException

countServedRegions

public long countServedRegions()

Counts the total numbers of regions being served by the currently online region servers by asking each how many regions they have. Does not look at hbase:meta at all. Count includes catalog tables.

Returns:

number of regions being served by all region servers

killAll

public void killAll()

Do a simulated kill all masters and regionservers. Useful when it is impossible to bring the mini-cluster back for clean shutdown.

waitUntilShutDown

public void waitUntilShutDown()

Description copied from class: HBaseCluster

Wait for HBase Cluster to shut down.

Specified by:

waitUntilShutDown in class HBaseCluster

findRegionsForTable

public List<HRegion> findRegionsForTable(TableName tableName)

getRegionServerIndex

protected int getRegionServerIndex(ServerName serverName)

getMasterIndex

protected int getMasterIndex(ServerName serverName)

getAdminProtocol

public AdminProtos.AdminService.BlockingInterface getAdminProtocol(ServerName serverName)
                                                            throws IOException

Description copied from class: HBaseCluster

Returns an AdminProtocol interface to the regionserver

Specified by:

getAdminProtocol in class HBaseCluster

Throws:

IOException

getClientProtocol

public ClientProtos.ClientService.BlockingInterface getClientProtocol(ServerName serverName)
                                                               throws IOException

Description copied from class: HBaseCluster

Returns a ClientProtocol interface to the regionserver

Specified by:

getClientProtocol in class HBaseCluster

Throws:

IOException