HBaseTableSource (flink-connector-hbase 1.11.3 API)

java.lang.Object
- org.apache.flink.connector.hbase.source.HBaseTableSource

所有已实现的接口:: 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 Object
implements org.apache.flink.table.sources.BatchTableSource<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.LookupableTableSource<org.apache.flink.types.Row>

Creates a TableSource to scan an HBase table.

The table name and required HBase configuration is passed during HBaseTableSource construction. Use 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");

构造器概要

构造器
构造器和说明
`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, HBaseTableSchema hbaseSchema, int[] projectFields)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`void`	`addColumn(String family, String qualifier, Class<?> clazz)` Adds a column defined by family, qualifier, and type to the table schema.
`String`	`explainSource()`
`org.apache.flink.table.functions.AsyncTableFunction<org.apache.flink.types.Row>`	`getAsyncLookupFunction(String[] lookupKeys)`
`org.apache.flink.api.java.DataSet<org.apache.flink.types.Row>`	`getDataSet(org.apache.flink.api.java.ExecutionEnvironment execEnv)`
`org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.types.Row>`	`getDataStream(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment execEnv)`
`HBaseTableSchema`	`getHBaseTableSchema()`
`org.apache.flink.table.functions.TableFunction<org.apache.flink.types.Row>`	`getLookupFunction(String[] lookupKeys)`
`org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row>`	`getReturnType()`
`org.apache.flink.table.api.TableSchema`	`getTableSchema()`
`boolean`	`isAsyncEnabled()`
`boolean`	`isBounded()`
`HBaseTableSource`	`projectFields(int[] fields)`
`void`	`setCharset(String charset)` Specifies the charset to parse Strings to HBase byte[] keys and String values.
`void`	`setRowKey(String rowKeyName, Class<?> clazz)` Sets row key information in the table schema.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

从接口继承的方法 org.apache.flink.table.sources.TableSource
getProducedDataType

- 构造器详细资料
  - HBaseTableSource
```
public HBaseTableSource(org.apache.hadoop.conf.Configuration conf,
                        String tableName)
```
    The HBase configuration and the name of the table to read.
    
    参数:
    
    conf - hbase configuration
    
    tableName - the tableName
  - HBaseTableSource
```
public HBaseTableSource(org.apache.hadoop.conf.Configuration conf,
                        String tableName,
                        HBaseTableSchema hbaseSchema,
                        int[] projectFields)
```
- 方法详细资料
  - addColumn
```
public void addColumn(String family,
                      String qualifier,
                      Class<?> clazz)
```
    Adds a column defined by family, qualifier, and type to the table schema.
    
    参数:
    
    family - the family name
    
    qualifier - the qualifier name
    
    clazz - the data type of the qualifier
  - setRowKey
```
public void setRowKey(String rowKeyName,
                      Class<?> clazz)
```
    Sets row key information in the table schema.
    
    参数:
    
    rowKeyName - the row key field name
    
    clazz - the data type of the row key
  - setCharset
```
public void setCharset(String charset)
```
    Specifies the charset to parse Strings to HBase byte[] keys and String values.
    
    参数:
    
    charset - Name of the charset to use.
  - getReturnType
```
public org.apache.flink.api.common.typeinfo.TypeInformation<org.apache.flink.types.Row> getReturnType()
```
    指定者:
    
    getReturnType 在接口中 org.apache.flink.table.sources.TableSource<org.apache.flink.types.Row>
  - getTableSchema
```
public org.apache.flink.table.api.TableSchema getTableSchema()
```
    指定者:
    
    getTableSchema 在接口中 org.apache.flink.table.sources.TableSource<org.apache.flink.types.Row>
  - getDataSet
```
public org.apache.flink.api.java.DataSet<org.apache.flink.types.Row> getDataSet(org.apache.flink.api.java.ExecutionEnvironment execEnv)
```
    指定者:
    
    getDataSet 在接口中 org.apache.flink.table.sources.BatchTableSource<org.apache.flink.types.Row>
  - projectFields
```
public HBaseTableSource projectFields(int[] fields)
```
    指定者:
    
    projectFields 在接口中 org.apache.flink.table.sources.ProjectableTableSource<org.apache.flink.types.Row>
  - explainSource
```
public String explainSource()
```
    指定者:
    
    explainSource 在接口中 org.apache.flink.table.sources.TableSource<org.apache.flink.types.Row>
  - getLookupFunction
```
public org.apache.flink.table.functions.TableFunction<org.apache.flink.types.Row> getLookupFunction(String[] lookupKeys)
```
    指定者:
    
    getLookupFunction 在接口中 org.apache.flink.table.sources.LookupableTableSource<org.apache.flink.types.Row>
  - getAsyncLookupFunction
```
public org.apache.flink.table.functions.AsyncTableFunction<org.apache.flink.types.Row> getAsyncLookupFunction(String[] lookupKeys)
```
    指定者:
    
    getAsyncLookupFunction 在接口中 org.apache.flink.table.sources.LookupableTableSource<org.apache.flink.types.Row>
  - isAsyncEnabled
```
public boolean isAsyncEnabled()
```
    指定者:
    
    isAsyncEnabled 在接口中 org.apache.flink.table.sources.LookupableTableSource<org.apache.flink.types.Row>
  - isBounded
```
public boolean isBounded()
```
    指定者:
    
    isBounded 在接口中 org.apache.flink.table.sources.StreamTableSource<org.apache.flink.types.Row>
  - getDataStream
```
public org.apache.flink.streaming.api.datastream.DataStream<org.apache.flink.types.Row> getDataStream(org.apache.flink.streaming.api.environment.StreamExecutionEnvironment execEnv)
```
    指定者:
    
    getDataStream 在接口中 org.apache.flink.table.sources.StreamTableSource<org.apache.flink.types.Row>
  - getHBaseTableSchema
```
@VisibleForTesting
public HBaseTableSchema getHBaseTableSchema()
```

类 HBaseTableSource

构造器概要

方法概要

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

从接口继承的方法 org.apache.flink.table.sources.TableSource

构造器详细资料

HBaseTableSource

HBaseTableSource

方法详细资料

addColumn

setRowKey

setCharset

getReturnType

getTableSchema

getDataSet

projectFields

explainSource

getLookupFunction

getAsyncLookupFunction

isAsyncEnabled

isBounded

getDataStream

getHBaseTableSchema