org.apache.hadoop.hbase.client

类 ConnectionUtils.ShortCircuitingClusterConnection

java.lang.Object

org.apache.hadoop.hbase.client.ConnectionUtils.ShortCircuitingClusterConnection

所有已实现的接口:

Closeable, AutoCloseable, Abortable, ClusterConnection, Connection

封闭类:

ConnectionUtils

public static class ConnectionUtils.ShortCircuitingClusterConnection
extends Object

A ClusterConnection that will short-circuit RPC making direct invocations against the localhost if the invocation target is 'this' server; save on network and protobuf invocations.

字段概要

字段

限定符和类型	字段和说明
protected String	clusterId
static String	RETRIES_BY_SERVER_KEY
protected User	user

从接口继承的字段 org.apache.hadoop.hbase.client.ClusterConnection

HBASE_CLIENT_CONNECTION_IMPL

方法概要

限定符和类型	方法和说明
void	abort(String msg, Throwable t) Abort the server or client.
void	cacheLocation(TableName tableName, RegionLocations location) Put a newly discovered HRegionLocation into the cache.
void	clearCaches(ServerName serverName) 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	clearRegionCache(TableName tableName, byte[] row)
void	close()
void	deleteCachedRegionLocation(HRegionLocation location) Deletes cached locations for the specific region.
protected void	finalize() Close the connection for good.
Admin	getAdmin() Retrieve an Admin implementation to administer an HBase cluster.
org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface	getAdmin(ServerName sn) Establishes a connection to the region server at the specified address.
org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface	getAdminForMaster() Get the admin service for master.
org.apache.hadoop.hbase.client.AsyncProcess	getAsyncProcess()
ClientBackoffPolicy	getBackoffPolicy()
BufferedMutator	getBufferedMutator(BufferedMutatorParams params) Retrieve a BufferedMutator for performing client-side buffering of writes.
BufferedMutator	getBufferedMutator(TableName tableName) Retrieve a BufferedMutator for performing client-side buffering of writes.
org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.BlockingInterface	getClient(ServerName sn) Establishes a connection to the region server at the specified address, and returns a region client protocol.
org.apache.hadoop.conf.Configuration	getConfiguration()
ConnectionConfiguration	getConnectionConfiguration()
MetricsConnection	getConnectionMetrics()
protected ExecutorService	getCurrentBatchPool()
protected ExecutorService	getCurrentMetaLookupPool()
int	getCurrentNrHRS()
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
RegionLocator	getRegionLocator(TableName tableName) Retrieve a RegionLocator implementation to inspect region information on a table.
RpcControllerFactory	getRpcControllerFactory()
RpcRetryingCallerFactory	getRpcRetryingCallerFactory()
ServerStatisticTracker	getStatisticsTracker()
Table	getTable(TableName tableName) Retrieve a Table implementation for accessing a table.
TableBuilder	getTableBuilder(TableName tableName, ExecutorService pool) Returns an TableBuilder for creating Table.
TableState	getTableState(TableName tableName) Retrieve TableState, represent current table state.
boolean	hasCellBlockSupport()
boolean	isAborted() Check if the server or client was aborted.
boolean	isClosed() Returns whether the connection is closed or not.
boolean	isMasterRunning() 已过时。 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.
protected void	retrieveClusterId()
String	toString() An identifier that will remain the same for a given connection.
void	updateCachedLocations(TableName tableName, byte[] regionName, byte[] rowkey, Object exception, ServerName source) Update the location with the new value (if the exception is a RegionMovedException) or delete it from the cache.

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.apache.hadoop.hbase.client.Connection

getTable

字段详细资料

RETRIES_BY_SERVER_KEY

public static final String RETRIES_BY_SERVER_KEY

另请参阅:

常量字段值

user

protected User user

clusterId

protected String clusterId

方法详细资料

getAdmin

public org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface getAdmin(ServerName sn)
                                                                                                      throws IOException

从接口复制的说明: ClusterConnection

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

指定者:

getAdmin 在接口中 ClusterConnection

参数:

sn - the region server to connect to

返回:

proxy for HRegionServer

抛出:

IOException - if a remote or network exception occurs

getClient

public org.apache.hadoop.hbase.shaded.protobuf.generated.ClientProtos.ClientService.BlockingInterface getClient(ServerName sn)
                                                                                                         throws IOException

从接口复制的说明: ClusterConnection

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

指定者:

getClient 在接口中 ClusterConnection

参数:

