org.apache.hadoop.hbase.client

Interface ClusterConnection

All Superinterfaces:

Abortable, AutoCloseable, Closeable, Connection

All Known Implementing Classes:

ConnectionUtils.ShortCircuitingClusterConnection

@InterfaceAudience.Private
public interface ClusterConnection
extends Connection

Internal methods on Connection that should not be used by user code.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HBASE_CLIENT_CONNECTION_IMPL Key for configuration in Configuration whose value is the class we implement making a new Connection instance.

Method Summary

Modifier and Type	Method and Description
void	cacheLocation(TableName tableName, RegionLocations location)
void	clearCaches(ServerName sn) Clear any caches that pertain to server name sn.
void	clearRegionCache() Allows flushing the region cache.
void	clearRegionCache(TableName tableName) Allows flushing the region cache of all locations that pertain to tableName
void	deleteCachedRegionLocation(HRegionLocation location) Deletes cached locations for the specific region.
AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName serverName) Establishes a connection to the region server at the specified address.
AdminProtos.AdminService.BlockingInterface	getAdminForMaster() Get the admin service for master.
org.apache.hadoop.hbase.client.AsyncProcess	getAsyncProcess()
ClientBackoffPolicy	getBackoffPolicy()
ClientProtos.ClientService.BlockingInterface	getClient(ServerName serverName) Establishes a connection to the region server at the specified address, and returns a region client protocol.
ConnectionConfiguration	getConnectionConfiguration()
MetricsConnection	getConnectionMetrics()
int	getCurrentNrHRS()
Hbck	getHbck() Retrieve an Hbck implementation to fix an HBase cluster.
Hbck	getHbck(ServerName masterServer) Retrieve an Hbck implementation to fix an HBase cluster.
org.apache.hadoop.hbase.client.MasterKeepAliveConnection	getMaster() Returns a MasterKeepAliveConnection to the active master
RpcRetryingCallerFactory	getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration conf) Returns a new RpcRetryingCallerFactory from the given Configuration.
NonceGenerator	getNonceGenerator()
HRegionLocation	getRegionLocation(TableName tableName, byte[] row, boolean reload) Find region location hosting passed row
RpcControllerFactory	getRpcControllerFactory()
RpcRetryingCallerFactory	getRpcRetryingCallerFactory()
ServerStatisticTracker	getStatisticsTracker()
TableState	getTableState(TableName tableName) Retrieve TableState, represent current table state.
boolean	hasCellBlockSupport()
boolean	isMasterRunning() Deprecated. this has been deprecated without a replacement
boolean	isTableAvailable(TableName tableName, byte[][] splitKeys) Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table.
boolean	isTableDisabled(TableName tableName)
boolean	isTableEnabled(TableName tableName) A table that isTableEnabled == false and isTableDisabled == false is possible.
HRegionLocation	locateRegion(byte[] regionName) Gets the location of the region of regionName.
HRegionLocation	locateRegion(TableName tableName, byte[] row) Find the location of the region of tableName that row lives in.
RegionLocations	locateRegion(TableName tableName, byte[] row, boolean useCache, boolean retry)
RegionLocations	locateRegion(TableName tableName, byte[] row, boolean useCache, boolean retry, int replicaId)
List<HRegionLocation>	locateRegions(TableName tableName) Gets the locations of all regions in the specified table, tableName.
List<HRegionLocation>	locateRegions(TableName tableName, boolean useCache, boolean offlined) Gets the locations of all regions in the specified table, tableName.
HRegionLocation	relocateRegion(TableName tableName, byte[] row) Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.
RegionLocations	relocateRegion(TableName tableName, byte[] row, int replicaId) Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.
void	updateCachedLocations(TableName tableName, byte[] regionName, byte[] rowkey, Object exception, ServerName source) Update the location cache.

Methods inherited from interface org.apache.hadoop.hbase.client.Connection

close, getAdmin, getBufferedMutator, getBufferedMutator, getConfiguration, getRegionLocator, getTable, getTable, getTableBuilder, isClosed

Methods inherited from interface org.apache.hadoop.hbase.Abortable

abort, isAborted

Field Detail

HBASE_CLIENT_CONNECTION_IMPL

static final String HBASE_CLIENT_CONNECTION_IMPL

Key for configuration in Configuration whose value is the class we implement making a new Connection instance.

See Also:

Constant Field Values

Method Detail

isMasterRunning

@Deprecated
boolean isMasterRunning()
                             throws MasterNotRunningException,
                                    ZooKeeperConnectionException

