org.apache.hadoop.hbase.mapreduce

Class TableSnapshotInputFormatImpl

java.lang.Object

org.apache.hadoop.hbase.mapreduce.TableSnapshotInputFormatImpl

public class TableSnapshotInputFormatImpl
extends java.lang.Object

Hadoop MR API-agnostic implementation for mapreduce over table snapshots.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TableSnapshotInputFormatImpl.InputSplit Implementation class for InputSplit logic common between mapred and mapreduce.
static class	TableSnapshotInputFormatImpl.RecordReader Implementation class for RecordReader logic common between mapred and mapreduce.

Field Summary

Fields

Modifier and Type	Field and Description
static Logger	LOG
static java.lang.String	NUM_SPLITS_PER_REGION For MapReduce jobs running multiple mappers per region, determines number of splits to generate per region.
protected static java.lang.String	RESTORE_DIR_KEY
static boolean	SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT
static java.lang.String	SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY Whether to calculate the block location for splits.
static java.lang.String	SPLIT_ALGO For MapReduce jobs running multiple mappers per region, determines what split algorithm we should be using to find split points for scanners.

Constructor Summary

Constructors

Constructor and Description
TableSnapshotInputFormatImpl()

Method Summary

Modifier and Type	Method and Description
static Scan	extractScanFromConf(Configuration conf)
static java.util.List<java.lang.String>	getBestLocations(Configuration conf, HDFSBlocksDistribution blockDistribution)
static java.util.List<HRegionInfo>	getRegionInfosFromManifest(SnapshotManifest manifest)
static SnapshotManifest	getSnapshotManifest(Configuration conf, java.lang.String snapshotName, Path rootDir, FileSystem fs)
static RegionSplitter.SplitAlgorithm	getSplitAlgo(Configuration conf)
static java.util.List<TableSnapshotInputFormatImpl.InputSplit>	getSplits(Configuration conf)
static java.util.List<TableSnapshotInputFormatImpl.InputSplit>	getSplits(Scan scan, SnapshotManifest manifest, java.util.List<HRegionInfo> regionManifests, Path restoreDir, Configuration conf)
static java.util.List<TableSnapshotInputFormatImpl.InputSplit>	getSplits(Scan scan, SnapshotManifest manifest, java.util.List<HRegionInfo> regionManifests, Path restoreDir, Configuration conf, RegionSplitter.SplitAlgorithm sa, int numSplits)
static void	setInput(Configuration conf, java.lang.String snapshotName, Path restoreDir) Configures the job to use TableSnapshotInputFormat to read from a snapshot.
static void	setInput(Configuration conf, java.lang.String snapshotName, Path restoreDir, RegionSplitter.SplitAlgorithm splitAlgo, int numSplitsPerRegion) Configures the job to use TableSnapshotInputFormat to read from a snapshot.

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final Logger LOG

RESTORE_DIR_KEY

protected static final java.lang.String RESTORE_DIR_KEY

See Also:

Constant Field Values

SPLIT_ALGO

public static final java.lang.String SPLIT_ALGO

For MapReduce jobs running multiple mappers per region, determines what split algorithm we should be using to find split points for scanners.

See Also:

Constant Field Values

NUM_SPLITS_PER_REGION

public static final java.lang.String NUM_SPLITS_PER_REGION

For MapReduce jobs running multiple mappers per region, determines number of splits to generate per region.

See Also:

Constant Field Values

SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY

public static final java.lang.String SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_KEY

Whether to calculate the block location for splits. Default to true. If the computing layer runs outside of HBase cluster, the block locality does not master. Setting this value to false could skip the calculation and save some time. Set access modifier to "public" so that these could be accessed by test classes of both org.apache.hadoop.hbase.mapred and org.apache.hadoop.hbase.mapreduce.

See Also:

Constant Field Values

SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT

public static final boolean SNAPSHOT_INPUTFORMAT_LOCALITY_ENABLED_DEFAULT

See Also:

Constant Field Values

Constructor Detail

TableSnapshotInputFormatImpl

public TableSnapshotInputFormatImpl()

Method Detail

getSplits

public static java.util.List<TableSnapshotInputFormatImpl.InputSplit> getSplits(Configuration conf)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

getSplitAlgo

public static RegionSplitter.SplitAlgorithm getSplitAlgo(Configuration conf)
                                                  throws java.io.IOException

Throws:

java.io.IOException

getRegionInfosFromManifest

public static java.util.List<HRegionInfo> getRegionInfosFromManifest(SnapshotManifest manifest)

getSnapshotManifest

public static SnapshotManifest getSnapshotManifest(Configuration conf,
                                                   java.lang.String snapshotName,
                                                   Path rootDir,
                                                   FileSystem fs)
                                            throws java.io.IOException

Throws:

java.io.IOException

extractScanFromConf

public static Scan extractScanFromConf(Configuration conf)
                                throws java.io.IOException

Throws:

java.io.IOException

getSplits

public static java.util.List<TableSnapshotInputFormatImpl.InputSplit> getSplits(Scan scan,
                                                                                SnapshotManifest manifest,
                                                                                java.util.List<HRegionInfo> regionManifests,
                                                                                Path restoreDir,
                                                                                Configuration conf)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

getSplits

public static java.util.List<TableSnapshotInputFormatImpl.InputSplit> getSplits(Scan scan,
                                                                                SnapshotManifest manifest,
                                                                                java.util.List<HRegionInfo> regionManifests,
                                                                                Path restoreDir,
                                                                                Configuration conf,
                                                                                RegionSplitter.SplitAlgorithm sa,
                                                                                int numSplits)
                                                                         throws java.io.IOException

Throws:

java.io.IOException

getBestLocations

public static java.util.List<java.lang.String> getBestLocations(Configuration conf,
                                                                HDFSBlocksDistribution blockDistribution)

setInput

public static void setInput(Configuration conf,
                            java.lang.String snapshotName,
                            Path restoreDir)
                     throws java.io.IOException

Configures the job to use TableSnapshotInputFormat to read from a snapshot.

Parameters:

conf - the job to configuration

snapshotName - the name of the snapshot to read from

restoreDir - a temporary directory to restore the snapshot into. Current user should have write permissions to this directory, and this should not be a subdirectory of rootdir. After the job is finished, restoreDir can be deleted.

Throws:

java.io.IOException - if an error occurs

setInput

public static void setInput(Configuration conf,
                            java.lang.String snapshotName,
                            Path restoreDir,
                            RegionSplitter.SplitAlgorithm splitAlgo,
                            int numSplitsPerRegion)
                     throws java.io.IOException

Configures the job to use TableSnapshotInputFormat to read from a snapshot.

Parameters:

conf - the job to configure

snapshotName - the name of the snapshot to read from

restoreDir - a temporary directory to restore the snapshot into. Current user should have write permissions to this directory, and this should not be a subdirectory of rootdir. After the job is finished, restoreDir can be deleted.

numSplitsPerRegion - how many input splits to generate per one region

splitAlgo - SplitAlgorithm to be used when generating InputSplits

Throws:

java.io.IOException - if an error occurs