sn - the region server to connect to

返回:

ClientProtocol proxy for RegionServer

抛出:

IOException - if a remote or network exception occurs

getMaster

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

从接口复制的说明: ClusterConnection

Returns a MasterKeepAliveConnection to the active master

指定者:

getMaster 在接口中 ClusterConnection

抛出:

IOException

getTable

public Table getTable(TableName tableName)
               throws IOException

从接口复制的说明: Connection

Retrieve a Table implementation for accessing a table. The returned Table is not thread safe, a new instance should be created for each using thread. This is a lightweight operation, pooling or caching of the returned Table is neither required nor desired.

The caller is responsible for calling Table.close() on the returned table instance.

Since 0.98.1 this method no longer checks table existence. An exception will be thrown if the table does not exist only when the first operation is attempted.

指定者:

getTable 在接口中 Connection

参数:

tableName - the name of the table

返回:

a Table to use for interactions with this table

抛出:

IOException

getTableBuilder

public TableBuilder getTableBuilder(TableName tableName,
                                    ExecutorService pool)

从接口复制的说明: Connection

Returns an TableBuilder for creating Table.

指定者:

getTableBuilder 在接口中 Connection

参数:

tableName - the name of the table

pool - the thread pool to use for requests like batch and scan

getBufferedMutator

public BufferedMutator getBufferedMutator(BufferedMutatorParams params)

从接口复制的说明: Connection

Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This object can be used for long lived table operations. The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.

指定者:

getBufferedMutator 在接口中 Connection

参数:

params - details on how to instantiate the BufferedMutator.

返回:

a BufferedMutator for the supplied tableName.

getBufferedMutator

public BufferedMutator getBufferedMutator(TableName tableName)

从接口复制的说明: Connection

Retrieve a BufferedMutator for performing client-side buffering of writes. The BufferedMutator returned by this method is thread-safe. This BufferedMutator will use the Connection's ExecutorService. This object can be used for long lived operations.

The caller is responsible for calling BufferedMutator.close() on the returned BufferedMutator instance.

This accessor will use the connection's ExecutorService and will throw an exception in the main thread when an asynchronous exception occurs.

指定者:

getBufferedMutator 在接口中 Connection

参数:

tableName - the name of the table

返回:

a BufferedMutator for the supplied tableName.

getRegionLocator

public RegionLocator getRegionLocator(TableName tableName)
                               throws IOException

从接口复制的说明: Connection

Retrieve a RegionLocator implementation to inspect region information on a table. The returned RegionLocator is not thread-safe, so a new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned RegionLocator is neither required nor desired.
The caller is responsible for calling Closeable.close() on the returned RegionLocator instance. RegionLocator needs to be unmanaged

指定者:

getRegionLocator 在接口中 Connection

参数:

tableName - Name of the table who's region is to be examined

返回:

A RegionLocator instance

抛出:

IOException

getAdmin

public Admin getAdmin()
               throws IOException

从接口复制的说明: Connection

Retrieve an Admin implementation to administer an HBase cluster. The returned Admin is not guaranteed to be thread-safe. A new instance should be created for each using thread. This is a lightweight operation. Pooling or caching of the returned Admin is not recommended.
The caller is responsible for calling Admin.close() on the returned Admin instance.

指定者:

getAdmin 在接口中 Connection

返回:

an Admin instance for cluster administration

抛出:

IOException

getConnectionMetrics

public MetricsConnection getConnectionMetrics()

指定者:

getConnectionMetrics 在接口中 ClusterConnection

返回:

the MetricsConnection instance associated with this connection.

getCurrentMetaLookupPool

protected ExecutorService getCurrentMetaLookupPool()

getCurrentBatchPool

protected ExecutorService getCurrentBatchPool()

toString

public String toString()

An identifier that will remain the same for a given connection.

覆盖:

toString 在类中 Object

retrieveClusterId

protected void retrieveClusterId()

getConfiguration

public org.apache.hadoop.conf.Configuration getConfiguration()

指定者:

getConfiguration 在接口中 Connection

返回:

Configuration instance being used by this Connection instance.

isMasterRunning

@Deprecated
public boolean isMasterRunning()
                                    throws MasterNotRunningException,
                                           ZooKeeperConnectionException

已过时。 this has been deprecated without a replacement

指定者:

isMasterRunning 在接口中 ClusterConnection

返回:

true if the master is running, throws an exception otherwise

抛出:

MasterNotRunningException - - if the master is not running

