org.apache.flink.connector.hbase.sink

Class HBaseUpsertTableSink

java.lang.Object

org.apache.flink.connector.hbase.sink.HBaseUpsertTableSink

All Implemented Interfaces:

StreamTableSink<Tuple2<Boolean,Row>>, TableSink<Tuple2<Boolean,Row>>, UpsertStreamTableSink<Row>

@Internal
public class HBaseUpsertTableSink
extends Object
implements UpsertStreamTableSink<Row>

An upsert UpsertStreamTableSink for HBase.

Constructor Summary

Constructors

Constructor and Description
HBaseUpsertTableSink(HBaseTableSchema hbaseTableSchema, HBaseOptions hbaseOptions, HBaseWriteOptions writeOptions)

Method Summary

Modifier and Type	Method and Description
TableSink<Tuple2<Boolean,Row>>	configure(String[] fieldNames, TypeInformation<?>[] fieldTypes) Returns a copy of this TableSink configured with the field names and types of the table to emit.
DataStreamSink<?>	consumeDataStream(DataStream<Tuple2<Boolean,Row>> dataStream) Consumes the DataStream and return the sink transformation DataStreamSink.
HBaseOptions	getHBaseOptions()
HBaseTableSchema	getHBaseTableSchema()
TypeInformation<Row>	getRecordType() Returns the requested record type.
TableSchema	getTableSchema() Returns the schema of the consumed table.
HBaseWriteOptions	getWriteOptions()
void	setIsAppendOnly(Boolean isAppendOnly) Specifies whether the Table to write is append-only or not.
void	setKeyFields(String[] keys) Configures the unique key fields of the Table to write.

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.sinks.UpsertStreamTableSink

getOutputType

Methods inherited from interface org.apache.flink.table.sinks.TableSink

getConsumedDataType, getFieldNames, getFieldTypes

Constructor Detail

HBaseUpsertTableSink

public HBaseUpsertTableSink(HBaseTableSchema hbaseTableSchema,
                            HBaseOptions hbaseOptions,
                            HBaseWriteOptions writeOptions)

Method Detail

setKeyFields

public void setKeyFields(String[] keys)

Description copied from interface: UpsertStreamTableSink

Configures the unique key fields of the Table to write. The method is called after TableSink.configure(String[], TypeInformation[]).

The keys array might be empty, if the table consists of a single (updated) record. If the table does not have a key and is append-only, the keys attribute is null.

Specified by:

setKeyFields in interface UpsertStreamTableSink<Row>

Parameters:

keys - the field names of the table's keys, an empty array if the table has a single row, and null if the table is append-only and has no key.

setIsAppendOnly

public void setIsAppendOnly(Boolean isAppendOnly)

Description copied from interface: UpsertStreamTableSink

Specifies whether the Table to write is append-only or not.

Specified by:

setIsAppendOnly in interface UpsertStreamTableSink<Row>

Parameters:

isAppendOnly - true if the table is append-only, false otherwise.

getRecordType

public TypeInformation<Row> getRecordType()

Description copied from interface: UpsertStreamTableSink

Returns the requested record type.

Specified by:

getRecordType in interface UpsertStreamTableSink<Row>

getTableSchema

public TableSchema getTableSchema()

Description copied from interface: TableSink

Returns the schema of the consumed table.

Specified by:

getTableSchema in interface TableSink<Tuple2<Boolean,Row>>

Returns:

The TableSchema of the consumed table.

consumeDataStream

public DataStreamSink<?> consumeDataStream(DataStream<Tuple2<Boolean,Row>> dataStream)

Description copied from interface: StreamTableSink

Consumes the DataStream and return the sink transformation DataStreamSink. The returned DataStreamSink will be used to set resources for the sink operator.

Specified by:

consumeDataStream in interface StreamTableSink<Tuple2<Boolean,Row>>

configure

public TableSink<Tuple2<Boolean,Row>> configure(String[] fieldNames,
                                                TypeInformation<?>[] fieldTypes)

Description copied from interface: TableSink

Returns a copy of this TableSink configured with the field names and types of the table to emit.

Specified by:

configure in interface TableSink<Tuple2<Boolean,Row>>

Parameters:

fieldNames - The field names of the table to emit.

fieldTypes - The field types of the table to emit.

Returns:

A copy of this TableSink configured with the field names and types of the table to emit.

getHBaseTableSchema

@VisibleForTesting
public HBaseTableSchema getHBaseTableSchema()

getHBaseOptions

@VisibleForTesting
public HBaseOptions getHBaseOptions()

getWriteOptions

@VisibleForTesting
public HBaseWriteOptions getWriteOptions()