org.apache.flink.streaming.connectors.elasticsearch

Class ElasticsearchUpsertTableSinkBase

java.lang.Object

org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchUpsertTableSinkBase

All Implemented Interfaces:

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

Direct Known Subclasses:

Elasticsearch6UpsertTableSink, Elasticsearch7UpsertTableSink

@Internal
public abstract class ElasticsearchUpsertTableSinkBase
extends Object
implements UpsertStreamTableSink<Row>

A version-agnostic Elasticsearch UpsertStreamTableSink.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElasticsearchUpsertTableSinkBase.ElasticsearchUpsertSinkFunction Sink function for converting upserts into Elasticsearch ActionRequests.
static class	ElasticsearchUpsertTableSinkBase.Host Entity for describing a host of Elasticsearch.
static interface	ElasticsearchUpsertTableSinkBase.RequestFactory For version-agnostic creating of ActionRequests.
static class	ElasticsearchUpsertTableSinkBase.SinkOption Keys for optional parameterization of the sink.

Constructor Summary

Constructors

Constructor and Description

ElasticsearchUpsertTableSinkBase(boolean isAppendOnly, TableSchema schema, List<ElasticsearchUpsertTableSinkBase.Host> hosts, String index, String docType, String keyDelimiter, String keyNullLiteral, SerializationSchema<Row> serializationSchema, org.elasticsearch.common.xcontent.XContentType contentType, ActionRequestFailureHandler failureHandler, Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions, ElasticsearchUpsertTableSinkBase.RequestFactory requestFactory)

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.
protected abstract ElasticsearchUpsertTableSinkBase	copy(boolean isAppendOnly, TableSchema schema, List<ElasticsearchUpsertTableSinkBase.Host> hosts, String index, String docType, String keyDelimiter, String keyNullLiteral, SerializationSchema<Row> serializationSchema, org.elasticsearch.common.xcontent.XContentType contentType, ActionRequestFailureHandler failureHandler, Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions, ElasticsearchUpsertTableSinkBase.RequestFactory requestFactory)
protected abstract SinkFunction<Tuple2<Boolean,Row>>	createSinkFunction(List<ElasticsearchUpsertTableSinkBase.Host> hosts, ActionRequestFailureHandler failureHandler, Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions, ElasticsearchUpsertTableSinkBase.ElasticsearchUpsertSinkFunction upsertFunction)
boolean	equals(Object o)
String[]	getFieldNames()
TypeInformation<?>[]	getFieldTypes()
TypeInformation<Tuple2<Boolean,Row>>	getOutputType()
TypeInformation<Row>	getRecordType() Returns the requested record type.
int	hashCode()
void	setIsAppendOnly(Boolean isAppendOnly) Specifies whether the Table to write is append-only or not.
void	setKeyFields(String[] keyNames) Configures the unique key fields of the Table to write.

Methods inherited from class java.lang.Object

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

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

getConsumedDataType, getTableSchema

Constructor Detail

ElasticsearchUpsertTableSinkBase

public ElasticsearchUpsertTableSinkBase(boolean isAppendOnly,
                                        TableSchema schema,
                                        List<ElasticsearchUpsertTableSinkBase.Host> hosts,
                                        String index,
                                        String docType,
                                        String keyDelimiter,
                                        String keyNullLiteral,
                                        SerializationSchema<Row> serializationSchema,
                                        org.elasticsearch.common.xcontent.XContentType contentType,
                                        ActionRequestFailureHandler failureHandler,
                                        Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions,
                                        ElasticsearchUpsertTableSinkBase.RequestFactory requestFactory)

Method Detail

setKeyFields

public void setKeyFields(String[] keyNames)

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:

keyNames - 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>

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>>

getOutputType

public TypeInformation<Tuple2<Boolean,Row>> getOutputType()

Specified by:

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

Specified by:

getOutputType in interface UpsertStreamTableSink<Row>

getFieldNames

public String[] getFieldNames()

Specified by:

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

getFieldTypes

public TypeInformation<?>[] getFieldTypes()

Specified by:

getFieldTypes in interface TableSink<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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

copy

protected abstract ElasticsearchUpsertTableSinkBase copy(boolean isAppendOnly,
                                                         TableSchema schema,
                                                         List<ElasticsearchUpsertTableSinkBase.Host> hosts,
                                                         String index,
                                                         String docType,
                                                         String keyDelimiter,
                                                         String keyNullLiteral,
                                                         SerializationSchema<Row> serializationSchema,
                                                         org.elasticsearch.common.xcontent.XContentType contentType,
                                                         ActionRequestFailureHandler failureHandler,
                                                         Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions,
                                                         ElasticsearchUpsertTableSinkBase.RequestFactory requestFactory)

createSinkFunction

protected abstract SinkFunction<Tuple2<Boolean,Row>> createSinkFunction(List<ElasticsearchUpsertTableSinkBase.Host> hosts,
                                                                        ActionRequestFailureHandler failureHandler,
                                                                        Map<ElasticsearchUpsertTableSinkBase.SinkOption,String> sinkOptions,
                                                                        ElasticsearchUpsertTableSinkBase.ElasticsearchUpsertSinkFunction upsertFunction)