eu.stratosphere.addons.hbase

Class TableInputFormat

java.lang.Object

eu.stratosphere.addons.hbase.TableInputFormat

All Implemented Interfaces:

InputFormat<Record,TableInputSplit>, Serializable

Direct Known Subclasses:

HBaseReadExample.MyTableInputFormat

public class TableInputFormat
extends Object
implements InputFormat<Record,TableInputSplit>

InputFormat subclass that wraps the access for HTables.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONFIG_LOCATION Location of the hbase-site.xml.
protected HBaseKey	hbaseKey mutable objects that are used to avoid recreation of wrapper objects
protected HBaseResult	hbaseResult
static String	INPUT_TABLE Job parameter that specifies the input table.
static String	SCAN Base-64 encoded scanner.
static String	SCAN_CACHEBLOCKS Set to false to disable server-side caching of blocks for this scan.
static String	SCAN_CACHEDROWS The number of rows for caching that will be passed to scanners.
static String	SCAN_COLUMN_FAMILY Column Family to Scan
static String	SCAN_COLUMNS Space delimited list of columns to scan.
static String	SCAN_MAXVERSIONS The maximum number of version to return.
static String	SCAN_TIMERANGE_END The ending timestamp used to filter columns with a specific range of versions.
static String	SCAN_TIMERANGE_START The starting timestamp used to filter columns with a specific range of versions.
static String	SCAN_TIMESTAMP The timestamp used to filter columns with a specific timestamp.

Constructor Summary

Constructors

Constructor and Description
TableInputFormat()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	configure(Configuration parameters)
TableInputSplit[]	createInputSplits(int minNumSplits)
protected org.apache.hadoop.hbase.client.Scan	createScanner(Configuration parameters) Read the configuration and creates a Scan object.
protected org.apache.hadoop.hbase.client.HTable	createTable(Configuration parameters) Create an HTable instance and set it into this format.
Class<TableInputSplit>	getInputSplitType()
org.apache.hadoop.hbase.client.Scan	getScan()
BaseStatistics	getStatistics(BaseStatistics cachedStatistics)
org.apache.hadoop.hbase.client.HTable	getTable()
void	mapResultToRecord(Record record, HBaseKey key, HBaseResult result) Maps the current HBase Result into a Record.
Record	nextRecord(Record record)
protected boolean	nextResult()
void	open(TableInputSplit split)
boolean	reachedEnd()
void	setScan(org.apache.hadoop.hbase.client.Scan scan)
void	setTable(org.apache.hadoop.hbase.client.HTable table)

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_TABLE

public static final String INPUT_TABLE

Job parameter that specifies the input table.

See Also:

Constant Field Values

CONFIG_LOCATION

public static final String CONFIG_LOCATION

Location of the hbase-site.xml. If set, the HBaseAdmin will build inside

See Also:

Constant Field Values

SCAN

public static final String SCAN

Base-64 encoded scanner. All other SCAN_ confs are ignored if this is specified. See TableMapReduceUtil#convertScanToString(Scan) for more details.

See Also:

Constant Field Values

SCAN_COLUMN_FAMILY

public static final String SCAN_COLUMN_FAMILY

Column Family to Scan

See Also:

Constant Field Values

SCAN_COLUMNS

public static final String SCAN_COLUMNS

Space delimited list of columns to scan.

See Also:

Constant Field Values

SCAN_TIMESTAMP

public static final String SCAN_TIMESTAMP

The timestamp used to filter columns with a specific timestamp.

See Also:

Constant Field Values

SCAN_TIMERANGE_START

public static final String SCAN_TIMERANGE_START

The starting timestamp used to filter columns with a specific range of versions.

See Also:

Constant Field Values

SCAN_TIMERANGE_END

public static final String SCAN_TIMERANGE_END

The ending timestamp used to filter columns with a specific range of versions.

See Also:

Constant Field Values

SCAN_MAXVERSIONS

public static final String SCAN_MAXVERSIONS

The maximum number of version to return.

See Also:

Constant Field Values

SCAN_CACHEBLOCKS

public static final String SCAN_CACHEBLOCKS

Set to false to disable server-side caching of blocks for this scan.

See Also:

Constant Field Values

SCAN_CACHEDROWS

public static final String SCAN_CACHEDROWS

The number of rows for caching that will be passed to scanners.

See Also:

Constant Field Values

hbaseKey

protected HBaseKey hbaseKey

mutable objects that are used to avoid recreation of wrapper objects

hbaseResult

protected HBaseResult hbaseResult

Constructor Detail

TableInputFormat

public TableInputFormat()

Method Detail

configure

public void configure(Configuration parameters)

Specified by:

configure in interface InputFormat<Record,TableInputSplit>

createScanner

protected org.apache.hadoop.hbase.client.Scan createScanner(Configuration parameters)

Read the configuration and creates a Scan object.

Parameters:

parameters -

Returns:

createTable

protected org.apache.hadoop.hbase.client.HTable createTable(Configuration parameters)

Create an HTable instance and set it into this format.

Parameters:

parameters - a Configuration that holds at least the table name.

getStatistics

public BaseStatistics getStatistics(BaseStatistics cachedStatistics)

Specified by:

getStatistics in interface InputFormat<Record,TableInputSplit>

reachedEnd

public boolean reachedEnd()
                   throws IOException

Specified by:

reachedEnd in interface InputFormat<Record,TableInputSplit>

Throws:

IOException

nextResult

protected boolean nextResult()
                      throws IOException

Throws:

IOException

nextRecord

public Record nextRecord(Record record)
                  throws IOException

Specified by:

nextRecord in interface InputFormat<Record,TableInputSplit>

Throws:

IOException

mapResultToRecord

public void mapResultToRecord(Record record,
                     HBaseKey key,
                     HBaseResult result)

Maps the current HBase Result into a Record. This implementation simply stores the HBaseKey at position 0, and the HBase Result object at position 1.

Parameters:

record -

key -

result -

close

public void close()
           throws IOException

Specified by:

close in interface InputFormat<Record,TableInputSplit>

Throws:

IOException

open

public void open(TableInputSplit split)
          throws IOException

Specified by:

open in interface InputFormat<Record,TableInputSplit>

Throws:

IOException

createInputSplits

public TableInputSplit[] createInputSplits(int minNumSplits)
                                    throws IOException

Specified by:

createInputSplits in interface InputFormat<Record,TableInputSplit>

Throws:

IOException

getInputSplitType

public Class<TableInputSplit> getInputSplitType()

Specified by:

getInputSplitType in interface InputFormat<Record,TableInputSplit>

setTable

public void setTable(org.apache.hadoop.hbase.client.HTable table)

getTable

public org.apache.hadoop.hbase.client.HTable getTable()

setScan

public void setScan(org.apache.hadoop.hbase.client.Scan scan)

getScan

public org.apache.hadoop.hbase.client.Scan getScan()