org.apache.hadoop.hbase.client

Interface ClusterConnection

All Superinterfaces:

Abortable, AutoCloseable, Closeable, Connection, HConnection

All Known Implementing Classes:

CoprocessorHConnection

@InterfaceAudience.Private
public interface ClusterConnection
extends HConnection

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

Field Summary

Fields inherited from interface org.apache.hadoop.hbase.client.HConnection

HBASE_CLIENT_CONNECTION_IMPL

Method Summary

Modifier and Type	Method and Description
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.
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.
org.apache.hadoop.hbase.client.MasterKeepAliveConnection	getKeepAliveMasterService() Deprecated.
MasterProtos.MasterService.BlockingInterface	getMaster() Returns a MasterKeepAliveConnection to the active master
RpcRetryingCallerFactory	getNewRpcRetryingCallerFactory(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
ServerStatisticTracker	getStatisticsTracker()
boolean	isDeadServer(ServerName serverName) Deprecated. internal method, do not use thru HConnection
boolean	isManaged()
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.
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.HConnection

clearRegionCache, getAdmin, getAdmin, getConfiguration, getCurrentNrHRS, getHTableDescriptor, getHTableDescriptor, getHTableDescriptors, getHTableDescriptorsByTableName, getRegionCachePrefetch, getRegionCachePrefetch, getRegionLocation, getRegionLocator, getTable, getTable, getTable, getTable, getTable, getTable, getTableNames, isClosed, isTableAvailable, isTableAvailable, isTableAvailable, isTableDisabled, isTableDisabled, isTableEnabled, isTableEnabled, listTableNames, listTables, locateRegion, locateRegions, locateRegions, processBatch, processBatch, processBatchCallback, processBatchCallback, relocateRegion, setRegionCachePrefetch, setRegionCachePrefetch, updateCachedLocations, updateCachedLocations

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

close, getBufferedMutator, getBufferedMutator

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

abort, isAborted

Method Detail

isMasterRunning

@Deprecated
boolean isMasterRunning()
                             throws MasterNotRunningException,
                                    ZooKeeperConnectionException

Deprecated. this has been deprecated without a replacement

Specified by:

isMasterRunning in interface HConnection

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.

Specified by:

isTableAvailable in interface HConnection

Parameters:

tableName - tableName

splitKeys - splitKeys used while creating table

Throws:

IOException - if a remote or network exception occurs

locateRegion

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

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

Specified by:

locateRegion in interface HConnection

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.

Specified by:

clearRegionCache in interface HConnection

clearRegionCache

void clearRegionCache(TableName tableName)

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

Specified by:

clearRegionCache in interface HConnection

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.

Specified by:

deleteCachedRegionLocation in interface HConnection

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.

Specified by:

relocateRegion in interface HConnection

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.

Specified by:

updateCachedLocations in interface HConnection

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.

Specified by:

locateRegion in interface HConnection

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.

Specified by:

locateRegions in interface HConnection

Parameters:

tableName - table to get regions of

Returns:

list of region locations for all regions of table

Throws:

IOException

locateRegions

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

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

Specified by:

locateRegions in interface HConnection

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

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

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

getMaster

MasterProtos.MasterService.BlockingInterface getMaster()
                                                throws IOException

Returns a MasterKeepAliveConnection to the active master

Specified by:

getMaster in interface HConnection

Throws:

IOException

getAdmin

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

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

Specified by:

getAdmin in interface HConnection

Parameters:

serverName -

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.

Specified by:

getClient in interface HConnection

Parameters:

serverName -

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

Specified by:

getRegionLocation in interface HConnection

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.

Specified by:

clearCaches in interface HConnection

Parameters:

sn - A server name

getKeepAliveMasterService

@Deprecated
org.apache.hadoop.hbase.client.MasterKeepAliveConnection getKeepAliveMasterService()
                                                                                        throws MasterNotRunningException

Deprecated.

This function allows HBaseAdmin and potentially others to get a shared MasterService connection.

Specified by:

getKeepAliveMasterService in interface HConnection

Returns:

The shared instance. Never returns null.

Throws:

MasterNotRunningException

isDeadServer

@Deprecated
boolean isDeadServer(ServerName serverName)

Deprecated. internal method, do not use thru HConnection

Specified by:

isDeadServer in interface HConnection

Parameters:

serverName -

Returns:

true if the server is known as dead, false otherwise.

getNonceGenerator

NonceGenerator getNonceGenerator()

Specified by:

getNonceGenerator in interface HConnection

Returns:

Nonce generator for this HConnection; 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(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 -

Returns:

RpcRetryingCallerFactory

isManaged

boolean isManaged()

Returns:

true if this is a managed connection.

getStatisticsTracker

ServerStatisticTracker getStatisticsTracker()

Returns:

the current statistics tracker associated with this connection

getBackoffPolicy

ClientBackoffPolicy getBackoffPolicy()

Returns:

the configured client backoff policy