org.apache.flink.connector.hbase.source

Class AbstractHBaseDynamicTableSource

java.lang.Object

org.apache.flink.connector.hbase.source.AbstractHBaseDynamicTableSource

All Implemented Interfaces:

SupportsProjectionPushDown, DynamicTableSource, LookupTableSource, ScanTableSource

Direct Known Subclasses:

HBaseDynamicTableSource, HBaseDynamicTableSource

@Internal
public abstract class AbstractHBaseDynamicTableSource
extends Object
implements ScanTableSource, LookupTableSource, SupportsProjectionPushDown

HBase table source implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.ScanTableSource

ScanTableSource.ScanContext, ScanTableSource.ScanRuntimeProvider

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.LookupTableSource

LookupTableSource.LookupContext, LookupTableSource.LookupRuntimeProvider

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.source.DynamicTableSource

DynamicTableSource.Context, DynamicTableSource.DataStructureConverter

Field Summary

Fields

Modifier and Type	Field and Description
protected LookupCache	cache
protected org.apache.hadoop.conf.Configuration	conf
protected HBaseTableSchema	hbaseSchema
protected int	maxRetryTimes
protected String	nullStringLiteral
protected String	tableName

Constructor Summary

Constructors

Constructor and Description
AbstractHBaseDynamicTableSource(org.apache.hadoop.conf.Configuration conf, String tableName, HBaseTableSchema hbaseSchema, String nullStringLiteral, int maxRetryTimes, LookupCache cache)

Method Summary

Modifier and Type	Method and Description
void	applyProjection(int[][] projectedFields, DataType producedDataType) Provides the field index paths that should be used for a projection.
String	asSummaryString() Returns a string that summarizes this source for printing to a console or log.
LookupCache	getCache()
ChangelogMode	getChangelogMode() Returns the set of changes that the planner can expect during runtime.
HBaseTableSchema	getHBaseTableSchema()
protected abstract InputFormat<RowData,?>	getInputFormat()
LookupTableSource.LookupRuntimeProvider	getLookupRuntimeProvider(LookupTableSource.LookupContext context) Returns a provider of runtime implementation for reading the data.
int	getMaxRetryTimes()
ScanTableSource.ScanRuntimeProvider	getScanRuntimeProvider(ScanTableSource.ScanContext runtimeProviderContext) Returns a provider of runtime implementation for reading the data.
boolean	supportsNestedProjection() Returns whether this source supports nested projection.

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.connector.source.DynamicTableSource

copy

Methods inherited from interface org.apache.flink.table.connector.source.abilities.SupportsProjectionPushDown

applyProjection

Field Detail

conf

protected final org.apache.hadoop.conf.Configuration conf

tableName

protected final String tableName

hbaseSchema

protected HBaseTableSchema hbaseSchema

nullStringLiteral

protected final String nullStringLiteral

maxRetryTimes

protected final int maxRetryTimes

cache

@Nullable
protected final LookupCache cache

Constructor Detail

AbstractHBaseDynamicTableSource

public AbstractHBaseDynamicTableSource(org.apache.hadoop.conf.Configuration conf,
                                       String tableName,
                                       HBaseTableSchema hbaseSchema,
                                       String nullStringLiteral,
                                       int maxRetryTimes,
                                       @Nullable
                                       LookupCache cache)

Method Detail

getScanRuntimeProvider

public ScanTableSource.ScanRuntimeProvider getScanRuntimeProvider(ScanTableSource.ScanContext runtimeProviderContext)

Description copied from interface: ScanTableSource

Returns a provider of runtime implementation for reading the data.

There might exist different interfaces for runtime implementation which is why ScanTableSource.ScanRuntimeProvider serves as the base interface. Concrete ScanTableSource.ScanRuntimeProvider interfaces might be located in other Flink modules.

Independent of the provider interface, the table runtime expects that a source implementation emits internal data structures (see RowData for more information).

The given ScanTableSource.ScanContext offers utilities by the planner for creating runtime implementation with minimal dependencies to internal data structures.

SourceProvider is the recommended core interface. SourceFunctionProvider in flink-table-api-java-bridge and InputFormatProvider are available for backwards compatibility.

Specified by:

getScanRuntimeProvider in interface ScanTableSource

See Also:

SourceProvider

getInputFormat

protected abstract InputFormat<RowData,?> getInputFormat()

getLookupRuntimeProvider

public LookupTableSource.LookupRuntimeProvider getLookupRuntimeProvider(LookupTableSource.LookupContext context)

Description copied from interface: LookupTableSource

Returns a provider of runtime implementation for reading the data.

There exist different interfaces for runtime implementation which is why LookupTableSource.LookupRuntimeProvider serves as the base interface.

Independent of the provider interface, a source implementation can work on either arbitrary objects or internal data structures (see org.apache.flink.table.data for more information).

The given LookupTableSource.LookupContext offers utilities by the planner for creating runtime implementation with minimal dependencies to internal data structures.

Specified by:

getLookupRuntimeProvider in interface LookupTableSource

See Also:

LookupFunctionProvider, AsyncLookupFunctionProvider

supportsNestedProjection

public boolean supportsNestedProjection()

Description copied from interface: SupportsProjectionPushDown

Returns whether this source supports nested projection.

Specified by:

supportsNestedProjection in interface SupportsProjectionPushDown

applyProjection

public void applyProjection(int[][] projectedFields,
                            DataType producedDataType)

Description copied from interface: SupportsProjectionPushDown

Provides the field index paths that should be used for a projection. The indices are 0-based and support fields within (possibly nested) structures if this is enabled via SupportsProjectionPushDown.supportsNestedProjection().

In the example mentioned in SupportsProjectionPushDown, this method would receive:

• [[2], [1]] which is equivalent to [["s"], ["r"]] if SupportsProjectionPushDown.supportsNestedProjection() returns false.
• [[2], [1, 0]] which is equivalent to [["s"], ["r", "d"]]] if SupportsProjectionPushDown.supportsNestedProjection() returns true.

Note: Use the passed data type instead of ResolvedSchema.toPhysicalRowDataType() for describing the final output data type when creating TypeInformation.

Specified by:

applyProjection in interface SupportsProjectionPushDown

Parameters:

projectedFields - field index paths of all fields that must be present in the physically produced data

producedDataType - the final output type of the source, with the projection applied

getChangelogMode

public ChangelogMode getChangelogMode()

Description copied from interface: ScanTableSource

Returns the set of changes that the planner can expect during runtime.

Specified by:

getChangelogMode in interface ScanTableSource

See Also:

RowKind

asSummaryString

public String asSummaryString()

Description copied from interface: DynamicTableSource

Returns a string that summarizes this source for printing to a console or log.

Specified by:

asSummaryString in interface DynamicTableSource

getHBaseTableSchema

@VisibleForTesting
public HBaseTableSchema getHBaseTableSchema()

getMaxRetryTimes

@VisibleForTesting
public int getMaxRetryTimes()

getCache

@VisibleForTesting
 @Nullable
public LookupCache getCache()