mousio.hbase.async

Class HbaseClient

java.lang.Object

org.apache.hadoop.hbase.client.AbstractHbaseClient

mousio.hbase.async.HbaseClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class HbaseClient
extends AbstractHbaseClient
implements java.io.Closeable

Hbase client.

Field Summary

Fields inherited from class org.apache.hadoop.hbase.client.AbstractHbaseClient

clusterId

Constructor Summary

Constructors

Constructor and Description
HbaseClient(org.apache.hadoop.hbase.client.HConnection connection) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
<H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H	append(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Append append, H handler) Appends values to one or more columns within a single row.
<H extends ResponseHandler<java.lang.Boolean>> H	checkAndDelete(org.apache.hadoop.hbase.TableName table, byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Delete delete, H handler) Atomically checks if a row/family/qualifier value matches the expected value.
<H extends ResponseHandler<java.lang.Boolean>> H	checkAndMutate(org.apache.hadoop.hbase.TableName table, byte[] row, byte[] family, byte[] qualifier, org.apache.hadoop.hbase.filter.CompareFilter.CompareOp compareOp, byte[] value, org.apache.hadoop.hbase.client.RowMutations mutation, H handler) Atomically checks if a row/family/qualifier value matches the expected val If it does, it performs the row mutations.
<H extends ResponseHandler<java.lang.Boolean>> H	checkAndPut(org.apache.hadoop.hbase.TableName table, byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Put put, H handler) Atomically checks if a row/family/qualifier value matches the expected value.
void	close()
AsyncRpcChannel	coprocessorService(org.apache.hadoop.hbase.TableName table, byte[] row) Creates and returns a RpcChannel instance connected to the table region containing the specified row.
<H extends ResponseHandler<java.lang.Void>> H	delete(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Delete delete, H handler) Deletes the specified cells/row.
<H extends ResponseHandler<java.lang.Void>> H	delete(org.apache.hadoop.hbase.TableName table, java.util.List<org.apache.hadoop.hbase.client.Delete> deletes, H handler) Deletes the specified cells/rows in bulk.
<H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H	get(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Get get, H handler) Send a Get
<H extends ResponseHandler<org.apache.hadoop.hbase.client.Result[]>> H	get(org.apache.hadoop.hbase.TableName table, java.util.List<org.apache.hadoop.hbase.client.Get> gets, H handler) Send a Get
AsyncResultScanner	getScanner(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Scan scan) Send a scan and get a cell scanner
<H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H	increment(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Increment increment, H handler) Increments one or more columns within a single row.
<H extends ResponseHandler<java.lang.Long>> H	incrementColumnValue(org.apache.hadoop.hbase.TableName table, byte[] row, byte[] family, byte[] qualifier, long amount, org.apache.hadoop.hbase.client.Durability durability, H handler) Atomically increments a column value.
<H extends ResponseHandler<java.lang.Long>> H	incrementColumnValue(org.apache.hadoop.hbase.TableName table, byte[] row, byte[] family, byte[] qualifier, long amount, H handler) See incrementColumnValue(TableName, byte[], byte[], byte[], long, Durability, ResponseHandler) The Durability is defaulted to Durability.SYNC_WAL.
<H extends ResponseHandler<java.lang.Void>> H	mutateRow(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.RowMutations rm, H handler) Performs multiple mutations atomically on a single row.
<T> HbaseResponsePromise<T>	newPromise() Get a new promise chained to event loop of internal netty client
com.google.protobuf.RpcController	newRpcController(ResponseHandler<?> promise) Get a new Rpc controller
<H extends ResponseHandler<java.lang.Void>> H	put(org.apache.hadoop.hbase.TableName table, java.util.List<org.apache.hadoop.hbase.client.Put> puts, H handler) Send a list of puts to the server
<H extends ResponseHandler<java.lang.Void>> H	put(org.apache.hadoop.hbase.TableName table, org.apache.hadoop.hbase.client.Put put, H handler) Send a put

Methods inherited from class org.apache.hadoop.hbase.client.AbstractHbaseClient

getConnection

Methods inherited from class java.lang.Object

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

Constructor Detail

HbaseClient

public HbaseClient(org.apache.hadoop.hbase.client.HConnection connection)
            throws java.io.IOException

Constructor

Parameters:

connection - to Hbase

Throws:

java.io.IOException - if HConnection could not be set up

Method Detail

get

public <H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H get(org.apache.hadoop.hbase.TableName table,
                                                                       org.apache.hadoop.hbase.client.Get get,
                                                                       H handler)

Send a Get

Parameters:

table - to run get on

get - to fetch

handler - on response

Returns:

the handler with the result

get

