Package org.apache.hadoop.hbase.backup

Class BackupObserver

java.lang.Object

org.apache.hadoop.hbase.backup.BackupObserver

All Implemented Interfaces:

Coprocessor, RegionCoprocessor, RegionObserver

@LimitedPrivate("Configuration")
public class BackupObserver
extends Object
implements RegionCoprocessor, RegionObserver

An Observer to facilitate backup operations

Nested Class Summary

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

Coprocessor.State

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

RegionObserver.MutationType

Field Summary

Fields

Modifier and Type	Field	Description
private static final org.slf4j.Logger	LOG

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

PRIORITY_HIGHEST, PRIORITY_LOWEST, PRIORITY_SYSTEM, PRIORITY_USER, VERSION

Constructor Summary

Constructors

Constructor	Description
BackupObserver()

Method Summary

Modifier and Type	Method	Description
Optional<RegionObserver>	getRegionObserver()
void	postBulkLoadHFile(ObserverContext<? extends RegionCoprocessorEnvironment> ctx, List<Pair<byte[],String>> stagingFamilyPaths, Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)	Called after bulkLoadHFile.
void	preCommitStoreFile(ObserverContext<? extends RegionCoprocessorEnvironment> ctx, byte[] family, List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)	Called before moving bulk loaded hfile to region directory.

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

getServices, start, stop

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.RegionCoprocessor

getBulkLoadObserver, getEndpointObserver

Methods inherited from interface org.apache.hadoop.hbase.coprocessor.RegionObserver

postAppend, postAppend, postAppendBeforeWAL, postBatchMutate, postBatchMutateIndispensably, postCheckAndDelete, postCheckAndDelete, postCheckAndMutate, postCheckAndPut, postCheckAndPut, postClose, postCloseRegionOperation, postCommitStoreFile, postCompact, postCompactSelection, postDelete, postDelete, postExists, postFlush, postFlush, postGetOp, postIncrement, postIncrement, postIncrementBeforeWAL, postInstantiateDeleteTracker, postMemStoreCompaction, postMutationBeforeWAL, postOpen, postPut, postPut, postReplayWALs, postScannerClose, postScannerFilterRow, postScannerNext, postScannerOpen, postStartRegionOperation, postStoreFileReaderOpen, preAppend, preAppend, preAppendAfterRowLock, preBatchMutate, preBulkLoadHFile, preCheckAndDelete, preCheckAndDelete, preCheckAndDeleteAfterRowLock, preCheckAndDeleteAfterRowLock, preCheckAndMutate, preCheckAndMutateAfterRowLock, preCheckAndPut, preCheckAndPut, preCheckAndPutAfterRowLock, preCheckAndPutAfterRowLock, preClose, preCompact, preCompactScannerOpen, preCompactSelection, preDelete, preDelete, preExists, preFlush, preFlush, preFlushScannerOpen, preGetOp, preIncrement, preIncrement, preIncrementAfterRowLock, preMemStoreCompaction, preMemStoreCompactionCompact, preMemStoreCompactionCompactScannerOpen, preOpen, prePrepareTimeStampForDeleteVersion, prePut, prePut, preReplayWALs, preScannerClose, preScannerNext, preScannerOpen, preStoreFileReaderOpen, preStoreScannerOpen, preWALAppend

Field Details

LOG

private static final org.slf4j.Logger LOG

Constructor Details

BackupObserver

public BackupObserver()

Method Details

getRegionObserver

public Optional<RegionObserver> getRegionObserver()

Specified by:

getRegionObserver in interface RegionCoprocessor

postBulkLoadHFile

public void postBulkLoadHFile(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,
 List<Pair<byte[],String>> stagingFamilyPaths,
 Map<byte[],List<org.apache.hadoop.fs.Path>> finalPaths)
                       throws IOException

Description copied from interface: RegionObserver

Called after bulkLoadHFile.

Specified by:

postBulkLoadHFile in interface RegionObserver

Parameters:

ctx - the environment provided by the region server

stagingFamilyPaths - pairs of { CF, HFile path } submitted for bulk load

finalPaths - Map of CF to List of file paths for the loaded files if the Map is not null, the bulkLoad was successful. Otherwise the bulk load failed. bulkload is done by the time this hook is called.

Throws:

IOException

preCommitStoreFile

public void preCommitStoreFile(ObserverContext<? extends RegionCoprocessorEnvironment> ctx,
 byte[] family,
 List<Pair<org.apache.hadoop.fs.Path,org.apache.hadoop.fs.Path>> pairs)
                        throws IOException

Description copied from interface: RegionObserver

Called before moving bulk loaded hfile to region directory.

Specified by:

preCommitStoreFile in interface RegionObserver

Parameters:

ctx - the environment provided by the region server

family - column family

pairs - List of pairs of { HFile location in staging dir, HFile path in region dir } Each pair are for the same hfile.

Throws:

IOException