org.apache.hadoop.hbase.client

Interface AsyncTable

All Superinterfaces:

AsyncTableBase

@InterfaceAudience.Public
public interface AsyncTable
extends AsyncTableBase

The asynchronous table for normal users.

The implementation is required to be thread safe.

The implementation should make sure that user can do everything they want to the returned CompletableFuture without breaking anything. Usually the implementation will require user to provide a ExecutorService.

Method Summary

Modifier and Type	Method and Description
default ResultScanner	getScanner(byte[] family) Gets a scanner on the current table for the given family.
default ResultScanner	getScanner(byte[] family, byte[] qualifier) Gets a scanner on the current table for the given family and qualifier.
ResultScanner	getScanner(Scan scan) Returns a scanner on the current table as specified by the Scan object.
void	scan(Scan scan, ScanResultConsumer consumer) The scan API uses the observer pattern.

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

append, batch, batchAll, checkAndDelete, checkAndDelete, checkAndMutate, checkAndMutate, checkAndPut, checkAndPut, delete, delete, deleteAll, exists, exists, existsAll, get, get, getAll, getConfiguration, getName, getOperationTimeout, getReadRpcTimeout, getRpcTimeout, getScanTimeout, getWriteRpcTimeout, increment, incrementColumnValue, incrementColumnValue, mutateRow, put, put, putAll, scanAll

Method Detail

getScanner

default ResultScanner getScanner(byte[] family)

Gets a scanner on the current table for the given family.

Parameters:

family - The column family to scan.

Returns:

A scanner.

getScanner

default ResultScanner getScanner(byte[] family,
                                 byte[] qualifier)

Gets a scanner on the current table for the given family and qualifier.

Parameters:

family - The column family to scan.

qualifier - The column qualifier to scan.

Returns:

A scanner.

getScanner

ResultScanner getScanner(Scan scan)

Returns a scanner on the current table as specified by the Scan object.

Parameters:

scan - A configured Scan object.

Returns:

A scanner.

scan

void scan(Scan scan,
          ScanResultConsumer consumer)

The scan API uses the observer pattern. All results that match the given scan object will be passed to the given consumer by calling ScanResultConsumer.onNext(Result). ScanResultConsumer.onComplete() means the scan is finished, and ScanResultConsumer.onError(Throwable) means we hit an unrecoverable error and the scan is terminated.

Parameters:

scan - A configured Scan object.

consumer - the consumer used to receive results.