org.apache.flink.connector.hbase.source

类 HBaseRowDataInputFormat

java.lang.Object

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

org.apache.flink.connector.hbase.source.HBaseRowDataInputFormat

所有已实现的接口:

Serializable, org.apache.flink.api.common.io.InputFormat<org.apache.flink.table.data.RowData,org.apache.flink.connector.hbase.source.TableInputSplit>, org.apache.flink.core.io.InputSplitSource<org.apache.flink.connector.hbase.source.TableInputSplit>

public class HBaseRowDataInputFormat
extends org.apache.flink.api.common.io.RichInputFormat<T,org.apache.flink.connector.hbase.source.TableInputSplit>

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

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
protected byte[]	currentRow
protected boolean	endReached
protected org.apache.hadoop.hbase.client.ResultScanner	resultScanner HBase iterator wrapper.
protected org.apache.hadoop.hbase.client.Scan	scan
protected long	scannedRows
protected byte[]	serializedConfig
protected org.apache.hadoop.hbase.client.HTable	table

构造器概要

构造器

构造器和说明
HBaseRowDataInputFormat(org.apache.hadoop.conf.Configuration conf, String tableName, HBaseTableSchema schema, String nullStringLiteral)

方法概要

限定符和类型	方法和说明
void	close()
void	closeInputFormat()
void	configure(org.apache.flink.configuration.Configuration parameters) Creates a Scan object and opens the HTable connection.
org.apache.flink.connector.hbase.source.TableInputSplit[]	createInputSplits(int minNumSplits)
protected org.apache.hadoop.conf.Configuration	getHadoopConfiguration()
org.apache.flink.core.io.InputSplitAssigner	getInputSplitAssigner(org.apache.flink.connector.hbase.source.TableInputSplit[] inputSplits)
protected org.apache.hadoop.hbase.client.Scan	getScanner() Returns an instance of Scan that retrieves the required subset of records from the HBase table.
org.apache.flink.api.common.io.statistics.BaseStatistics	getStatistics(org.apache.flink.api.common.io.statistics.BaseStatistics cachedStatistics)
String	getTableName() What table is to be read.
protected boolean	includeRegionInScan(byte[] startKey, byte[] endKey) Test if the given region is to be included in the scan while splitting the regions of a table.
protected org.apache.flink.table.data.RowData	mapResultToOutType(org.apache.hadoop.hbase.client.Result res) HBase returns an instance of Result.
T	nextRecord(T reuse)
void	open(org.apache.flink.connector.hbase.source.TableInputSplit split)
boolean	reachedEnd()

从类继承的方法 org.apache.flink.api.common.io.RichInputFormat

getRuntimeContext, openInputFormat, setRuntimeContext

从类继承的方法 java.lang.Object

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

字段详细资料

endReached

protected boolean endReached

table

protected transient org.apache.hadoop.hbase.client.HTable table

scan

protected transient org.apache.hadoop.hbase.client.Scan scan

resultScanner

protected org.apache.hadoop.hbase.client.ResultScanner resultScanner

HBase iterator wrapper.

currentRow

protected byte[] currentRow

scannedRows

protected long scannedRows

serializedConfig

protected byte[] serializedConfig

构造器详细资料

HBaseRowDataInputFormat

public HBaseRowDataInputFormat(org.apache.hadoop.conf.Configuration conf,
                               String tableName,
                               HBaseTableSchema schema,
                               String nullStringLiteral)

方法详细资料

configure

public void configure(org.apache.flink.configuration.Configuration parameters)

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 closeInputFormat().

指定者:

configure 在接口中 org.apache.flink.api.common.io.InputFormat<org.apache.flink.table.data.RowData,org.apache.flink.connector.hbase.source.TableInputSplit>

参数:

parameters - The configuration that is to be used

另请参阅:

Configuration

getScanner

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

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

返回:

The appropriate instance of Scan for this use case.

getTableName

public String getTableName()

What table is to be read.

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

返回:

The name of the table

mapResultToOutType

protected org.apache.flink.table.data.RowData mapResultToOutType(org.apache.hadoop.hbase.client.Result res)

HBase returns an instance of Result.

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

参数:

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

返回:

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

getHadoopConfiguration

protected org.apache.hadoop.conf.Configuration getHadoopConfiguration()

open

public void open(org.apache.flink.connector.hbase.source.TableInputSplit split)
          throws IOException

抛出:

IOException

nextRecord

public T nextRecord(T reuse)
             throws IOException

抛出:

IOException

reachedEnd

public boolean reachedEnd()
                   throws IOException

抛出:

IOException

close

public void close()
           throws IOException

抛出:

IOException

closeInputFormat

public void closeInputFormat()
                      throws IOException

覆盖:

closeInputFormat 在类中 org.apache.flink.api.common.io.RichInputFormat<T,org.apache.flink.connector.hbase.source.TableInputSplit>

抛出:

IOException

createInputSplits

public org.apache.flink.connector.hbase.source.TableInputSplit[] createInputSplits(int minNumSplits)
                                                                            throws IOException

抛出:

IOException

includeRegionInScan

protected boolean includeRegionInScan(byte[] startKey,
                                      byte[] endKey)

Test if the given region is to be included in the scan while splitting the regions of a table.

参数:

startKey - Start key of the region

endKey - End key of the region

返回:

true, if this region needs to be included as part of the input (default).

getInputSplitAssigner

public org.apache.flink.core.io.InputSplitAssigner getInputSplitAssigner(org.apache.flink.connector.hbase.source.TableInputSplit[] inputSplits)

getStatistics

public org.apache.flink.api.common.io.statistics.BaseStatistics getStatistics(org.apache.flink.api.common.io.statistics.BaseStatistics cachedStatistics)