org.apache.flink.table.sources

Interface LookupableTableSource<T>

Type Parameters:

T - type of the result

All Superinterfaces:

TableSource<T>

All Known Implementing Classes:

CsvTableSource, HBaseTableSource, HiveTableSource, JdbcTableSource

@Experimental
public interface LookupableTableSource<T>
extends TableSource<T>

A TableSource which supports for lookup accessing via key column(s). For example, MySQL TableSource can implement this interface to support lookup accessing. When temporal join this MySQL table, the runtime behavior could be in a lookup fashion.

Method Summary

Modifier and Type	Method and Description
AsyncTableFunction<T>	getAsyncLookupFunction(String[] lookupKeys) Gets the AsyncTableFunction which supports async lookup one key at a time.
TableFunction<T>	getLookupFunction(String[] lookupKeys) Gets the TableFunction which supports lookup one key at a time.
boolean	isAsyncEnabled() Returns true if async lookup is enabled.

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

explainSource, getProducedDataType, getReturnType, getTableSchema

Method Detail

getLookupFunction

TableFunction<T> getLookupFunction(String[] lookupKeys)

Gets the TableFunction which supports lookup one key at a time.

Parameters:

lookupKeys - the chosen field names as lookup keys, it is in the defined order

getAsyncLookupFunction

AsyncTableFunction<T> getAsyncLookupFunction(String[] lookupKeys)

Gets the AsyncTableFunction which supports async lookup one key at a time.

Parameters:

lookupKeys - the chosen field names as lookup keys, it is in the defined order

isAsyncEnabled

boolean isAsyncEnabled()

Returns true if async lookup is enabled.

The lookup function returned by getAsyncLookupFunction(String[]) will be used if returns true. Otherwise, the lookup function returned by getLookupFunction(String[]) will be used.