org.apache.gora.hbase.store

Class HBaseTableConnection

java.lang.Object

org.apache.gora.hbase.store.HBaseTableConnection

All Implemented Interfaces:

Closeable, AutoCloseable, org.apache.hadoop.hbase.client.HTableInterface

public class HBaseTableConnection
extends Object
implements org.apache.hadoop.hbase.client.HTableInterface

Thread safe implementation to connect to a HBase table.

Constructor Summary

Constructors

Constructor and Description
HBaseTableConnection(org.apache.hadoop.conf.Configuration conf, String tableName, boolean autoflush) Instantiate new connection.

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.hadoop.hbase.client.Result	append(org.apache.hadoop.hbase.client.Append append)
Object[]	batch(List<? extends org.apache.hadoop.hbase.client.Row> actions) Deprecated.
void	batch(List<? extends org.apache.hadoop.hbase.client.Row> actions, Object[] results)
<R> Object[]	batchCallback(List<? extends org.apache.hadoop.hbase.client.Row> actions, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback) Deprecated.
<R> void	batchCallback(List<? extends org.apache.hadoop.hbase.client.Row> actions, Object[] results, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
<R extends com.google.protobuf.Message> Map<byte[],R>	batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, com.google.protobuf.Message request, byte[] startKey, byte[] endKey, R responsePrototype)
<R extends com.google.protobuf.Message> void	batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor, com.google.protobuf.Message request, byte[] startKey, byte[] endKey, R responsePrototype, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
boolean	checkAndDelete(byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Delete delete)
boolean	checkAndMutate(byte[] arg0, byte[] arg1, byte[] arg2, org.apache.hadoop.hbase.filter.CompareFilter.CompareOp arg3, byte[] arg4, org.apache.hadoop.hbase.client.RowMutations arg5)
boolean	checkAndPut(byte[] row, byte[] family, byte[] qualifier, byte[] value, org.apache.hadoop.hbase.client.Put put)
void	close()
org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel	coprocessorService(byte[] row)
<T extends com.google.protobuf.Service,R> Map<byte[],R>	coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable)
<T extends com.google.protobuf.Service,R> void	coprocessorService(Class<T> service, byte[] startKey, byte[] endKey, org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable, org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
void	delete(org.apache.hadoop.hbase.client.Delete delete)
void	delete(List<org.apache.hadoop.hbase.client.Delete> deletes)
boolean	exists(org.apache.hadoop.hbase.client.Get get)
Boolean[]	exists(List<org.apache.hadoop.hbase.client.Get> gets)
void	flushCommits()
org.apache.hadoop.hbase.client.Result	get(org.apache.hadoop.hbase.client.Get get)
org.apache.hadoop.hbase.client.Result[]	get(List<org.apache.hadoop.hbase.client.Get> gets)
org.apache.hadoop.conf.Configuration	getConfiguration()
org.apache.hadoop.hbase.TableName	getName()
org.apache.hadoop.hbase.HRegionLocation	getRegionLocation(byte[] bs) getRegionLocation provided by HTable but not HTableInterface.
org.apache.hadoop.hbase.client.Result	getRowOrBefore(byte[] row, byte[] family)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(byte[] family)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(byte[] family, byte[] qualifier)
org.apache.hadoop.hbase.client.ResultScanner	getScanner(org.apache.hadoop.hbase.client.Scan scan)
org.apache.hadoop.hbase.util.Pair<byte[][],byte[][]>	getStartEndKeys() getStartEndKeys provided by HTable but not HTableInterface.
org.apache.hadoop.hbase.HTableDescriptor	getTableDescriptor()
byte[]	getTableName()
long	getWriteBufferSize()
org.apache.hadoop.hbase.client.Result	increment(org.apache.hadoop.hbase.client.Increment increment)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, boolean writeToWAL) Deprecated.
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, org.apache.hadoop.hbase.client.Durability durability)
boolean	isAutoFlush()
void	mutateRow(org.apache.hadoop.hbase.client.RowMutations rm)
void	put(List<org.apache.hadoop.hbase.client.Put> puts)
void	put(org.apache.hadoop.hbase.client.Put put)
void	setAutoFlush(boolean autoFlush)
void	setAutoFlush(boolean autoFlush, boolean clearBufferOnFail)
void	setAutoFlushTo(boolean autoFlush)
void	setWriteBufferSize(long writeBufferSize)

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseTableConnection

public HBaseTableConnection(org.apache.hadoop.conf.Configuration conf,
                    String tableName,
                    boolean autoflush)
                     throws IOException

Instantiate new connection.

Parameters:

