co.cask.tephra.hbase10.coprocessor

Class TransactionProcessor

java.lang.Object

org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

co.cask.tephra.hbase10.coprocessor.TransactionProcessor

All Implemented Interfaces:

org.apache.hadoop.hbase.Coprocessor, org.apache.hadoop.hbase.coprocessor.RegionObserver

public class TransactionProcessor
extends org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

org.apache.hadoop.hbase.coprocessor.RegionObserver coprocessor that handles server-side processing for transactions:

• applies filtering to exclude data from invalid and in-progress transactions
• overrides the scanner returned for flush and compaction to drop data written by invalidated transactions, or expired due to TTL.

In order to use this coprocessor for transactions, configure the class on any table involved in transactions, or on all user tables by adding the following to hbase-site.xml: <property> <name>hbase.coprocessor.region.classes</name> <value>co.cask.tephra.hbase10.coprocessor.TransactionProcessor</value> </property>

HBase Get and Scan operations should have the current transaction serialized on to the operation as an attribute: Transaction t = ...; Get get = new Get(...); TransactionCodec codec = new TransactionCodec(); codec.addToOperation(get, t);

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.coprocessor.RegionObserver

org.apache.hadoop.hbase.coprocessor.RegionObserver.MutationType

Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor

org.apache.hadoop.hbase.Coprocessor.State

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	allowEmptyValues
protected Map<byte[],Long>	ttlByFamily

Fields inherited from interface org.apache.hadoop.hbase.Coprocessor

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor and Description
TransactionProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected org.apache.hadoop.hbase.regionserver.InternalScanner	createStoreScanner(org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment env, String action, TransactionSnapshot snapshot, org.apache.hadoop.hbase.regionserver.Store store, List<? extends org.apache.hadoop.hbase.regionserver.KeyValueScanner> scanners, org.apache.hadoop.hbase.regionserver.ScanType type, long earliestPutTs)
protected org.apache.hadoop.hbase.filter.Filter	getTransactionFilter(Transaction tx, org.apache.hadoop.hbase.regionserver.ScanType type) Derived classes can override this method to customize the filter used to return data visible for the current transaction.
protected com.google.common.base.Supplier<TransactionStateCache>	getTransactionStateCacheSupplier(org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment env)
org.apache.hadoop.hbase.regionserver.InternalScanner	preCompactScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> c, org.apache.hadoop.hbase.regionserver.Store store, List<? extends org.apache.hadoop.hbase.regionserver.KeyValueScanner> scanners, org.apache.hadoop.hbase.regionserver.ScanType scanType, long earliestPutTs, org.apache.hadoop.hbase.regionserver.InternalScanner s, org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest request)
void	preDelete(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e, org.apache.hadoop.hbase.client.Delete delete, org.apache.hadoop.hbase.regionserver.wal.WALEdit edit, org.apache.hadoop.hbase.client.Durability durability)
org.apache.hadoop.hbase.regionserver.InternalScanner	preFlushScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> c, org.apache.hadoop.hbase.regionserver.Store store, org.apache.hadoop.hbase.regionserver.KeyValueScanner memstoreScanner, org.apache.hadoop.hbase.regionserver.InternalScanner scanner)
void	preGetOp(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e, org.apache.hadoop.hbase.client.Get get, List<org.apache.hadoop.hbase.Cell> results)
org.apache.hadoop.hbase.regionserver.RegionScanner	preScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e, org.apache.hadoop.hbase.client.Scan scan, org.apache.hadoop.hbase.regionserver.RegionScanner s)
void	start(org.apache.hadoop.hbase.CoprocessorEnvironment e)
void	stop(org.apache.hadoop.hbase.CoprocessorEnvironment e)

Methods inherited from class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

postAppend, postBatchMutate, postBatchMutateIndispensably, postBulkLoadHFile, postCheckAndDelete, postCheckAndPut, postClose, postCloseRegionOperation, postCompact, postCompact, postCompactSelection, postCompactSelection, postCompleteSplit, postDelete, postExists, postFlush, postFlush, postGetClosestRowBefore, postGetOp, postIncrement, postIncrementColumnValue, postInstantiateDeleteTracker, postLogReplay, postMutationBeforeWAL, postOpen, postPut, postRollBackSplit, postScannerClose, postScannerFilterRow, postScannerNext, postScannerOpen, postSplit, postStartRegionOperation, postStoreFileReaderOpen, postWALRestore, postWALRestore, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndPut, preCheckAndPutAfterRowLock, preClose, preCompact, preCompact, preCompactScannerOpen, preCompactSelection, preCompactSelection, preExists, preFlush, preFlush, preGetClosestRowBefore, preIncrement, preIncrementAfterRowLock, preIncrementColumnValue, preOpen, prePrepareTimeStampForDeleteVersion, prePut, preRollBackSplit, preScannerClose, preScannerNext, preSplit, preSplit, preSplitAfterPONR, preSplitBeforePONR, preStoreFileReaderOpen, preStoreScannerOpen, preWALRestore, preWALRestore