Deprecated. this has been deprecated without a replacement

Returns:

- true if the master server is running

Throws:

MasterNotRunningException

ZooKeeperConnectionException

isTableAvailable

boolean isTableAvailable(TableName tableName,
                         byte[][] splitKeys)
                  throws IOException

Use this api to check if the table has been created with the specified number of splitkeys which was used while creating the given table. Note : If this api is used after a table's region gets splitted, the api may return false.

Parameters:

tableName - tableName

splitKeys - splitKeys used while creating table

Throws:

IOException - if a remote or network exception occurs

isTableEnabled

boolean isTableEnabled(TableName tableName)
                throws IOException

A table that isTableEnabled == false and isTableDisabled == false is possible. This happens when a table has a lot of regions that must be processed.

Parameters:

tableName - table name

Returns:

true if the table is enabled, false otherwise

Throws:

IOException - if a remote or network exception occurs

isTableDisabled

boolean isTableDisabled(TableName tableName)
                 throws IOException

Parameters:

tableName - table name

Returns:

true if the table is disabled, false otherwise

Throws:

IOException - if a remote or network exception occurs

getTableState

TableState getTableState(TableName tableName)
                  throws IOException

Retrieve TableState, represent current table state.

Parameters:

tableName - table state for

Returns:

state of the table

Throws:

IOException

locateRegion

HRegionLocation locateRegion(TableName tableName,
                             byte[] row)
                      throws IOException

Find the location of the region of tableName that row lives in.

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

clearRegionCache

void clearRegionCache()

Allows flushing the region cache.

cacheLocation

void cacheLocation(TableName tableName,
                   RegionLocations location)

clearRegionCache

void clearRegionCache(TableName tableName)

Allows flushing the region cache of all locations that pertain to tableName

Parameters:

tableName - Name of the table whose regions we are to remove from cache.

deleteCachedRegionLocation

void deleteCachedRegionLocation(HRegionLocation location)

Deletes cached locations for the specific region.

Parameters:

location - The location object for the region, to be purged from cache.

relocateRegion

HRegionLocation relocateRegion(TableName tableName,
                               byte[] row)
                        throws IOException

Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

relocateRegion

RegionLocations relocateRegion(TableName tableName,
                               byte[] row,
                               int replicaId)
                        throws IOException

Find the location of the region of tableName that row lives in, ignoring any value that might be in the cache.

Parameters:

tableName - name of the table row is in

row - row key you're trying to find the region of

replicaId - the replicaId of the region

Returns:

RegionLocations that describe where to find the region in question

Throws:

IOException - if a remote or network exception occurs

updateCachedLocations

void updateCachedLocations(TableName tableName,
                           byte[] regionName,
                           byte[] rowkey,
                           Object exception,
                           ServerName source)

Update the location cache. This is used internally by HBase, in most cases it should not be used by the client application.

Parameters:

tableName - the table name

regionName - the region name

rowkey - the row

exception - the exception if any. Can be null.

source - the previous location

locateRegion

HRegionLocation locateRegion(byte[] regionName)
                      throws IOException

Gets the location of the region of regionName.

Parameters:

regionName - name of the region to locate

Returns:

HRegionLocation that describes where to find the region in question

Throws:

IOException - if a remote or network exception occurs

locateRegions

List<HRegionLocation> locateRegions(TableName tableName)
                             throws IOException

Gets the locations of all regions in the specified table, tableName.

Parameters:

tableName - table to get regions of

Returns:

list of region locations for all regions of table

Throws:

IOException - if IO failure occurs

locateRegions

List<HRegionLocation> locateRegions(TableName tableName,
                                    boolean useCache,
                                    boolean offlined)
                             throws IOException

Gets the locations of all regions in the specified table, tableName.

Parameters:

tableName - table to get regions of

useCache - Should we use the cache to retrieve the region information.

offlined - True if we are to include offlined regions, false and we'll leave out offlined regions from returned list.

Returns:

list of region locations for all regions of table

Throws:

IOException - if IO failure occurs

locateRegion

RegionLocations locateRegion(TableName tableName,
                             byte[] row,
                             boolean useCache,
                             boolean retry)
                      throws IOException

Parameters:

tableName - table to get regions of

row - the row

useCache - Should we use the cache to retrieve the region information.

retry - do we retry

Returns:

region locations for this row.

Throws:

IOException - if IO failure occurs

locateRegion

RegionLocations locateRegion(TableName tableName,
                             byte[] row,
                             boolean useCache,
                             boolean retry,
                             int replicaId)
                      throws IOException