conf -

tableName -

autoflush -

Throws:

IOException

Method Detail

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getTableName

public byte[] getTableName()

Specified by:

getTableName in interface org.apache.hadoop.hbase.client.HTableInterface

getConfiguration

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

Specified by:

getConfiguration in interface org.apache.hadoop.hbase.client.HTableInterface

isAutoFlush

public boolean isAutoFlush()

Specified by:

isAutoFlush in interface org.apache.hadoop.hbase.client.HTableInterface

getStartEndKeys

public org.apache.hadoop.hbase.util.Pair<byte[][],byte[][]> getStartEndKeys()
                                                                     throws IOException

getStartEndKeys provided by HTable but not HTableInterface.

Throws:

IOException

See Also:

HTable.getStartEndKeys()

getRegionLocation

public org.apache.hadoop.hbase.HRegionLocation getRegionLocation(byte[] bs)
                                                          throws IOException

getRegionLocation provided by HTable but not HTableInterface.

Throws:

IOException

See Also:

HTable.getRegionLocation(byte[])

getTableDescriptor

public org.apache.hadoop.hbase.HTableDescriptor getTableDescriptor()
                                                            throws IOException

Specified by:

getTableDescriptor in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

exists

public boolean exists(org.apache.hadoop.hbase.client.Get get)
               throws IOException

Specified by:

exists in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

get

public org.apache.hadoop.hbase.client.Result get(org.apache.hadoop.hbase.client.Get get)
                                          throws IOException

Specified by:

get in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

get

public org.apache.hadoop.hbase.client.Result[] get(List<org.apache.hadoop.hbase.client.Get> gets)
                                            throws IOException

Specified by:

get in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getRowOrBefore

public org.apache.hadoop.hbase.client.Result getRowOrBefore(byte[] row,
                                                   byte[] family)
                                                     throws IOException

Specified by:

getRowOrBefore in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(org.apache.hadoop.hbase.client.Scan scan)
                                                        throws IOException

Specified by:

getScanner in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(byte[] family)
                                                        throws IOException

Specified by:

getScanner in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getScanner

public org.apache.hadoop.hbase.client.ResultScanner getScanner(byte[] family,
                                                      byte[] qualifier)
                                                        throws IOException

Specified by:

getScanner in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

put

public void put(org.apache.hadoop.hbase.client.Put put)
         throws IOException

Specified by:

put in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

put

public void put(List<org.apache.hadoop.hbase.client.Put> puts)
         throws IOException

Specified by:

put in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

checkAndPut

public boolean checkAndPut(byte[] row,
                  byte[] family,
                  byte[] qualifier,
                  byte[] value,
                  org.apache.hadoop.hbase.client.Put put)
                    throws IOException

Specified by:

checkAndPut in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

delete

public void delete(org.apache.hadoop.hbase.client.Delete delete)
            throws IOException

Specified by:

delete in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

delete

public void delete(List<org.apache.hadoop.hbase.client.Delete> deletes)
            throws IOException

Specified by:

delete in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

checkAndDelete

public boolean checkAndDelete(byte[] row,
                     byte[] family,
                     byte[] qualifier,
                     byte[] value,
                     org.apache.hadoop.hbase.client.Delete delete)
                       throws IOException

Specified by:

checkAndDelete in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

increment

public org.apache.hadoop.hbase.client.Result increment(org.apache.hadoop.hbase.client.Increment increment)
                                                throws IOException

Specified by:

increment in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

incrementColumnValue

public long incrementColumnValue(byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        long amount)
                          throws IOException

Specified by:

incrementColumnValue in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

incrementColumnValue

@Deprecated
public long incrementColumnValue(byte[] row,
                                   byte[] family,
                                   byte[] qualifier,
                                   long amount,
                                   boolean writeToWAL)
                          throws IOException

Deprecated.

Specified by:

incrementColumnValue in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

flushCommits

public void flushCommits()
                  throws IOException

Specified by:

flushCommits in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

batch

public void batch(List<? extends org.apache.hadoop.hbase.client.Row> actions,
         Object[] results)
           throws IOException,
                  InterruptedException

Specified by:

batch in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

InterruptedException

mutateRow

public void mutateRow(org.apache.hadoop.hbase.client.RowMutations rm)
               throws IOException

Specified by:

mutateRow in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

append

public org.apache.hadoop.hbase.client.Result append(org.apache.hadoop.hbase.client.Append append)
                                             throws IOException

Specified by:

append in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

setAutoFlush

public void setAutoFlush(boolean autoFlush)

Specified by:

setAutoFlush in interface org.apache.hadoop.hbase.client.HTableInterface

