org.apache.hadoop.hbase.client

Class HRegionLocator

java.lang.Object

org.apache.hadoop.hbase.client.HRegionLocator

All Implemented Interfaces:

Closeable, AutoCloseable, RegionLocator

@InterfaceAudience.Private
public class HRegionLocator
extends Object
implements RegionLocator

An implementation of RegionLocator. Used to view region location information for a single HBase table. Lightweight. Get as needed and just close when done. Instances of this class SHOULD NOT be constructed directly. Obtain an instance via Connection. See ConnectionFactory class comment for an example of how.

This class is thread safe

Field Summary

Fields

Modifier and Type	Field and Description
private ConnectionImplementation	connection
private TableName	tableName

Constructor Summary

Constructors

Constructor and Description
HRegionLocator(TableName tableName, ConnectionImplementation connection)

Method Summary

Modifier and Type	Method and Description
void	clearRegionLocationCache() Clear all the entries in the region location cache.
void	close()
List<HRegionLocation>	getAllRegionLocations() Retrieves all of the regions associated with this table.
TableName	getName() Gets the fully qualified table name instance of this table.
HRegionLocation	getRegionLocation(byte[] row, int replicaId, boolean reload) Finds the region with the given replica id on which the given row is being served.
List<HRegionLocation>	getRegionLocations(byte[] row, boolean reload) Find all the replicas for the region on which the given row is being served.
private List<RegionLocations>	listRegionLocations()

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.client.RegionLocator

getEndKeys, getRegionLocation, getRegionLocation, getRegionLocation, getRegionLocations, getStartEndKeys, getStartKeys

Field Detail

tableName

private final TableName tableName

connection

private final ConnectionImplementation connection

Constructor Detail

HRegionLocator

public HRegionLocator(TableName tableName,
                      ConnectionImplementation connection)

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getRegionLocation

public HRegionLocation getRegionLocation(byte[] row,
                                         int replicaId,
                                         boolean reload)
                                  throws IOException

Description copied from interface: RegionLocator

Finds the region with the given replica id on which the given row is being served.

Specified by:

getRegionLocation in interface RegionLocator

Parameters:

row - Row to find.

replicaId - the replica id

reload - true to reload information or false to use cached information

Returns:

Location of the row.

Throws:

IOException - if a remote or network exception occurs

getRegionLocations

public List<HRegionLocation> getRegionLocations(byte[] row,
                                                boolean reload)
                                         throws IOException

Description copied from interface: RegionLocator

Find all the replicas for the region on which the given row is being served.

Specified by:

getRegionLocations in interface RegionLocator

Parameters:

row - Row to find.

reload - true to reload information or false to use cached information

Returns:

Locations for all the replicas of the row.

Throws:

IOException - if a remote or network exception occurs

getAllRegionLocations

public List<HRegionLocation> getAllRegionLocations()
                                            throws IOException

Description copied from interface: RegionLocator

Retrieves all of the regions associated with this table.

Usually we will go to meta table directly in this method so there is no reload parameter.

Notice that the location for region replicas other than the default replica are also returned.

Specified by:

getAllRegionLocations in interface RegionLocator

Returns:

a List of all regions associated with this table.

Throws:

IOException - if a remote or network exception occurs

clearRegionLocationCache

public void clearRegionLocationCache()

Description copied from interface: RegionLocator

Clear all the entries in the region location cache.

This may cause performance issue so use it with caution.

Specified by:

clearRegionLocationCache in interface RegionLocator

getName

public TableName getName()

Description copied from interface: RegionLocator

Gets the fully qualified table name instance of this table.

Specified by:

getName in interface RegionLocator

listRegionLocations

private List<RegionLocations> listRegionLocations()
                                           throws IOException

Throws:

IOException