org.apache.flink.connector.hbase2.source

Class HBaseInputFormat<T extends Tuple>

java.lang.Object

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

org.apache.flink.connector.hbase2.source.AbstractTableInputFormat<T>

org.apache.flink.connector.hbase2.source.HBaseInputFormat<T>

All Implemented Interfaces:

Serializable, InputFormat<T,TableInputSplit>, InputSplitSource<TableInputSplit>

@Experimental
public abstract class HBaseInputFormat<T extends Tuple>
extends AbstractTableInputFormat<T>

InputFormat subclass that wraps the access for HTables.

See Also:

Serialized Form

Field Summary

Fields inherited from class org.apache.flink.connector.hbase2.source.AbstractTableInputFormat

connection, currentRow, endReached, LOG, regionLocator, resultScanner, scan, scannedRows, serializedConfig, table

Constructor Summary

Constructors

Constructor and Description
HBaseInputFormat(Configuration hConf) Constructs a InputFormat with hbase configuration to read data from hbase.

Method Summary

Modifier and Type	Method and Description
protected abstract org.apache.hadoop.hbase.client.Scan	getScanner() Returns an instance of Scan that retrieves the required subset of records from the HBase table.
protected abstract String	getTableName() What table is to be read.
protected void	initTable() Creates a Scan object and opens the HTable connection to initialize the HBase table.
protected T	mapResultToOutType(org.apache.hadoop.hbase.client.Result r) HBase returns an instance of Result.
protected abstract T	mapResultToTuple(org.apache.hadoop.hbase.client.Result r) The output from HBase is always an instance of Result.

Methods inherited from class org.apache.flink.connector.hbase2.source.AbstractTableInputFormat

close, closeTable, configure, createInputSplits, getConnection, getHadoopConfiguration, getInputSplitAssigner, getStatistics, includeRegionInScan, nextRecord, open, reachedEnd

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

closeInputFormat, getRuntimeContext, openInputFormat, setRuntimeContext

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseInputFormat

public HBaseInputFormat(Configuration hConf)

Constructs a InputFormat with hbase configuration to read data from hbase.

Parameters:

hConf - The configuration that connect to hbase. At least hbase.zookeeper.quorum and zookeeper.znode.parent need to be set.

Method Detail

getScanner

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

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

Specified by:

getScanner in class AbstractTableInputFormat<T extends Tuple>

Returns:

The appropriate instance of Scan for this usecase.

getTableName

protected abstract String getTableName()

What table is to be read. Per instance of a TableInputFormat derivative only a single tablename is possible.

Specified by:

getTableName in class AbstractTableInputFormat<T extends Tuple>

Returns:

The name of the table

mapResultToTuple

protected abstract T mapResultToTuple(org.apache.hadoop.hbase.client.Result r)

The output from HBase is always an instance of Result. This method is to copy the data in the Result instance into the required Tuple

Parameters:

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

Returns:

The appropriate instance of Tuple that contains the needed information.

initTable

protected void initTable()

Description copied from class: AbstractTableInputFormat

Creates a Scan object and opens the HTable connection to initialize the HBase table.

Specified by:

initTable in class AbstractTableInputFormat<T extends Tuple>

mapResultToOutType

protected T mapResultToOutType(org.apache.hadoop.hbase.client.Result r)

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<T extends Tuple>

Parameters:

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

Returns:

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