org.apache.flink.streaming.connectors.elasticsearch

Class ElasticsearchUpsertTableSinkFactoryBase

java.lang.Object

org.apache.flink.streaming.connectors.elasticsearch.ElasticsearchUpsertTableSinkFactoryBase

All Implemented Interfaces:

StreamTableSinkFactory<Tuple2<Boolean,Row>>, TableFactory, TableSinkFactory<Tuple2<Boolean,Row>>

Direct Known Subclasses:

Elasticsearch6UpsertTableSinkFactory, Elasticsearch7UpsertTableSinkFactory

@Internal
public abstract class ElasticsearchUpsertTableSinkFactoryBase
extends Object
implements StreamTableSinkFactory<Tuple2<Boolean,Row>>

Version-agnostic table factory for creating an UpsertStreamTableSink for Elasticsearch.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.table.factories.TableSinkFactory

TableSinkFactory.Context

Constructor Summary

Constructors

Constructor and Description
ElasticsearchUpsertTableSinkFactoryBase()

Method Summary

Modifier and Type	Method and Description
protected abstract ElasticsearchUpsertTableSinkBase	createElasticsearchUpsertTableSink(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)
StreamTableSink<Tuple2<Boolean,Row>>	createStreamTableSink(Map<String,String> properties) Creates and configures a StreamTableSink using the given properties.
protected abstract String	elasticsearchVersion()
Map<String,String>	requiredContext() Specifies the context that this factory has been implemented for.
List<String>	supportedProperties() List of property keys that this factory can handle.

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.factories.StreamTableSinkFactory

createTableSink

Methods inherited from interface org.apache.flink.table.factories.TableSinkFactory

createTableSink, createTableSink

Constructor Detail

ElasticsearchUpsertTableSinkFactoryBase

public ElasticsearchUpsertTableSinkFactoryBase()

Method Detail

requiredContext

public Map<String,String> requiredContext()

Description copied from interface: TableFactory

Specifies the context that this factory has been implemented for. The framework guarantees to only match for this factory if the specified set of properties and values are met.

Typical properties might be: - connector.type - format.type

Specified property versions allow the framework to provide backwards compatible properties in case of string format changes: - connector.property-version - format.property-version

An empty context means that the factory matches for all requests.

Specified by:

requiredContext in interface TableFactory

supportedProperties

public List<String> supportedProperties()

Description copied from interface: TableFactory

List of property keys that this factory can handle. This method will be used for validation. If a property is passed that this factory cannot handle, an exception will be thrown. The list must not contain the keys that are specified by the context.

Example properties might be: - schema.#.type - schema.#.name - connector.topic - format.line-delimiter - format.ignore-parse-errors - format.fields.#.type - format.fields.#.name

Note: Use "#" to denote an array of values where "#" represents one or more digits. Property versions like "format.property-version" must not be part of the supported properties.

In some cases it might be useful to declare wildcards "*". Wildcards can only be declared at the end of a property key.

For example, if an arbitrary format should be supported: - format.*

Note: Wildcards should be used with caution as they might swallow unsupported properties and thus might lead to undesired behavior.

Specified by:

supportedProperties in interface TableFactory

createStreamTableSink

public StreamTableSink<Tuple2<Boolean,Row>> createStreamTableSink(Map<String,String> properties)

Description copied from interface: StreamTableSinkFactory

Creates and configures a StreamTableSink using the given properties.

Specified by:

createStreamTableSink in interface StreamTableSinkFactory<Tuple2<Boolean,Row>>

Parameters:

properties - normalized properties describing a table sink.

Returns:

the configured table sink.

elasticsearchVersion

protected abstract String elasticsearchVersion()

createElasticsearchUpsertTableSink

protected abstract ElasticsearchUpsertTableSinkBase createElasticsearchUpsertTableSink(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)