org.apache.flink.connector.hbase2.sink

Class HBaseDynamicTableSink

java.lang.Object

org.apache.flink.connector.hbase2.sink.HBaseDynamicTableSink

All Implemented Interfaces:

DynamicTableSink

@Internal
public class HBaseDynamicTableSink
extends Object
implements DynamicTableSink

HBase table sink implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.connector.sink.DynamicTableSink

DynamicTableSink.Context, DynamicTableSink.DataStructureConverter, DynamicTableSink.SinkRuntimeProvider

Constructor Summary

Constructors

Constructor and Description
HBaseDynamicTableSink(String tableName, HBaseTableSchema hbaseTableSchema, Configuration hbaseConf, HBaseWriteOptions writeOptions, String nullStringLiteral)

Method Summary

Modifier and Type	Method and Description
String	asSummaryString() Returns a string that summarizes this sink for printing to a console or log.
DynamicTableSink	copy() Creates a copy of this instance during planning.
ChangelogMode	getChangelogMode(ChangelogMode requestedMode) Returns the set of changes that the sink accepts during runtime.
Configuration	getConfiguration()
HBaseTableSchema	getHBaseTableSchema()
DynamicTableSink.SinkRuntimeProvider	getSinkRuntimeProvider(DynamicTableSink.Context context) Returns a provider of runtime implementation for writing the data.
String	getTableName()
HBaseWriteOptions	getWriteOptions()

Methods inherited from class java.lang.Object

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

Constructor Detail

HBaseDynamicTableSink

public HBaseDynamicTableSink(String tableName,
                             HBaseTableSchema hbaseTableSchema,
                             Configuration hbaseConf,
                             HBaseWriteOptions writeOptions,
                             String nullStringLiteral)

Method Detail

getSinkRuntimeProvider

public DynamicTableSink.SinkRuntimeProvider getSinkRuntimeProvider(DynamicTableSink.Context context)

Description copied from interface: DynamicTableSink

Returns a provider of runtime implementation for writing the data.

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

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

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

See org.apache.flink.table.connector.sink.SinkFunctionProvider in flink-table-api-java-bridge.

Specified by:

getSinkRuntimeProvider in interface DynamicTableSink

See Also:

ParallelismProvider

getChangelogMode

public ChangelogMode getChangelogMode(ChangelogMode requestedMode)

Description copied from interface: DynamicTableSink

Returns the set of changes that the sink accepts during runtime.

The planner can make suggestions but the sink has the final decision what it requires. If the planner does not support this mode, it will throw an error. For example, the sink can return that it only supports ChangelogMode.insertOnly().

Specified by:

getChangelogMode in interface DynamicTableSink

Parameters:

requestedMode - expected set of changes by the current plan

copy

public DynamicTableSink copy()

Description copied from interface: DynamicTableSink

Creates a copy of this instance during planning. The copy should be a deep copy of all mutable members.

Specified by:

copy in interface DynamicTableSink

asSummaryString

public String asSummaryString()

Description copied from interface: DynamicTableSink

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

Specified by:

asSummaryString in interface DynamicTableSink

getHBaseTableSchema

@VisibleForTesting
public HBaseTableSchema getHBaseTableSchema()

getWriteOptions

@VisibleForTesting
public HBaseWriteOptions getWriteOptions()

getConfiguration

@VisibleForTesting
public Configuration getConfiguration()

getTableName

@VisibleForTesting
public String getTableName()