org.apache.hadoop.hbase.mapred

Class TableInputFormatBase

java.lang.Object

org.apache.hadoop.hbase.mapred.TableInputFormatBase

Direct Known Subclasses:

TableInputFormat, TestTableInputFormat.ExampleDeprecatedTIF, TestTableInputFormat.ExampleTIF

@InterfaceAudience.Public
 @InterfaceStability.Stable
public abstract class TableInputFormatBase
extends java.lang.Object

A Base for TableInputFormats. Receives a HTable, a byte[] of input columns and optionally a Filter. Subclasses may use other TableRecordReader implementations. Subclasses MUST ensure initializeTable(Connection, TableName) is called for an instance to function properly. Each of the entry points to this class used by the MapReduce framework, getRecordReader(InputSplit, JobConf, Reporter) and getSplits(JobConf, int), will call initialize(JobConf) as a convenient centralized location to handle retrieving the necessary configuration information. If your subclass overrides either of these methods, either call the parent version or call initialize yourself.

An example of a subclass:

   class ExampleTIF extends TableInputFormatBase {

      @Override
     protected void initialize(JobConf context) throws IOException {
       // We are responsible for the lifecycle of this connection until we hand it over in
       // initializeTable.
       Connection connection =
          ConnectionFactory.createConnection(HBaseConfiguration.create(job));
       TableName tableName = TableName.valueOf("exampleTable");
       // mandatory. once passed here, TableInputFormatBase will handle closing the connection.
       initializeTable(connection, tableName);
       byte[][] inputColumns = new byte [][] { Bytes.toBytes("columnA"),
         Bytes.toBytes("columnB") };
       // mandatory
       setInputColumns(inputColumns);
       // optional, by default we'll get everything for the given columns.
       Filter exampleFilter = new RowFilter(CompareOp.EQUAL, new RegexStringComparator("aa.*"));
       setRowFilter(exampleFilter);
     }
   }
 

Constructor Summary

Constructors

Constructor and Description
TableInputFormatBase()

Method Summary

Modifier and Type	Method and Description
protected void	closeTable() Close the Table and related objects that were initialized via initializeTable(Connection, TableName).
protected HTable	getHTable() Deprecated. use getTable()
<any>	getRecordReader(InputSplit split, JobConf job, Reporter reporter) Builds a TableRecordReader.
InputSplit[]	getSplits(JobConf job, int numSplits) Calculates the splits that will serve as input for the map tasks.
protected Table	getTable() Allows subclasses to get the Table.
protected void	initialize(JobConf job) Handle subclass specific set up.
protected void	initializeTable(Connection connection, TableName tableName) Allows subclasses to initialize the table information.
protected void	setHTable(HTable table) Deprecated. use initializeTable(Connection,TableName)
protected void	setInputColumns(byte[][] inputColumns)
protected void	setRowFilter(Filter rowFilter) Allows subclasses to set the Filter to be used.
protected void	setTableRecordReader(TableRecordReader tableRecordReader) Allows subclasses to set the TableRecordReader.

Methods inherited from class java.lang.Object

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

Constructor Detail

TableInputFormatBase

public TableInputFormatBase()

Method Detail

getRecordReader

public <any> getRecordReader(InputSplit split,
                             JobConf job,
                             Reporter reporter)
                      throws java.io.IOException

Builds a TableRecordReader. If no TableRecordReader was provided, uses the default.

Throws:

java.io.IOException

See Also:

org.apache.hadoop.mapred.InputFormat#getRecordReader(InputSplit, JobConf, Reporter)

getSplits

public InputSplit[] getSplits(JobConf job,
                              int numSplits)
                       throws java.io.IOException

Calculates the splits that will serve as input for the map tasks.

Splits are created in number equal to the smallest between numSplits and the number of HRegions in the table. If the number of splits is smaller than the number of HRegions then splits are spanned across multiple HRegions and are grouped the most evenly possible. In the case splits are uneven the bigger splits are placed first in the InputSplit array.

Parameters:

job - the map task JobConf

numSplits - a hint to calculate the number of splits (mapred.map.tasks).

Returns:

the input splits

Throws:

java.io.IOException

See Also:

org.apache.hadoop.mapred.InputFormat#getSplits(org.apache.hadoop.mapred.JobConf, int)

initializeTable

protected void initializeTable(Connection connection,
                               TableName tableName)
                        throws java.io.IOException

Allows subclasses to initialize the table information.

Parameters:

connection - The Connection to the HBase cluster. MUST be unmanaged. We will close.

tableName - The TableName of the table to process.

Throws:

java.io.IOException

setInputColumns

protected void setInputColumns(byte[][] inputColumns)

Parameters:

inputColumns - to be passed in Result to the map task.

getHTable

@Deprecated
protected HTable getHTable()

Deprecated. use getTable()

Allows subclasses to get the HTable.

getTable

protected Table getTable()

Allows subclasses to get the Table.

setHTable

@Deprecated
protected void setHTable(HTable table)

Deprecated. use initializeTable(Connection,TableName)

Allows subclasses to set the HTable.

Parameters:

table - to get the data from

setTableRecordReader

protected void setTableRecordReader(TableRecordReader tableRecordReader)

Allows subclasses to set the TableRecordReader.

Parameters:

tableRecordReader - to provide other TableRecordReader implementations.

setRowFilter

protected void setRowFilter(Filter rowFilter)

Allows subclasses to set the Filter to be used.

Parameters:

rowFilter -

initialize

protected void initialize(JobConf job)
                   throws java.io.IOException

Handle subclass specific set up. Each of the entry points used by the MapReduce framework, getRecordReader(InputSplit, JobConf, Reporter) and getSplits(JobConf, int), will call initialize(JobConf) as a convenient centralized location to handle retrieving the necessary configuration information and calling initializeTable(Connection, TableName). Subclasses should implement their initialize call such that it is safe to call multiple times. The current TableInputFormatBase implementation relies on a non-null table reference to decide if an initialize call is needed, but this behavior may change in the future. In particular, it is critical that initializeTable not be called multiple times since this will leak Connection instances.

Throws:

java.io.IOException

closeTable

protected void closeTable()
                   throws java.io.IOException

Close the Table and related objects that were initialized via initializeTable(Connection, TableName).

Throws:

java.io.IOException