org.apache.hadoop.hbase.client

Interface RegionLocator

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

HRegionLocator, HTable

@InterfaceAudience.Public
@InterfaceStability.Evolving
public interface RegionLocator
extends Closeable

Used to view region location information for a single HBase table. Obtain an instance from an Connection.

Since:

0.99.0

See Also:

ConnectionFactory, Connection, Table

Method Summary

Methods

Modifier and Type	Method and Description
List<HRegionLocation>	getAllRegionLocations() Retrieves all of the regions associated with this table.
byte[][]	getEndKeys() Gets the ending row key for every region in the currently open table.
TableName	getName() Gets the fully qualified table name instance of this table.
HRegionLocation	getRegionLocation(byte[] row) Finds the region on which the given row is being served.
HRegionLocation	getRegionLocation(byte[] row, boolean reload) Finds the region on which the given row is being served.
Pair<byte[][],byte[][]>	getStartEndKeys() Gets the starting and ending row keys for every region in the currently open table.
byte[][]	getStartKeys() Gets the starting row key for every region in the currently open table.

Methods inherited from interface java.io.Closeable

close

Method Detail

getRegionLocation

HRegionLocation getRegionLocation(byte[] row)
                                  throws IOException

Finds the region on which the given row is being served. Does not reload the cache.

Parameters:

row - Row to find.

Returns:

Location of the row.

Throws:

IOException - if a remote or network exception occurs

getRegionLocation

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

Finds the region on which the given row is being served.

Parameters:

row - Row to find.

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

getAllRegionLocations

List<HRegionLocation> getAllRegionLocations()
                                            throws IOException

Retrieves all of the regions associated with this table.

Returns:

a List of all regions associated with this table.

Throws:

IOException - if a remote or network exception occurs

getStartKeys

byte[][] getStartKeys()
                      throws IOException

Gets the starting row key for every region in the currently open table.

This is mainly useful for the MapReduce integration.

Returns:

Array of region starting row keys

Throws:

IOException - if a remote or network exception occurs

getEndKeys

byte[][] getEndKeys()
                    throws IOException

Gets the ending row key for every region in the currently open table.

This is mainly useful for the MapReduce integration.

Returns:

Array of region ending row keys

Throws:

IOException - if a remote or network exception occurs

getStartEndKeys

Pair<byte[][],byte[][]> getStartEndKeys()
                                        throws IOException

Gets the starting and ending row keys for every region in the currently open table.

This is mainly useful for the MapReduce integration.

Returns:

Pair of arrays of region starting and ending row keys

Throws:

IOException - if a remote or network exception occurs

getName

TableName getName()

Gets the fully qualified table name instance of this table.