|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
public interface RegionObserver
Coprocessors implement this interface to observe and mediate client actions on the region.
| Nested Class Summary |
|---|
| Nested classes/interfaces inherited from interface org.apache.hadoop.hbase.Coprocessor |
|---|
Coprocessor.State |
| Field Summary |
|---|
| Fields inherited from interface org.apache.hadoop.hbase.Coprocessor |
|---|
PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION |
| Method Summary | |
|---|---|
boolean |
postCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete,
boolean result)
Called after checkAndDelete |
boolean |
postCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put,
boolean result)
Called after checkAndPut |
void |
postClose(ObserverContext<RegionCoprocessorEnvironment> c,
boolean abortRequested)
Called after the region is reported as closed to the master. |
void |
postCompact(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
StoreFile resultFile)
Called after compaction has completed and the new store file has been moved in to place. |
void |
postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
com.google.common.collect.ImmutableList<StoreFile> selected)
Called after the StoreFiles to compact have been selected from the
available candidates. |
void |
postDelete(ObserverContext<RegionCoprocessorEnvironment> c,
Delete delete,
WALEdit edit,
boolean writeToWAL)
Called after the client deletes a value. |
boolean |
postExists(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
boolean exists)
Called after the client tests for existence using a Get. |
void |
postFlush(ObserverContext<RegionCoprocessorEnvironment> c)
Called after the memstore is flushed to disk. |
void |
postGet(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
List<KeyValue> result)
Called after the client performs a Get |
void |
postGetClosestRowBefore(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
Result result)
Called after a client makes a GetClosestRowBefore request. |
void |
postIncrement(ObserverContext<RegionCoprocessorEnvironment> c,
Increment increment,
Result result)
Called after increment |
long |
postIncrementColumnValue(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL,
long result)
Called after incrementColumnValue |
void |
postOpen(ObserverContext<RegionCoprocessorEnvironment> c)
Called after the region is reported as open to the master. |
void |
postPut(ObserverContext<RegionCoprocessorEnvironment> c,
Put put,
WALEdit edit,
boolean writeToWAL)
Called after the client stores a value. |
void |
postScannerClose(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s)
Called after the client closes a scanner. |
boolean |
postScannerNext(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s,
List<Result> result,
int limit,
boolean hasNext)
Called after the client asks for the next row on a scanner. |
RegionScanner |
postScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
Scan scan,
RegionScanner s)
Called after the client opens a new scanner. |
void |
postSplit(ObserverContext<RegionCoprocessorEnvironment> c,
HRegion l,
HRegion r)
Called after the region is split. |
void |
postWALRestore(ObserverContext<RegionCoprocessorEnvironment> ctx,
HRegionInfo info,
HLogKey logKey,
WALEdit logEdit)
Called after a WALEdit
replayed for this region. |
boolean |
preCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete,
boolean result)
Called before checkAndDelete |
boolean |
preCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put,
boolean result)
Called before checkAndPut |
void |
preClose(ObserverContext<RegionCoprocessorEnvironment> c,
boolean abortRequested)
Called before the region is reported as closed to the master. |
InternalScanner |
preCompact(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
InternalScanner scanner)
Called prior to writing the StoreFiles selected for compaction into
a new StoreFile. |
void |
preCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
List<StoreFile> candidates)
Called prior to selecting the StoreFiles to compact from the list
of available candidates. |
void |
preDelete(ObserverContext<RegionCoprocessorEnvironment> c,
Delete delete,
WALEdit edit,
boolean writeToWAL)
Called before the client deletes a value. |
boolean |
preExists(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
boolean exists)
Called before the client tests for existence using a Get. |
void |
preFlush(ObserverContext<RegionCoprocessorEnvironment> c)
Called before the memstore is flushed to disk. |
void |
preGet(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
List<KeyValue> result)
Called before the client performs a Get |
void |
preGetClosestRowBefore(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
Result result)
Called before a client makes a GetClosestRowBefore request. |
void |
preIncrement(ObserverContext<RegionCoprocessorEnvironment> c,
Increment increment,
Result result)
Called before Increment |
long |
preIncrementColumnValue(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
Called before incrementColumnValue |
void |
preOpen(ObserverContext<RegionCoprocessorEnvironment> c)
Called before the region is reported as open to the master. |
void |
prePut(ObserverContext<RegionCoprocessorEnvironment> c,
Put put,
WALEdit edit,
boolean writeToWAL)
Called before the client stores a value. |
void |
preScannerClose(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s)
Called before the client closes a scanner. |
boolean |
preScannerNext(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s,
List<Result> result,
int limit,
boolean hasNext)
Called before the client asks for the next row on a scanner. |
RegionScanner |
preScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
Scan scan,
RegionScanner s)
Called before the client opens a new scanner. |
void |
preSplit(ObserverContext<RegionCoprocessorEnvironment> c)
Called before the region is split. |
void |
preWALRestore(ObserverContext<RegionCoprocessorEnvironment> ctx,
HRegionInfo info,
HLogKey logKey,
WALEdit logEdit)
Called before a WALEdit
replayed for this region. |
| Methods inherited from interface org.apache.hadoop.hbase.Coprocessor |
|---|
start, stop |
| Method Detail |
|---|
void preOpen(ObserverContext<RegionCoprocessorEnvironment> c)
c - the environment provided by the region servervoid postOpen(ObserverContext<RegionCoprocessorEnvironment> c)
c - the environment provided by the region servervoid preFlush(ObserverContext<RegionCoprocessorEnvironment> c)
c - the environment provided by the region servervoid postFlush(ObserverContext<RegionCoprocessorEnvironment> c)
c - the environment provided by the region server
void preCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
List<StoreFile> candidates)
StoreFiles to compact from the list
of available candidates. To alter the files used for compaction, you may
mutate the passed in list of candidates.
c - the environment provided by the region serverstore - the store where compaction is being requestedcandidates - the store files currently available for compaction
void postCompactSelection(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
com.google.common.collect.ImmutableList<StoreFile> selected)
StoreFiles to compact have been selected from the
available candidates.
c - the environment provided by the region serverstore - the store being compactedselected - the store files selected to compact
InternalScanner preCompact(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
InternalScanner scanner)
StoreFiles selected for compaction into
a new StoreFile. To override or modify the compaction process,
implementing classes have two options:
InternalScanner with a custom
implementation that is returned from this method. The custom scanner
can then inspect KeyValues from the wrapped scanner, applying
its own policy to what gets written.ObserverContext.bypass()
and provide a custom implementation for writing of new
StoreFiles. Note: any implementations bypassing
core compaction using this approach must write out new store files
themselves or the existing data will no longer be available after
compaction.
c - the environment provided by the region serverstore - the store being compactedscanner - the scanner over existing data used in the store file
rewriting
null
unless the implementation is writing new store files on its own.
void postCompact(ObserverContext<RegionCoprocessorEnvironment> c,
Store store,
StoreFile resultFile)
c - the environment provided by the region serverstore - the store being compactedresultFile - the new store file written out during compactionvoid preSplit(ObserverContext<RegionCoprocessorEnvironment> c)
c - the environment provided by the region server
(e.getRegion() returns the parent region)
void postSplit(ObserverContext<RegionCoprocessorEnvironment> c,
HRegion l,
HRegion r)
c - the environment provided by the region server
(e.getRegion() returns the parent region)l - the left daughter regionr - the right daughter region
void preClose(ObserverContext<RegionCoprocessorEnvironment> c,
boolean abortRequested)
c - the environment provided by the region serverabortRequested - true if the region server is aborting
void postClose(ObserverContext<RegionCoprocessorEnvironment> c,
boolean abortRequested)
c - the environment provided by the region serverabortRequested - true if the region server is aborting
void preGetClosestRowBefore(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
Result result)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - the rowfamily - the familyresult - The result to return to the client if default processing
is bypassed. Can be modified. Will not be used if default processing
is not bypassed.
IOException - if an error occurred on the coprocessor
void postGetClosestRowBefore(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
Result result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - the rowfamily - the desired familyresult - the result to return to the client, modify as necessary
IOException - if an error occurred on the coprocessor
void preGet(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
List<KeyValue> result)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverget - the Get requestresult - The result to return to the client if default processing
is bypassed. Can be modified. Will not be used if default processing
is not bypassed.
IOException - if an error occurred on the coprocessor
void postGet(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
List<KeyValue> result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverget - the Get requestresult - the result to return to the client, modify as necessary
IOException - if an error occurred on the coprocessor
boolean preExists(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
boolean exists)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverget - the Get requestexists -
IOException - if an error occurred on the coprocessor
boolean postExists(ObserverContext<RegionCoprocessorEnvironment> c,
Get get,
boolean exists)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverget - the Get requestexists - the result returned by the region server
IOException - if an error occurred on the coprocessor
void prePut(ObserverContext<RegionCoprocessorEnvironment> c,
Put put,
WALEdit edit,
boolean writeToWAL)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverput - The Put objectedit - The WALEdit object that will be written to the walwriteToWAL - true if the change should be written to the WAL
IOException - if an error occurred on the coprocessor
void postPut(ObserverContext<RegionCoprocessorEnvironment> c,
Put put,
WALEdit edit,
boolean writeToWAL)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverput - The Put objectedit - The WALEdit object for the walwriteToWAL - true if the change should be written to the WAL
IOException - if an error occurred on the coprocessor
void preDelete(ObserverContext<RegionCoprocessorEnvironment> c,
Delete delete,
WALEdit edit,
boolean writeToWAL)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverdelete - The Delete objectedit - The WALEdit object for the walwriteToWAL - true if the change should be written to the WAL
IOException - if an error occurred on the coprocessor
void postDelete(ObserverContext<RegionCoprocessorEnvironment> c,
Delete delete,
WALEdit edit,
boolean writeToWAL)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverdelete - The Delete objectedit - The WALEdit object for the walwriteToWAL - true if the change should be written to the WAL
IOException - if an error occurred on the coprocessor
boolean preCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put,
boolean result)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifiercompareOp - the comparison operationcomparator - the comparatorput - data to put if check succeedsresult -
IOException - if an error occurred on the coprocessor
boolean postCheckAndPut(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Put put,
boolean result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifiercompareOp - the comparison operationcomparator - the comparatorput - data to put if check succeedsresult - from the checkAndPut
IOException - if an error occurred on the coprocessor
boolean preCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete,
boolean result)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifiercompareOp - the comparison operationcomparator - the comparatordelete - delete to commit if check succeedsresult -
IOException - if an error occurred on the coprocessor
boolean postCheckAndDelete(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
CompareFilter.CompareOp compareOp,
WritableByteArrayComparable comparator,
Delete delete,
boolean result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifiercompareOp - the comparison operationcomparator - the comparatordelete - delete to commit if check succeedsresult - from the CheckAndDelete
IOException - if an error occurred on the coprocessor
long preIncrementColumnValue(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifieramount - long amount to incrementwriteToWAL - true if the change should be written to the WAL
IOException - if an error occurred on the coprocessor
long postIncrementColumnValue(ObserverContext<RegionCoprocessorEnvironment> c,
byte[] row,
byte[] family,
byte[] qualifier,
long amount,
boolean writeToWAL,
long result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverrow - row to checkfamily - column familyqualifier - column qualifieramount - long amount to incrementwriteToWAL - true if the change should be written to the WALresult - the result returned by incrementColumnValue
IOException - if an error occurred on the coprocessor
void preIncrement(ObserverContext<RegionCoprocessorEnvironment> c,
Increment increment,
Result result)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverincrement - increment objectresult - The result to return to the client if default processing
is bypassed. Can be modified. Will not be used if default processing
is not bypassed.
IOException - if an error occurred on the coprocessor
void postIncrement(ObserverContext<RegionCoprocessorEnvironment> c,
Increment increment,
Result result)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverincrement - increment objectresult - the result returned by increment, can be modified
IOException - if an error occurred on the coprocessor
RegionScanner preScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
Scan scan,
RegionScanner s)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverscan - the Scan specifications - if not null, the base scanner
IOException - if an error occurred on the coprocessor
RegionScanner postScannerOpen(ObserverContext<RegionCoprocessorEnvironment> c,
Scan scan,
RegionScanner s)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region serverscan - the Scan specifications - if not null, the base scanner
IOException - if an error occurred on the coprocessor
boolean preScannerNext(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s,
List<Result> result,
int limit,
boolean hasNext)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region servers - the scannerresult - The result to return to the client if default processing
is bypassed. Can be modified. Will not be returned if default processing
is not bypassed.limit - the maximum number of results to returnhasNext - the 'has more' indication
IOException - if an error occurred on the coprocessor
boolean postScannerNext(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s,
List<Result> result,
int limit,
boolean hasNext)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region servers - the scannerresult - the result to return to the client, can be modifiedlimit - the maximum number of results to returnhasNext - the 'has more' indication
IOException - if an error occurred on the coprocessor
void preScannerClose(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s)
throws IOException
Call CoprocessorEnvironment#bypass to skip default actions
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region servers - the scanner
IOException - if an error occurred on the coprocessor
void postScannerClose(ObserverContext<RegionCoprocessorEnvironment> c,
InternalScanner s)
throws IOException
Call CoprocessorEnvironment#complete to skip any subsequent chained coprocessors
c - the environment provided by the region servers - the scanner
IOException - if an error occurred on the coprocessor
void preWALRestore(ObserverContext<RegionCoprocessorEnvironment> ctx,
HRegionInfo info,
HLogKey logKey,
WALEdit logEdit)
throws IOException
WALEdit
replayed for this region.
ctx - info - logKey - logEdit -
IOException
void postWALRestore(ObserverContext<RegionCoprocessorEnvironment> ctx,
HRegionInfo info,
HLogKey logKey,
WALEdit logEdit)
throws IOException
WALEdit
replayed for this region.
ctx - info - logKey - logEdit -
IOException
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||