ZooKeeperConnectionException

getRegionLocation

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

从接口复制的说明: ClusterConnection

Find region location hosting passed row

指定者:

getRegionLocation 在接口中 ClusterConnection

参数:

tableName - table name

row - Row to find.

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

返回:

Location of row.

抛出:

IOException - if a remote or network exception occurs

isTableEnabled

public boolean isTableEnabled(TableName tableName)
                       throws IOException

从接口复制的说明: ClusterConnection

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

指定者:

isTableEnabled 在接口中 ClusterConnection

参数:

tableName - table name

返回:

true if the table is enabled, false otherwise

抛出:

IOException - if a remote or network exception occurs

isTableDisabled

public boolean isTableDisabled(TableName tableName)
                        throws IOException

指定者:

isTableDisabled 在接口中 ClusterConnection

参数:

tableName - table name

返回:

true if the table is disabled, false otherwise

抛出:

IOException - if a remote or network exception occurs

isTableAvailable

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

从接口复制的说明: ClusterConnection

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.

指定者:

isTableAvailable 在接口中 ClusterConnection

参数:

tableName - tableName

splitKeys - splitKeys used while creating table

抛出:

IOException - if a remote or network exception occurs

locateRegion

public HRegionLocation locateRegion(byte[] regionName)
                             throws IOException

从接口复制的说明: ClusterConnection

Gets the location of the region of regionName.

指定者:

locateRegion 在接口中 ClusterConnection

参数:

regionName - name of the region to locate

返回:

HRegionLocation that describes where to find the region in question

抛出:

IOException - if a remote or network exception occurs

locateRegions

public List<HRegionLocation> locateRegions(TableName tableName)
                                    throws IOException

从接口复制的说明: ClusterConnection

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

指定者:

locateRegions 在接口中 ClusterConnection

参数:

tableName - table to get regions of

返回:

list of region locations for all regions of table

抛出:

IOException - if IO failure occurs

locateRegions

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

从接口复制的说明: ClusterConnection

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

指定者:

locateRegions 在接口中 ClusterConnection

参数:

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.

返回:

list of region locations for all regions of table

抛出:

IOException - if IO failure occurs

locateRegion

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

从接口复制的说明: ClusterConnection

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

指定者:

locateRegion 在接口中 ClusterConnection

参数:

tableName - name of the table row is in

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

返回:

HRegionLocation that describes where to find the region in question

抛出:

IOException - if a remote or network exception occurs

relocateRegion

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

从接口复制的说明: ClusterConnection

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

指定者:

relocateRegion 在接口中 ClusterConnection

参数:

tableName - name of the table row is in

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

返回:

HRegionLocation that describes where to find the region in question

抛出:

IOException - if a remote or network exception occurs

relocateRegion

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

从接口复制的说明: ClusterConnection

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

指定者:

relocateRegion 在接口中 ClusterConnection

参数:

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

返回:

RegionLocations that describe where to find the region in question

抛出:

IOException - if a remote or network exception occurs

locateRegion

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

指定者:

locateRegion 在接口中 ClusterConnection

参数:

tableName - table to get regions of

row - the row

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

retry - do we retry

返回:

region locations for this row.

抛出:

IOException - if IO failure occurs

locateRegion

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

指定者:

locateRegion 在接口中 ClusterConnection

参数:

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

返回:

region locations for this row.

抛出:

IOException - if IO failure occurs

cacheLocation

public void cacheLocation(TableName tableName,
                          RegionLocations location)

Put a newly discovered HRegionLocation into the cache.

指定者:

cacheLocation 在接口中 ClusterConnection

参数:

tableName - The table name.

location - the new location

clearRegionCache

public void clearRegionCache(TableName tableName,
                             byte[] row)

clearCaches

public void clearCaches(ServerName serverName)

从接口复制的说明: ClusterConnection

Clear any caches that pertain to server name sn.

指定者:

clearCaches 在接口中 ClusterConnection

参数:

serverName - A server name

clearRegionCache

public void clearRegionCache()

从接口复制的说明: ClusterConnection

Allows flushing the region cache.

指定者:

clearRegionCache 在接口中 ClusterConnection

clearRegionCache

public void clearRegionCache(TableName tableName)

从接口复制的说明: ClusterConnection

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

指定者:

clearRegionCache 在接口中 ClusterConnection

参数:

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

getAdminForMaster

