org.apache.flink.addons.hbase

Class HBaseRowInputFormat

java.lang.Object

org.apache.flink.api.common.io.RichInputFormat<T,TableInputSplit>

org.apache.flink.addons.hbase.AbstractTableInputFormat<Row>

org.apache.flink.addons.hbase.HBaseRowInputFormat

All Implemented Interfaces:

Serializable, InputFormat<Row,TableInputSplit>, ResultTypeQueryable<Row>, InputSplitSource<TableInputSplit>

public class HBaseRowInputFormat
extends AbstractTableInputFormat<Row>
implements ResultTypeQueryable<Row>

InputFormat subclass that wraps the access for HTables. Returns the result as Row

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.addons.hbase.AbstractTableInputFormat

currentRow, endReached, resultScanner, scan, scannedRows, table

Constructor Summary

Constructors

Constructor and Description
HBaseRowInputFormat(Configuration conf, String tableName, HBaseTableSchema schema)

Method Summary

Modifier and Type	Method and Description
void	configure(Configuration parameters) Creates a Scan object and opens the HTable connection.
TypeInformation<Row>	getProducedType() Gets the data type (as a TypeInformation) produced by this function or input format.
protected org.apache.hadoop.hbase.client.Scan	getScanner() Returns an instance of Scan that retrieves the required subset of records from the HBase table.
String	getTableName() What table is to be read.
protected Row	mapResultToOutType(org.apache.hadoop.hbase.client.Result res) HBase returns an instance of Result.

Methods inherited from class org.apache.flink.addons.hbase.AbstractTableInputFormat

close, closeInputFormat, createInputSplits, getInputSplitAssigner, getStatistics, includeRegionInScan, nextRecord, open, reachedEnd

Methods inherited from class org.apache.flink.api.common.io.RichInputFormat

getRuntimeContext, openInputFormat, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseRowInputFormat

public HBaseRowInputFormat(Configuration conf,
                           String tableName,
                           HBaseTableSchema schema)

Method Detail

configure

public void configure(Configuration parameters)

Description copied from class: AbstractTableInputFormat

Creates a Scan object and opens the HTable connection.

These are opened here because they are needed in the createInputSplits which is called before the openInputFormat method.

The connection is opened in this method and closed in AbstractTableInputFormat.closeInputFormat().

Specified by:

configure in interface InputFormat<Row,TableInputSplit>

Specified by:

configure in class AbstractTableInputFormat<Row>

Parameters:

parameters - The configuration that is to be used

See Also:

Configuration

getScanner

protected org.apache.hadoop.hbase.client.Scan getScanner()

Description copied from class: AbstractTableInputFormat

Returns an instance of Scan that retrieves the required subset of records from the HBase table.

Specified by:

getScanner in class AbstractTableInputFormat<Row>

Returns:

The appropriate instance of Scan for this use case.

getTableName

public String getTableName()

Description copied from class: AbstractTableInputFormat

What table is to be read.

Per instance of a TableInputFormat derivative only a single table name is possible.

Specified by:

getTableName in class AbstractTableInputFormat<Row>

Returns:

The name of the table

mapResultToOutType

protected Row mapResultToOutType(org.apache.hadoop.hbase.client.Result res)

Description copied from class: AbstractTableInputFormat

HBase returns an instance of Result.

This method maps the returned Result instance into the output type T.

Specified by:

mapResultToOutType in class AbstractTableInputFormat<Row>

Parameters:

res - The Result instance from HBase that needs to be converted

Returns:

The appropriate instance of T that contains the data of Result.

getProducedType

public TypeInformation<Row> getProducedType()

Description copied from interface: ResultTypeQueryable

Gets the data type (as a TypeInformation) produced by this function or input format.

Specified by:

getProducedType in interface ResultTypeQueryable<Row>

Returns:

The data type produced by this function or input format.