org.apache.flink.connector.hbase2.source

Class HBaseTableSource

java.lang.Object

org.apache.flink.connector.hbase.source.AbstractHBaseTableSource

org.apache.flink.connector.hbase2.source.HBaseTableSource

All Implemented Interfaces:

org.apache.flink.table.sources.BatchTableSource<org.apache.flink.types.Row>, org.apache.flink.table.sources.LookupableTableSource<org.apache.flink.types.Row>, org.apache.flink.table.sources.ProjectableTableSource<org.apache.flink.types.Row>, org.apache.flink.table.sources.StreamTableSource<org.apache.flink.types.Row>, org.apache.flink.table.sources.TableSource<org.apache.flink.types.Row>

@Internal
public class HBaseTableSource
extends org.apache.flink.connector.hbase.source.AbstractHBaseTableSource

Creates a TableSource to scan an HBase table.

The table name and required HBase configuration is passed during HBaseTableSource construction. Use AbstractHBaseTableSource.addColumn(String, String, Class) to specify the family, qualifier, and type of columns to scan.

The TableSource returns Row with nested Rows for each column family.

The HBaseTableSource is used as shown in the example below.

 HBaseTableSource hSrc = new HBaseTableSource(conf, "hTable");
 hSrc.setRowKey("rowkey", String.class);
 hSrc.addColumn("fam1", "col1", byte[].class);
 hSrc.addColumn("fam1", "col2", Integer.class);
 hSrc.addColumn("fam2", "col1", String.class);

 tableEnv.registerTableSourceInternal("hTable", hSrc);
 Table res = tableEnv.sqlQuery(
   "SELECT t.fam2.col1, SUM(t.fam1.col2) FROM hTable AS t " +
   "WHERE t.rowkey LIKE 'flink%' GROUP BY t.fam2.col1");
 

Field Summary

Fields inherited from class org.apache.flink.connector.hbase.source.AbstractHBaseTableSource

conf, hbaseSchema, tableName

Constructor Summary

Constructors

Constructor and Description
HBaseTableSource(org.apache.hadoop.conf.Configuration conf, String tableName) The HBase configuration and the name of the table to read.
HBaseTableSource(org.apache.hadoop.conf.Configuration conf, String tableName, org.apache.flink.connector.hbase.util.HBaseTableSchema hbaseSchema, int[] projectFields)

Method Summary

Modifier and Type	Method and Description
org.apache.flink.api.common.io.InputFormat<org.apache.flink.types.Row,?>	getInputFormat(org.apache.flink.connector.hbase.util.HBaseTableSchema projectedSchema)
HBaseTableSource	projectFields(int[] fields)

Methods inherited from class org.apache.flink.connector.hbase.source.AbstractHBaseTableSource

addColumn, explainSource, getAsyncLookupFunction, getDataSet, getDataStream, getHBaseTableSchema, getLookupFunction, getReturnType, getTableSchema, isAsyncEnabled, isBounded, setCharset, setRowKey

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.sources.TableSource

getProducedDataType

Constructor Detail

HBaseTableSource

public HBaseTableSource(org.apache.hadoop.conf.Configuration conf,
                        String tableName)

The HBase configuration and the name of the table to read.

Parameters:

conf - hbase configuration

tableName - the tableName

HBaseTableSource

public HBaseTableSource(org.apache.hadoop.conf.Configuration conf,
                        String tableName,
                        org.apache.flink.connector.hbase.util.HBaseTableSchema hbaseSchema,
                        int[] projectFields)

Method Detail

projectFields

public HBaseTableSource projectFields(int[] fields)

getInputFormat

public org.apache.flink.api.common.io.InputFormat<org.apache.flink.types.Row,?> getInputFormat(org.apache.flink.connector.hbase.util.HBaseTableSchema projectedSchema)

Specified by:

getInputFormat in class org.apache.flink.connector.hbase.source.AbstractHBaseTableSource