public org.apache.hadoop.hbase.shaded.protobuf.generated.AdminProtos.AdminService.BlockingInterface getAdminForMaster()
                                                                                                               throws IOException

从接口复制的说明: ClusterConnection

Get the admin service for master.

指定者:

getAdminForMaster 在接口中 ClusterConnection

抛出:

IOException

deleteCachedRegionLocation

public void deleteCachedRegionLocation(HRegionLocation location)

从接口复制的说明: ClusterConnection

Deletes cached locations for the specific region.

指定者:

deleteCachedRegionLocation 在接口中 ClusterConnection

参数:

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

updateCachedLocations

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

Update the location with the new value (if the exception is a RegionMovedException) or delete it from the cache. Does nothing if we can be sure from the exception that the location is still accurate, or if the cache has already been updated.

指定者:

updateCachedLocations 在接口中 ClusterConnection

参数:

exception - an object (to simplify user code) on which we will try to find a nested or wrapped or both RegionMovedException

source - server that is the source of the location update.

tableName - the table name

regionName - the region name

rowkey - the row

getAsyncProcess

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

指定者:

getAsyncProcess 在接口中 ClusterConnection

返回:

Default AsyncProcess associated with this connection.

getStatisticsTracker

public ServerStatisticTracker getStatisticsTracker()

指定者:

getStatisticsTracker 在接口中 ClusterConnection

返回:

the current statistics tracker associated with this connection

getBackoffPolicy

public ClientBackoffPolicy getBackoffPolicy()

指定者:

getBackoffPolicy 在接口中 ClusterConnection

返回:

the configured client backoff policy

abort

public void abort(String msg,
                  Throwable t)

从接口复制的说明: Abortable

Abort the server or client.

指定者:

abort 在接口中 Abortable

参数:

msg - Why we're aborting.

t - Throwable that caused abort. Can be null.

isClosed

public boolean isClosed()

从接口复制的说明: Connection

Returns whether the connection is closed or not.

指定者:

isClosed 在接口中 Connection

返回:

true if this connection is closed

isAborted

public boolean isAborted()

从接口复制的说明: Abortable

Check if the server or client was aborted.

指定者:

isAborted 在接口中 Abortable

返回:

true if the server or client was aborted, false otherwise

getCurrentNrHRS

public int getCurrentNrHRS()
                    throws IOException

指定者:

getCurrentNrHRS 在接口中 ClusterConnection

返回:

the number of region servers that are currently running

抛出:

IOException - if a remote or network exception occurs

close

public void close()

指定者:

close 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

指定者:

close 在接口中 Connection

finalize

protected void finalize()
                 throws Throwable

Close the connection for good. On the off chance that someone is unable to close the connection, perhaps because it bailed out prematurely, the method below will ensure that this instance is cleaned up. Caveat: The JVM may take an unknown amount of time to call finalize on an unreachable object, so our hope is that every consumer cleans up after itself, like any good citizen.

覆盖:

finalize 在类中 Object

抛出:

Throwable

getNonceGenerator

public NonceGenerator getNonceGenerator()

指定者:

getNonceGenerator 在接口中 ClusterConnection

返回:

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

getTableState

public TableState getTableState(TableName tableName)
                         throws IOException

从接口复制的说明: ClusterConnection

Retrieve TableState, represent current table state.

指定者:

getTableState 在接口中 ClusterConnection

参数:

tableName - table state for

返回:

state of the table

抛出:

IOException

getNewRpcRetryingCallerFactory

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

从接口复制的说明: ClusterConnection

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

指定者:

getNewRpcRetryingCallerFactory 在接口中 ClusterConnection

参数:

conf - configuration

返回:

RpcRetryingCallerFactory

hasCellBlockSupport

public boolean hasCellBlockSupport()

指定者:

hasCellBlockSupport 在接口中 ClusterConnection

返回:

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

getConnectionConfiguration

public ConnectionConfiguration getConnectionConfiguration()

指定者:

getConnectionConfiguration 在接口中 ClusterConnection

返回:

a ConnectionConfiguration object holding parsed configuration values

getRpcRetryingCallerFactory

public RpcRetryingCallerFactory getRpcRetryingCallerFactory()

指定者:

getRpcRetryingCallerFactory 在接口中 ClusterConnection

返回:

Connection's RpcRetryingCallerFactory instance

getRpcControllerFactory

public RpcControllerFactory getRpcControllerFactory()

指定者:

getRpcControllerFactory 在接口中 ClusterConnection

返回:

Connection's RpcControllerFactory instance