TableSnapshotInputFormat (Apache HBase 1.2.12 API)

java.lang.Object
- org.apache.hadoop.hbase.mapred.TableSnapshotInputFormat

All Implemented Interfaces:

org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>

Direct Known Subclasses:

MultiTableSnapshotInputFormat
```
@InterfaceAudience.Public
@InterfaceStability.Evolving
public class TableSnapshotInputFormat
extends Object
implements org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>
```
TableSnapshotInputFormat allows a MapReduce job to run over a table snapshot. Further documentation available on TableSnapshotInputFormat.

See Also:
TableSnapshotInputFormat

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`(package private) static class`	`TableSnapshotInputFormat.TableSnapshotRecordReader`
`static class`	`TableSnapshotInputFormat.TableSnapshotRegionSplit`

Constructor Summary

Constructors
Constructor and Description

TableSnapshotInputFormat()

Constructors
Constructor and Description
`TableSnapshotInputFormat()`

Method Summary

Methods
Modifier and Type	Method and Description
`org.apache.hadoop.mapred.RecordReader<ImmutableBytesWritable,Result>`	`getRecordReader(org.apache.hadoop.mapred.InputSplit split, org.apache.hadoop.mapred.JobConf job, org.apache.hadoop.mapred.Reporter reporter)`
`org.apache.hadoop.mapred.InputSplit[]`	`getSplits(org.apache.hadoop.mapred.JobConf job, int numSplits)`
`static void`	`setInput(org.apache.hadoop.mapred.JobConf job, String snapshotName, org.apache.hadoop.fs.Path restoreDir)` 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

Constructor Detail
- TableSnapshotInputFormat
```
public TableSnapshotInputFormat()
```

Method Detail

getSplits

public org.apache.hadoop.mapred.InputSplit[] getSplits(org.apache.hadoop.mapred.JobConf job,
                                              int numSplits)
                                                throws IOException

Specified by:: getSplits in interface org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>
Throws:: IOException

getRecordReader

public org.apache.hadoop.mapred.RecordReader<ImmutableBytesWritable,Result> getRecordReader(org.apache.hadoop.mapred.InputSplit split,
                                                                                   org.apache.hadoop.mapred.JobConf job,
                                                                                   org.apache.hadoop.mapred.Reporter reporter)
                                                                                     throws IOException

Specified by:: getRecordReader in interface org.apache.hadoop.mapred.InputFormat<ImmutableBytesWritable,Result>
Throws:: IOException

setInput
```
public static void setInput(org.apache.hadoop.mapred.JobConf job,
            String snapshotName,
            org.apache.hadoop.fs.Path restoreDir)
                     throws IOException
```
Configures the job to use TableSnapshotInputFormat to read from a snapshot.

Parameters:
job - 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.

Throws:

IOException - if an error occurs

Class TableSnapshotInputFormat

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TableSnapshotInputFormat

Method Detail

getSplits

getRecordReader

setInput