Methods inherited from class java.lang.Object

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

Field Detail

ttlByFamily

protected Map<byte[],Long> ttlByFamily

allowEmptyValues

protected boolean allowEmptyValues

Constructor Detail

TransactionProcessor

public TransactionProcessor()

Method Detail

start

public void start(org.apache.hadoop.hbase.CoprocessorEnvironment e)
           throws IOException

Specified by:

start in interface org.apache.hadoop.hbase.Coprocessor

Overrides:

start in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

getTransactionStateCacheSupplier

protected com.google.common.base.Supplier<TransactionStateCache> getTransactionStateCacheSupplier(org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment env)

stop

public void stop(org.apache.hadoop.hbase.CoprocessorEnvironment e)
          throws IOException

Specified by:

stop in interface org.apache.hadoop.hbase.Coprocessor

Overrides:

stop in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

preGetOp

public void preGetOp(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e,
            org.apache.hadoop.hbase.client.Get get,
            List<org.apache.hadoop.hbase.Cell> results)
              throws IOException

Specified by:

preGetOp in interface org.apache.hadoop.hbase.coprocessor.RegionObserver

Overrides:

preGetOp in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

preDelete

public void preDelete(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e,
             org.apache.hadoop.hbase.client.Delete delete,
             org.apache.hadoop.hbase.regionserver.wal.WALEdit edit,
             org.apache.hadoop.hbase.client.Durability durability)
               throws IOException

Specified by:

preDelete in interface org.apache.hadoop.hbase.coprocessor.RegionObserver

Overrides:

preDelete in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

preScannerOpen

public org.apache.hadoop.hbase.regionserver.RegionScanner preScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> e,
                                                                org.apache.hadoop.hbase.client.Scan scan,
                                                                org.apache.hadoop.hbase.regionserver.RegionScanner s)
                                                                  throws IOException

Specified by:

preScannerOpen in interface org.apache.hadoop.hbase.coprocessor.RegionObserver

Overrides:

preScannerOpen in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

preFlushScannerOpen

public org.apache.hadoop.hbase.regionserver.InternalScanner preFlushScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> c,
                                                                       org.apache.hadoop.hbase.regionserver.Store store,
                                                                       org.apache.hadoop.hbase.regionserver.KeyValueScanner memstoreScanner,
                                                                       org.apache.hadoop.hbase.regionserver.InternalScanner scanner)
                                                                         throws IOException

Specified by:

preFlushScannerOpen in interface org.apache.hadoop.hbase.coprocessor.RegionObserver

Overrides:

preFlushScannerOpen in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

preCompactScannerOpen

public org.apache.hadoop.hbase.regionserver.InternalScanner preCompactScannerOpen(org.apache.hadoop.hbase.coprocessor.ObserverContext<org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment> c,
                                                                         org.apache.hadoop.hbase.regionserver.Store store,
                                                                         List<? extends org.apache.hadoop.hbase.regionserver.KeyValueScanner> scanners,
                                                                         org.apache.hadoop.hbase.regionserver.ScanType scanType,
                                                                         long earliestPutTs,
                                                                         org.apache.hadoop.hbase.regionserver.InternalScanner s,
                                                                         org.apache.hadoop.hbase.regionserver.compactions.CompactionRequest request)
                                                                           throws IOException

Specified by:

preCompactScannerOpen in interface org.apache.hadoop.hbase.coprocessor.RegionObserver

Overrides:

preCompactScannerOpen in class org.apache.hadoop.hbase.coprocessor.BaseRegionObserver

Throws:

IOException

createStoreScanner

protected org.apache.hadoop.hbase.regionserver.InternalScanner createStoreScanner(org.apache.hadoop.hbase.coprocessor.RegionCoprocessorEnvironment env,
                                                                      String action,
                                                                      TransactionSnapshot snapshot,
                                                                      org.apache.hadoop.hbase.regionserver.Store store,
                                                                      List<? extends org.apache.hadoop.hbase.regionserver.KeyValueScanner> scanners,
                                                                      org.apache.hadoop.hbase.regionserver.ScanType type,
                                                                      long earliestPutTs)
                                                                           throws IOException

Throws:

IOException

getTransactionFilter

protected org.apache.hadoop.hbase.filter.Filter getTransactionFilter(Transaction tx,
                                                         org.apache.hadoop.hbase.regionserver.ScanType type)

Derived classes can override this method to customize the filter used to return data visible for the current transaction.

Parameters:

tx - the current transaction to apply

type - the type of scan being performed