org.apache.hadoop.hbase.client

Interface AsyncConnection

All Superinterfaces:

AutoCloseable, Closeable

@InterfaceAudience.Public
public interface AsyncConnection
extends Closeable

The asynchronous version of Connection.

Method Summary

Modifier and Type	Method and Description
AsyncAdmin	getAdmin() Retrieve an AsyncAdmin implementation to administer an HBase cluster.
org.apache.hadoop.conf.Configuration	getConfiguration() Returns the Configuration object used by this instance.
default RawAsyncTable	getRawTable(TableName tableName) Retrieve an RawAsyncTable implementation for accessing a table.
AsyncTableBuilder<RawAsyncTable>	getRawTableBuilder(TableName tableName) Returns an AsyncTableBuilder for creating RawAsyncTable.
AsyncTableRegionLocator	getRegionLocator(TableName tableName) Retrieve a AsyncRegionLocator implementation to inspect region information on a table.
default AsyncTable	getTable(TableName tableName, ExecutorService pool) Retrieve an AsyncTable implementation for accessing a table.
AsyncTableBuilder<AsyncTable>	getTableBuilder(TableName tableName, ExecutorService pool) Returns an AsyncTableBuilder for creating AsyncTable.

Methods inherited from interface java.io.Closeable

close

Method Detail

getConfiguration

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

Returns the Configuration object used by this instance.

The reference returned is not a copy, so any change made to it will affect this instance.

getRegionLocator

AsyncTableRegionLocator getRegionLocator(TableName tableName)

Retrieve a AsyncRegionLocator implementation to inspect region information on a table. The returned AsyncRegionLocator 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 AsyncRegionLocator is neither required nor desired.

Parameters:

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

Returns:

An AsyncRegionLocator instance

getRawTable

default RawAsyncTable getRawTable(TableName tableName)

Retrieve an RawAsyncTable implementation for accessing a table.

The returned instance will use default configs. Use getRawTableBuilder(TableName) if you want to customize some configs.

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.

Parameters:

tableName - the name of the table

Returns:

an RawAsyncTable to use for interactions with this table

See Also:

getRawTableBuilder(TableName)

getRawTableBuilder

AsyncTableBuilder<RawAsyncTable> getRawTableBuilder(TableName tableName)

Returns an AsyncTableBuilder for creating RawAsyncTable.

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.

Parameters:

tableName - the name of the table

getTable

default AsyncTable getTable(TableName tableName,
                            ExecutorService pool)

Retrieve an AsyncTable implementation for accessing a table.

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.

Parameters:

tableName - the name of the table

pool - the thread pool to use for executing callback

Returns:

an AsyncTable to use for interactions with this table

getTableBuilder

AsyncTableBuilder<AsyncTable> getTableBuilder(TableName tableName,
                                              ExecutorService pool)

Returns an AsyncTableBuilder for creating AsyncTable.

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.

Parameters:

tableName - the name of the table

pool - the thread pool to use for executing callback

getAdmin

AsyncAdmin getAdmin()

Retrieve an AsyncAdmin implementation to administer an HBase cluster. The returned AsyncAdmin 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 AsyncAdmin is not recommended.

Returns:

an AsyncAdmin instance for cluster administration