public <H extends ResponseHandler<org.apache.hadoop.hbase.client.Result[]>> H get(org.apache.hadoop.hbase.TableName table,
                                                                         java.util.List<org.apache.hadoop.hbase.client.Get> gets,
                                                                         H handler)

Send a Get

Parameters:

table - to run get on

gets - to fetch

handler - on response

Returns:

the handler with the result

getScanner

public AsyncResultScanner getScanner(org.apache.hadoop.hbase.TableName table,
                            org.apache.hadoop.hbase.client.Scan scan)

Send a scan and get a cell scanner

Parameters:

table - to get scanner from

scan - to perform

Returns:

the handler with the ResponseHandler if successful

put

public <H extends ResponseHandler<java.lang.Void>> H put(org.apache.hadoop.hbase.TableName table,
                                                org.apache.hadoop.hbase.client.Put put,
                                                H handler)

Send a put

Type Parameters:

H - Type of Handler

Parameters:

table - to send Put to

put - to send

handler - to handle exceptions

Returns:

handler

put

public <H extends ResponseHandler<java.lang.Void>> H put(org.apache.hadoop.hbase.TableName table,
                                                java.util.List<org.apache.hadoop.hbase.client.Put> puts,
                                                H handler)

Send a list of puts to the server

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to send puts to

puts - to send

handler - to handle exceptions

Returns:

handler

checkAndPut

public <H extends ResponseHandler<java.lang.Boolean>> H checkAndPut(org.apache.hadoop.hbase.TableName table,
                                                           byte[] row,
                                                           byte[] family,
                                                           byte[] qualifier,
                                                           byte[] value,
                                                           org.apache.hadoop.hbase.client.Put put,
                                                           H handler)

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the put. If the passed value is null, the check is for the lack of column (ie: non-existance)

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to check on and send put to

row - to check

family - column family to check

qualifier - column qualifier to check

value - the expected value

put - data to put if check succeeds

handler - to handle exceptions

Returns:

true if the new put was executed, false otherwise

delete

public <H extends ResponseHandler<java.lang.Void>> H delete(org.apache.hadoop.hbase.TableName table,
                                                   org.apache.hadoop.hbase.client.Delete delete,
                                                   H handler)

Deletes the specified cells/row.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to send delete to

delete - The object that specifies what to delete.

handler - to handle exceptions

Returns:

handler of responses and exceptions

delete

public <H extends ResponseHandler<java.lang.Void>> H delete(org.apache.hadoop.hbase.TableName table,
                                                   java.util.List<org.apache.hadoop.hbase.client.Delete> deletes,
                                                   H handler)

Deletes the specified cells/rows in bulk.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to send deletes to

deletes - List of things to delete. List gets modified by this method (in particular it gets re-ordered, so the order in which the elements are inserted in the list gives no guarantee as to the order in which the Deletes are executed).

handler - to handle exceptions

Returns:

handler of responses and exceptions

checkAndDelete

public <H extends ResponseHandler<java.lang.Boolean>> H checkAndDelete(org.apache.hadoop.hbase.TableName table,
                                                              byte[] row,
                                                              byte[] family,
                                                              byte[] qualifier,
                                                              byte[] value,
                                                              org.apache.hadoop.hbase.client.Delete delete,
                                                              H handler)

Atomically checks if a row/family/qualifier value matches the expected value. If it does, it adds the delete. If the passed value is null, the check is for the lack of column (ie: non-existance)

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to send check and delete to

row - to check

family - column family to check

qualifier - column qualifier to check

value - the expected value

delete - data to delete if check succeeds

handler - to handle exceptions

Returns:

true if the new delete was executed, false otherwise

mutateRow

public <H extends ResponseHandler<java.lang.Void>> H mutateRow(org.apache.hadoop.hbase.TableName table,
                                                      org.apache.hadoop.hbase.client.RowMutations rm,
                                                      H handler)

Performs multiple mutations atomically on a single row. Currently Put and Delete are supported.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to mutate row on

rm - object that specifies the set of mutations to perform atomically

handler - to handle exceptions

Returns:

response handler

append

public <H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H append(org.apache.hadoop.hbase.TableName table,
                                                                          org.apache.hadoop.hbase.client.Append append,
                                                                          H handler)

Appends values to one or more columns within a single row.

This operation does not appear atomic to readers. Appends are done under a single row lock, so write operations to a row are synchronized, but readers do not take row locks so get and scan operations can see this operation partially completed.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to append to

append - object that specifies the columns and amounts to be used for the increment operations

handler - to handle exceptions

Returns:

handler with Result on success

increment