Parameters:

tableName - table to get regions of

row - the row

useCache - Should we use the cache to retrieve the region information.

retry - do we retry

replicaId - the replicaId for the region

Returns:

region locations for this row.

Throws:

IOException - if IO failure occurs

getMaster

org.apache.hadoop.hbase.client.MasterKeepAliveConnection getMaster()
                                                            throws IOException

Returns a MasterKeepAliveConnection to the active master

Throws:

IOException

getAdminForMaster

AdminProtos.AdminService.BlockingInterface getAdminForMaster()
                                                      throws IOException

Get the admin service for master.

Throws:

IOException

getAdmin

AdminProtos.AdminService.BlockingInterface getAdmin(ServerName serverName)
                                             throws IOException

Establishes a connection to the region server at the specified address.

Parameters:

serverName - the region server to connect to

Returns:

proxy for HRegionServer

Throws:

IOException - if a remote or network exception occurs

getClient

ClientProtos.ClientService.BlockingInterface getClient(ServerName serverName)
                                                throws IOException

Establishes a connection to the region server at the specified address, and returns a region client protocol.

Parameters:

serverName - the region server to connect to

Returns:

ClientProtocol proxy for RegionServer

Throws:

IOException - if a remote or network exception occurs

getRegionLocation

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

Find region location hosting passed row

Parameters:

tableName - table name

row - Row to find.

reload - If true do not use cache, otherwise bypass.

Returns:

Location of row.

Throws:

IOException - if a remote or network exception occurs

clearCaches

void clearCaches(ServerName sn)

Clear any caches that pertain to server name sn.

Parameters:

sn - A server name

getNonceGenerator

NonceGenerator getNonceGenerator()

Returns:

Nonce generator for this ClusterConnection; may be null if disabled in configuration.

getAsyncProcess

org.apache.hadoop.hbase.client.AsyncProcess getAsyncProcess()

Returns:

Default AsyncProcess associated with this connection.

getNewRpcRetryingCallerFactory

RpcRetryingCallerFactory getNewRpcRetryingCallerFactory(org.apache.hadoop.conf.Configuration conf)

Returns a new RpcRetryingCallerFactory from the given Configuration. This RpcRetryingCallerFactory lets the users create RpcRetryingCallers which can be intercepted with the configured RetryingCallerInterceptor

Parameters:

conf - configuration

Returns:

RpcRetryingCallerFactory

getRpcRetryingCallerFactory

RpcRetryingCallerFactory getRpcRetryingCallerFactory()

Returns:

Connection's RpcRetryingCallerFactory instance

getRpcControllerFactory

RpcControllerFactory getRpcControllerFactory()

Returns:

Connection's RpcControllerFactory instance

getConnectionConfiguration

ConnectionConfiguration getConnectionConfiguration()

Returns:

a ConnectionConfiguration object holding parsed configuration values

getStatisticsTracker

ServerStatisticTracker getStatisticsTracker()

Returns:

the current statistics tracker associated with this connection

getBackoffPolicy

ClientBackoffPolicy getBackoffPolicy()

Returns:

the configured client backoff policy

getConnectionMetrics

MetricsConnection getConnectionMetrics()

Returns:

the MetricsConnection instance associated with this connection.

hasCellBlockSupport

boolean hasCellBlockSupport()

Returns:

true when this connection uses a Codec and so supports cell blocks.

getCurrentNrHRS

int getCurrentNrHRS()
             throws IOException

Returns:

the number of region servers that are currently running

Throws:

IOException - if a remote or network exception occurs

getHbck

Hbck getHbck()
      throws IOException

Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
The caller is responsible for calling Closeable.close() on the returned Hbck instance.
This will be used mostly by hbck tool.

Returns:

an Hbck instance for active master. Active master is fetched from the zookeeper.

Throws:

IOException

getHbck

Hbck getHbck(ServerName masterServer)
      throws IOException

Retrieve an Hbck implementation to fix an HBase cluster. The returned Hbck is not guaranteed to be thread-safe. A new instance should be created by each thread. This is a lightweight operation. Pooling or caching of the returned Hbck instance is not recommended.
The caller is responsible for calling Closeable.close() on the returned Hbck instance.
This will be used mostly by hbck tool. This may only be used to by pass getting registered master from ZK. In situations where ZK is not available or active master is not registered with ZK and user can get master address by other means, master can be explicitly specified.

Parameters:

masterServer - explicit ServerName for master server

Returns:

an Hbck instance for a specified master server

Throws:

IOException