org.apache.tephra.hbase

Class TransactionAwareHTable

java.lang.Object

org.apache.tephra.AbstractTransactionAwareTable

org.apache.tephra.hbase.TransactionAwareHTable

All Implemented Interfaces:

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

public class TransactionAwareHTable
extends AbstractTransactionAwareTable
implements org.apache.hadoop.hbase.client.HTableInterface, TransactionAware

A Transaction Aware HTable implementation for HBase 0.96. Operations are committed as usual, but upon a failed or aborted transaction, they are rolled back to the state before the transaction was started.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.tephra.AbstractTransactionAwareTable

AbstractTransactionAwareTable.ActionChange

Field Summary

Fields inherited from class org.apache.tephra.AbstractTransactionAwareTable

allowNonTransactional, changeSets, conflictLevel, tx, txCodec

Constructor Summary

Constructors

Constructor and Description
TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable) Create a transactional aware instance of the passed HTable
TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable, boolean allowNonTransactional) Create a transactional aware instance of the passed HTable, with the option of allowing non-transactional operations.
TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable, TxConstants.ConflictDetection conflictLevel) Create a transactional aware instance of the passed HTable
TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable, TxConstants.ConflictDetection conflictLevel, boolean allowNonTransactional) Create a transactional aware instance of the passed HTable, with the option of allowing non-transactional operations.

Method Summary

Methods

Modifier and Type	Method and Description
void	addToOperation(org.apache.hadoop.hbase.client.OperationWithAttributes op, Transaction tx)
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)
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)
<R> void	batchCallback(List<? extends org.apache.hadoop.hbase.client.Row> actions, Object[] results, 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	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)
protected boolean	doCommit() Commits any pending writes by flushing the wrapped HTable instance.
protected boolean	doRollback() Rolls back any persisted changes from the transaction by issuing offsetting deletes to the wrapped HTable instance.
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.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.HTableDescriptor	getTableDescriptor()
protected byte[]	getTableKey() Returns the table name to use as a key prefix for the transaction change set.
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)
long	incrementColumnValue(byte[] row, byte[] family, byte[] qualifier, long amount, org.apache.hadoop.hbase.client.Durability durability)
boolean	isAutoFlush()
protected void	makeRollbackOperation(org.apache.hadoop.hbase.client.Delete delete)
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 org.apache.tephra.AbstractTransactionAwareTable

addToChangeSet, commitTx, getAllowNonTransactional, getChangeKey, getTransactionAwareName, getTxChanges, postTxCommit, rollbackTx, setAllowNonTransactional, startTx, updateTx

Methods inherited from class java.lang.Object

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

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

batchCoprocessorService, batchCoprocessorService, checkAndDelete, checkAndMutate, checkAndPut, existsAll

Methods inherited from interface org.apache.tephra.TransactionAware

commitTx, getTransactionAwareName, getTxChanges, postTxCommit, rollbackTx, startTx, updateTx

Constructor Detail

TransactionAwareHTable

public TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable)

Create a transactional aware instance of the passed HTable

Parameters:

hTable - underlying HBase table to use

TransactionAwareHTable

public TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable,
                      TxConstants.ConflictDetection conflictLevel)

Create a transactional aware instance of the passed HTable

Parameters:

hTable - underlying HBase table to use

conflictLevel - level of conflict detection to perform (defaults to COLUMN)

TransactionAwareHTable

public TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable,
                      boolean allowNonTransactional)

Create a transactional aware instance of the passed HTable, with the option of allowing non-transactional operations.

Parameters:

hTable - underlying HBase table to use

allowNonTransactional - if true, additional operations (checkAndPut, increment, checkAndDelete) will be available, though non-transactional

TransactionAwareHTable

public TransactionAwareHTable(org.apache.hadoop.hbase.client.HTableInterface hTable,
                      TxConstants.ConflictDetection conflictLevel,
                      boolean allowNonTransactional)

Create a transactional aware instance of the passed HTable, with the option of allowing non-transactional operations.

Parameters:

hTable - underlying HBase table to use

conflictLevel - level of conflict detection to perform (defaults to COLUMN)

allowNonTransactional - if true, additional operations (checkAndPut, increment, checkAndDelete) will be available, though non-transactional

Method Detail

getTableKey

protected byte[] getTableKey()

Description copied from class: AbstractTransactionAwareTable

Returns the table name to use as a key prefix for the transaction change set.

Specified by:

getTableKey in class AbstractTransactionAwareTable

doCommit

protected boolean doCommit()
                    throws IOException

Description copied from class: AbstractTransactionAwareTable

Commits any pending writes by flushing the wrapped HTable instance.

Specified by:

doCommit in class AbstractTransactionAwareTable

Throws:

IOException

doRollback

protected boolean doRollback()
                      throws Exception

Description copied from class: AbstractTransactionAwareTable

Rolls back any persisted changes from the transaction by issuing offsetting deletes to the wrapped HTable instance. How this is handled will depend on the delete API exposed by the specific version of HBase.

Specified by:

doRollback in class AbstractTransactionAwareTable

Throws:

Exception

getTableName

public byte[] getTableName()

Specified by:

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

getName

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

Specified by:

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

getConfiguration

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

Specified by:

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

getTableDescriptor

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

Specified by:

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

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.Table

Throws:

IOException

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

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.Table

Throws:

IOException

InterruptedException

batch

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

Specified by:

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

Throws:

IOException

InterruptedException

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.Table

Throws:

IOException

InterruptedException

batchCallback

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

Specified by:

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

Throws:

IOException

InterruptedException

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

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.Table

Throws:

IOException

mutateRow

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

Specified by:

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

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.Table

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.Table

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.Table

Throws:

IOException

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.Table

Throws:

IOException

incrementColumnValue

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

Specified by:

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

Throws:

IOException

isAutoFlush

public boolean isAutoFlush()

Specified by:

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

flushCommits

public void flushCommits()
                  throws IOException

Specified by:

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

Throws:

IOException

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.Table

Throws:

IOException

coprocessorService

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

Specified by:

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

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.Table

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.Table

Throws:

com.google.protobuf.ServiceException

Throwable

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

setAutoFlushTo

public void setAutoFlushTo(boolean autoFlush)

Specified by:

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

getWriteBufferSize

public long getWriteBufferSize()

Specified by:

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

Specified by:

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

setWriteBufferSize

public void setWriteBufferSize(long writeBufferSize)
                        throws IOException

Specified by:

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

Specified by:

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

Throws:

IOException

addToOperation

public void addToOperation(org.apache.hadoop.hbase.client.OperationWithAttributes op,
                  Transaction tx)
                    throws IOException

Throws:

IOException

makeRollbackOperation

protected void makeRollbackOperation(org.apache.hadoop.hbase.client.Delete delete)