org.apache.flink.connector.hbase.source

Class HBaseRowDataLookupFunction

java.lang.Object

org.apache.flink.table.functions.UserDefinedFunction

org.apache.flink.table.functions.TableFunction<RowData>

org.apache.flink.connector.hbase.source.HBaseRowDataLookupFunction

All Implemented Interfaces:

Serializable, FunctionDefinition

@Internal
public class HBaseRowDataLookupFunction
extends TableFunction<RowData>

The HBaseRowDataLookupFunction is a standard user-defined table function, it can be used in tableAPI and also useful for temporal table join plan in SQL. It looks up the result as RowData.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
HBaseRowDataLookupFunction(Configuration configuration, String hTableName, HBaseTableSchema hbaseTableSchema, String nullStringLiteral)

Method Summary

Modifier and Type	Method and Description
void	close() Tear-down method for user-defined function.
void	eval(Object rowKey) The invoke entry point of lookup function.
String	getHTableName()
void	open(FunctionContext context) Setup method for user-defined function.

Methods inherited from class org.apache.flink.table.functions.TableFunction

collect, getKind, getParameterTypes, getResultType, getTypeInference, setCollector

Methods inherited from class org.apache.flink.table.functions.UserDefinedFunction

functionIdentifier, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.flink.table.functions.FunctionDefinition

getRequirements, isDeterministic

Constructor Detail

HBaseRowDataLookupFunction

public HBaseRowDataLookupFunction(Configuration configuration,
                                  String hTableName,
                                  HBaseTableSchema hbaseTableSchema,
                                  String nullStringLiteral)

Method Detail

eval

public void eval(Object rowKey)
          throws IOException

The invoke entry point of lookup function.

Parameters:

rowKey - the lookup key. Currently only support single rowkey.

Throws:

IOException

open

public void open(FunctionContext context)

Description copied from class: UserDefinedFunction

Setup method for user-defined function. It can be used for initialization work. By default, this method does nothing.

Overrides:

open in class UserDefinedFunction

close

public void close()

Description copied from class: UserDefinedFunction

Tear-down method for user-defined function. It can be used for clean up work. By default, this method does nothing.

Overrides:

close in class UserDefinedFunction

getHTableName

@VisibleForTesting
public String getHTableName()