setAutoFlush

public void setAutoFlush(boolean autoFlush,
                boolean clearBufferOnFail)

Specified by:

setAutoFlush in interface org.apache.hadoop.hbase.client.HTableInterface

getWriteBufferSize

public long getWriteBufferSize()

Specified by:

getWriteBufferSize in interface org.apache.hadoop.hbase.client.HTableInterface

setWriteBufferSize

public void setWriteBufferSize(long writeBufferSize)
                        throws IOException

Specified by:

setWriteBufferSize in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

getName

public org.apache.hadoop.hbase.TableName getName()

Specified by:

getName in interface org.apache.hadoop.hbase.client.HTableInterface

exists

public Boolean[] exists(List<org.apache.hadoop.hbase.client.Get> gets)
                 throws IOException

Specified by:

exists in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

batchCallback

public <R> void batchCallback(List<? extends org.apache.hadoop.hbase.client.Row> actions,
                     Object[] results,
                     org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
                   throws IOException,
                          InterruptedException

Specified by:

batchCallback in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

InterruptedException

batchCallback

@Deprecated
public <R> Object[] batchCallback(List<? extends org.apache.hadoop.hbase.client.Row> actions,
                                    org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
                       throws IOException,
                              InterruptedException

Deprecated.

Specified by:

batchCallback in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

InterruptedException

incrementColumnValue

public long incrementColumnValue(byte[] row,
                        byte[] family,
                        byte[] qualifier,
                        long amount,
                        org.apache.hadoop.hbase.client.Durability durability)
                          throws IOException

Specified by:

incrementColumnValue in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

coprocessorService

public org.apache.hadoop.hbase.ipc.CoprocessorRpcChannel coprocessorService(byte[] row)

Specified by:

coprocessorService in interface org.apache.hadoop.hbase.client.HTableInterface

coprocessorService

public <T extends com.google.protobuf.Service,R> Map<byte[],R> coprocessorService(Class<T> service,
                                                                         byte[] startKey,
                                                                         byte[] endKey,
                                                                         org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable)
                                 throws com.google.protobuf.ServiceException,
                                        Throwable

Specified by:

coprocessorService in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

com.google.protobuf.ServiceException

Throwable

coprocessorService

public <T extends com.google.protobuf.Service,R> void coprocessorService(Class<T> service,
                                                                byte[] startKey,
                                                                byte[] endKey,
                                                                org.apache.hadoop.hbase.client.coprocessor.Batch.Call<T,R> callable,
                                                                org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
                        throws com.google.protobuf.ServiceException,
                               Throwable

Specified by:

coprocessorService in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

com.google.protobuf.ServiceException

Throwable

setAutoFlushTo

public void setAutoFlushTo(boolean autoFlush)

Specified by:

setAutoFlushTo in interface org.apache.hadoop.hbase.client.HTableInterface

batchCoprocessorService

public <R extends com.google.protobuf.Message> Map<byte[],R> batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor,
                                                                            com.google.protobuf.Message request,
                                                                            byte[] startKey,
                                                                            byte[] endKey,
                                                                            R responsePrototype)
                                                                          throws com.google.protobuf.ServiceException,
                                                                                 Throwable

Specified by:

batchCoprocessorService in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

com.google.protobuf.ServiceException

Throwable

batchCoprocessorService

public <R extends com.google.protobuf.Message> void batchCoprocessorService(com.google.protobuf.Descriptors.MethodDescriptor methodDescriptor,
                                                                   com.google.protobuf.Message request,
                                                                   byte[] startKey,
                                                                   byte[] endKey,
                                                                   R responsePrototype,
                                                                   org.apache.hadoop.hbase.client.coprocessor.Batch.Callback<R> callback)
                             throws com.google.protobuf.ServiceException,
                                    Throwable

Specified by:

batchCoprocessorService in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

com.google.protobuf.ServiceException

Throwable

batch

@Deprecated
public Object[] batch(List<? extends org.apache.hadoop.hbase.client.Row> actions)
               throws IOException,
                      InterruptedException

Deprecated.

Specified by:

batch in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException

InterruptedException

checkAndMutate

public boolean checkAndMutate(byte[] arg0,
                     byte[] arg1,
                     byte[] arg2,
                     org.apache.hadoop.hbase.filter.CompareFilter.CompareOp arg3,
                     byte[] arg4,
                     org.apache.hadoop.hbase.client.RowMutations arg5)
                       throws IOException

Specified by:

checkAndMutate in interface org.apache.hadoop.hbase.client.HTableInterface

Throws:

IOException