public <H extends ResponseHandler<org.apache.hadoop.hbase.client.Result>> H increment(org.apache.hadoop.hbase.TableName table,
                                                                             org.apache.hadoop.hbase.client.Increment increment,
                                                                             H handler)

Increments one or more columns within a single row.

This operation does not appear atomic to readers. Increments are done under a single row lock, so write operations to a row are synchronized, but readers do not take row locks so get and scan operations can see this operation partially completed.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to increment on

increment - object that specifies the columns and amounts to be used for the increment operations

handler - to handle exceptions

Returns:

handler with on success the values of columns after the increment

incrementColumnValue

public <H extends ResponseHandler<java.lang.Long>> H incrementColumnValue(org.apache.hadoop.hbase.TableName table,
                                                                 byte[] row,
                                                                 byte[] family,
                                                                 byte[] qualifier,
                                                                 long amount,
                                                                 H handler)

See incrementColumnValue(TableName, byte[], byte[], byte[], long, Durability, ResponseHandler)

The Durability is defaulted to Durability.SYNC_WAL.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to increment column value on

row - The row that contains the cell to increment.

family - The column family of the cell to increment.

qualifier - The column qualifier of the cell to increment.

amount - The amount to increment the cell with (or decrement, if the amount is negative).

handler - to handle response

Returns:

Response handler: on success The new value, post increment.

incrementColumnValue

public <H extends ResponseHandler<java.lang.Long>> H incrementColumnValue(org.apache.hadoop.hbase.TableName table,
                                                                 byte[] row,
                                                                 byte[] family,
                                                                 byte[] qualifier,
                                                                 long amount,
                                                                 org.apache.hadoop.hbase.client.Durability durability,
                                                                 H handler)

Atomically increments a column value. If the column value already exists and is not a big-endian long, this could throw an exception. If the column value does not yet exist it is initialized to amount and written to the specified column.

Setting durability to Durability.SKIP_WAL means that in a fail scenario you will lose any increments that have not been flushed.

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to increment column value on

row - The row that contains the cell to increment.

family - The column family of the cell to increment.

qualifier - The column qualifier of the cell to increment.

amount - The amount to increment the cell with (or decrement, if the amount is negative).

durability - The persistence guarantee for this increment.

handler - to handle response

Returns:

Response handler: on success The new value, post increment.

checkAndMutate

public <H extends ResponseHandler<java.lang.Boolean>> H checkAndMutate(org.apache.hadoop.hbase.TableName table,
                                                              byte[] row,
                                                              byte[] family,
                                                              byte[] qualifier,
                                                              org.apache.hadoop.hbase.filter.CompareFilter.CompareOp compareOp,
                                                              byte[] value,
                                                              org.apache.hadoop.hbase.client.RowMutations mutation,
                                                              H handler)

Atomically checks if a row/family/qualifier value matches the expected val If it does, it performs the row mutations. If the passed value is null, t is for the lack of column (ie: non-existence)

Type Parameters:

H - Handler to handle any exceptions

Parameters:

table - to check and mutate

row - to check

family - column family to check

qualifier - column qualifier to check

compareOp - the comparison operator

value - the expected value

mutation - mutations to perform if check succeeds

handler - for the response

Returns:

handler with response: true if the new put was executed, false otherwise

coprocessorService

public AsyncRpcChannel coprocessorService(org.apache.hadoop.hbase.TableName table,
                                 byte[] row)
                                   throws java.io.IOException

Creates and returns a RpcChannel instance connected to the table region containing the specified row. The row given does not actually have to exist. Whichever region would contain the row based on start and end keys will be used. Note that the row parameter is also not passed to the coprocessor handler registered for this protocol, unless the row is separately passed as an argument in the service request. The parameter here is only used to locate the region used to handle the call.

The obtained RpcChannel instance can be used to access a published coprocessor Service using standard protobuf service invocations:

 CoprocessorRpcChannel channel = myTable.coprocessorService(rowkey);
 MyService.BlockingInterface service = MyService.newBlockingStub(channel);
 MyCallRequest request = MyCallRequest.newBuilder()
     ...
     .build();
 MyCallResponse response = service.myCall(null, request);
 

Parameters:

table - to get service from

row - The row key used to identify the remote region location

Returns:

A CoprocessorRpcChannel instance

Throws:

java.io.IOException - when there was an error creating connection or getting location

newPromise

public <T> HbaseResponsePromise<T> newPromise()

Get a new promise chained to event loop of internal netty client

Type Parameters:

T - Type of response to return

Returns:

Hbase Response Promise

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException

newRpcController

public com.google.protobuf.RpcController newRpcController(ResponseHandler<?> promise)

Get a new Rpc controller

Parameters:

promise - to handle result

Returns:

new RpcController