forked from apache/flink
-
Notifications
You must be signed in to change notification settings - Fork 1
/
ElasticsearchUpsertTableSinkBase.java
532 lines (473 loc) · 16.1 KB
/
ElasticsearchUpsertTableSinkBase.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.flink.streaming.connectors.elasticsearch;
import org.apache.flink.annotation.Internal;
import org.apache.flink.api.common.functions.RuntimeContext;
import org.apache.flink.api.common.serialization.SerializationSchema;
import org.apache.flink.api.common.typeinfo.TypeInformation;
import org.apache.flink.api.common.typeinfo.Types;
import org.apache.flink.api.java.tuple.Tuple2;
import org.apache.flink.streaming.api.datastream.DataStream;
import org.apache.flink.streaming.api.datastream.DataStreamSink;
import org.apache.flink.streaming.api.functions.sink.SinkFunction;
import org.apache.flink.table.api.TableSchema;
import org.apache.flink.table.api.ValidationException;
import org.apache.flink.table.sinks.TableSink;
import org.apache.flink.table.sinks.UpsertStreamTableSink;
import org.apache.flink.table.typeutils.TypeCheckUtils;
import org.apache.flink.table.utils.TableConnectorUtils;
import org.apache.flink.types.Row;
import org.apache.flink.util.Preconditions;
import org.elasticsearch.action.ActionRequest;
import org.elasticsearch.action.delete.DeleteRequest;
import org.elasticsearch.action.index.IndexRequest;
import org.elasticsearch.action.update.UpdateRequest;
import org.elasticsearch.common.xcontent.XContentType;
import java.io.Serializable;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Objects;
/**
* A version-agnostic Elasticsearch {@link UpsertStreamTableSink}.
*/
@Internal
public abstract class ElasticsearchUpsertTableSinkBase implements UpsertStreamTableSink<Row> {
/** Flag that indicates that only inserts are accepted. */
private final boolean isAppendOnly;
/** Schema of the table. */
private final TableSchema schema;
/** Version-agnostic hosts configuration. */
private final List<Host> hosts;
/** Default index for all requests. */
private final String index;
/** Default document type for all requests. */
private final String docType;
/** Delimiter for composite keys. */
private final String keyDelimiter;
/** String literal for null keys. */
private final String keyNullLiteral;
/** Serialization schema used for the document. */
private final SerializationSchema<Row> serializationSchema;
/** Content type describing the serialization schema. */
private final XContentType contentType;
/** Failure handler for failing {@link ActionRequest}s. */
private final ActionRequestFailureHandler failureHandler;
/**
* Map of optional configuration parameters for the Elasticsearch sink. The config is
* internal and can change at any time.
*/
private final Map<SinkOption, String> sinkOptions;
/**
* Version-agnostic creation of {@link ActionRequest}s.
*/
private final RequestFactory requestFactory;
/** Key field indices determined by the query. */
private int[] keyFieldIndices = new int[0];
public ElasticsearchUpsertTableSinkBase(
boolean isAppendOnly,
TableSchema schema,
List<Host> hosts,
String index,
String docType,
String keyDelimiter,
String keyNullLiteral,
SerializationSchema<Row> serializationSchema,
XContentType contentType,
ActionRequestFailureHandler failureHandler,
Map<SinkOption, String> sinkOptions,
RequestFactory requestFactory) {
this.isAppendOnly = isAppendOnly;
this.schema = Preconditions.checkNotNull(schema);
this.hosts = Preconditions.checkNotNull(hosts);
this.index = Preconditions.checkNotNull(index);
this.keyDelimiter = Preconditions.checkNotNull(keyDelimiter);
this.keyNullLiteral = Preconditions.checkNotNull(keyNullLiteral);
this.docType = Preconditions.checkNotNull(docType);
this.serializationSchema = Preconditions.checkNotNull(serializationSchema);
this.contentType = Preconditions.checkNotNull(contentType);
this.failureHandler = Preconditions.checkNotNull(failureHandler);
this.sinkOptions = Preconditions.checkNotNull(sinkOptions);
this.requestFactory = Preconditions.checkNotNull(requestFactory);
}
@Override
public void setKeyFields(String[] keyNames) {
if (keyNames == null) {
this.keyFieldIndices = new int[0];
return;
}
final String[] fieldNames = getFieldNames();
final int[] keyFieldIndices = new int[keyNames.length];
for (int i = 0; i < keyNames.length; i++) {
keyFieldIndices[i] = -1;
for (int j = 0; j < fieldNames.length; j++) {
if (keyNames[i].equals(fieldNames[j])) {
keyFieldIndices[i] = j;
break;
}
}
if (keyFieldIndices[i] == -1) {
throw new RuntimeException("Invalid key fields: " + Arrays.toString(keyNames));
}
}
validateKeyTypes(keyFieldIndices);
this.keyFieldIndices = keyFieldIndices;
}
@Override
public void setIsAppendOnly(Boolean isAppendOnly) {
if (this.isAppendOnly && !isAppendOnly) {
throw new ValidationException(
"The given query is not supported by this sink because the sink is configured to " +
"operate in append mode only. Thus, it only support insertions (no queries " +
"with updating results).");
}
}
@Override
public TypeInformation<Row> getRecordType() {
return schema.toRowType();
}
@Override
public DataStreamSink<?> consumeDataStream(DataStream<Tuple2<Boolean, Row>> dataStream) {
final ElasticsearchUpsertSinkFunction upsertFunction =
new ElasticsearchUpsertSinkFunction(
index,
docType,
keyDelimiter,
keyNullLiteral,
serializationSchema,
contentType,
requestFactory,
keyFieldIndices);
final SinkFunction<Tuple2<Boolean, Row>> sinkFunction = createSinkFunction(
hosts,
failureHandler,
sinkOptions,
upsertFunction);
return dataStream.addSink(sinkFunction)
.setParallelism(dataStream.getParallelism())
.name(TableConnectorUtils.generateRuntimeName(this.getClass(), getFieldNames()));
}
@Override
public void emitDataStream(DataStream<Tuple2<Boolean, Row>> dataStream) {
consumeDataStream(dataStream);
}
@Override
public TypeInformation<Tuple2<Boolean, Row>> getOutputType() {
return Types.TUPLE(Types.BOOLEAN, getRecordType());
}
@Override
public String[] getFieldNames() {
return schema.getFieldNames();
}
@Override
public TypeInformation<?>[] getFieldTypes() {
return schema.getFieldTypes();
}
@Override
public TableSink<Tuple2<Boolean, Row>> configure(String[] fieldNames, TypeInformation<?>[] fieldTypes) {
if (!Arrays.equals(getFieldNames(), fieldNames) || !Arrays.equals(getFieldTypes(), fieldTypes)) {
throw new ValidationException("Reconfiguration with different fields is not allowed. " +
"Expected: " + Arrays.toString(getFieldNames()) + " / " + Arrays.toString(getFieldTypes()) + ". " +
"But was: " + Arrays.toString(fieldNames) + " / " + Arrays.toString(fieldTypes));
}
return copy(
isAppendOnly,
schema,
hosts,
index,
docType,
keyDelimiter,
keyNullLiteral,
serializationSchema,
contentType,
failureHandler,
sinkOptions,
requestFactory);
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ElasticsearchUpsertTableSinkBase that = (ElasticsearchUpsertTableSinkBase) o;
return Objects.equals(isAppendOnly, that.isAppendOnly) &&
Objects.equals(schema, that.schema) &&
Objects.equals(hosts, that.hosts) &&
Objects.equals(index, that.index) &&
Objects.equals(docType, that.docType) &&
Objects.equals(keyDelimiter, that.keyDelimiter) &&
Objects.equals(keyNullLiteral, that.keyNullLiteral) &&
Objects.equals(serializationSchema, that.serializationSchema) &&
Objects.equals(contentType, that.contentType) &&
Objects.equals(failureHandler, that.failureHandler) &&
Objects.equals(sinkOptions, that.sinkOptions);
}
@Override
public int hashCode() {
return Objects.hash(
isAppendOnly,
schema,
hosts,
index,
docType,
keyDelimiter,
keyNullLiteral,
serializationSchema,
contentType,
failureHandler,
sinkOptions);
}
// --------------------------------------------------------------------------------------------
// For version-specific implementations
// --------------------------------------------------------------------------------------------
protected abstract ElasticsearchUpsertTableSinkBase copy(
boolean isAppendOnly,
TableSchema schema,
List<Host> hosts,
String index,
String docType,
String keyDelimiter,
String keyNullLiteral,
SerializationSchema<Row> serializationSchema,
XContentType contentType,
ActionRequestFailureHandler failureHandler,
Map<SinkOption, String> sinkOptions,
RequestFactory requestFactory);
protected abstract SinkFunction<Tuple2<Boolean, Row>> createSinkFunction(
List<Host> hosts,
ActionRequestFailureHandler failureHandler,
Map<SinkOption, String> sinkOptions,
ElasticsearchUpsertSinkFunction upsertFunction);
// --------------------------------------------------------------------------------------------
// Helper methods
// --------------------------------------------------------------------------------------------
/**
* Validate the types that are used for conversion to string.
*/
private void validateKeyTypes(int[] keyFieldIndices) {
final TypeInformation<?>[] types = getFieldTypes();
for (int keyFieldIndex : keyFieldIndices) {
final TypeInformation<?> type = types[keyFieldIndex];
if (!TypeCheckUtils.isSimpleStringRepresentation(type)) {
throw new ValidationException(
"Only simple types that can be safely converted into a string representation " +
"can be used as keys. But was: " + type);
}
}
}
// --------------------------------------------------------------------------------------------
// Helper classes
// --------------------------------------------------------------------------------------------
/**
* Keys for optional parameterization of the sink.
*/
public enum SinkOption {
DISABLE_FLUSH_ON_CHECKPOINT,
BULK_FLUSH_MAX_ACTIONS,
BULK_FLUSH_MAX_SIZE,
BULK_FLUSH_INTERVAL,
BULK_FLUSH_BACKOFF_ENABLED,
BULK_FLUSH_BACKOFF_TYPE,
BULK_FLUSH_BACKOFF_RETRIES,
BULK_FLUSH_BACKOFF_DELAY,
REST_MAX_RETRY_TIMEOUT,
REST_PATH_PREFIX
}
/**
* Entity for describing a host of Elasticsearch.
*/
public static class Host {
public final String hostname;
public final int port;
public final String protocol;
public Host(String hostname, int port, String protocol) {
this.hostname = hostname;
this.port = port;
this.protocol = protocol;
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
Host host = (Host) o;
return port == host.port &&
Objects.equals(hostname, host.hostname) &&
Objects.equals(protocol, host.protocol);
}
@Override
public int hashCode() {
return Objects.hash(
hostname,
port,
protocol);
}
}
/**
* For version-agnostic creating of {@link ActionRequest}s.
*/
public interface RequestFactory extends Serializable {
/**
* Creates an update request to be added to a {@link RequestIndexer}.
* Note: the type field has been deprecated since Elasticsearch 7.x and it would not take any effort.
*/
UpdateRequest createUpdateRequest(
String index,
String docType,
String key,
XContentType contentType,
byte[] document);
/**
* Creates an index request to be added to a {@link RequestIndexer}.
* Note: the type field has been deprecated since Elasticsearch 7.x and it would not take any effort.
*/
IndexRequest createIndexRequest(
String index,
String docType,
XContentType contentType,
byte[] document);
/**
* Creates a delete request to be added to a {@link RequestIndexer}.
* Note: the type field has been deprecated since Elasticsearch 7.x and it would not take any effort.
*/
DeleteRequest createDeleteRequest(
String index,
String docType,
String key);
}
/**
* Sink function for converting upserts into Elasticsearch {@link ActionRequest}s.
*/
public static class ElasticsearchUpsertSinkFunction implements ElasticsearchSinkFunction<Tuple2<Boolean, Row>> {
private final String index;
private final String docType;
private final String keyDelimiter;
private final String keyNullLiteral;
private final SerializationSchema<Row> serializationSchema;
private final XContentType contentType;
private final RequestFactory requestFactory;
private final int[] keyFieldIndices;
public ElasticsearchUpsertSinkFunction(
String index,
String docType,
String keyDelimiter,
String keyNullLiteral,
SerializationSchema<Row> serializationSchema,
XContentType contentType,
RequestFactory requestFactory,
int[] keyFieldIndices) {
this.index = Preconditions.checkNotNull(index);
this.docType = Preconditions.checkNotNull(docType);
this.keyDelimiter = Preconditions.checkNotNull(keyDelimiter);
this.serializationSchema = Preconditions.checkNotNull(serializationSchema);
this.contentType = Preconditions.checkNotNull(contentType);
this.keyFieldIndices = Preconditions.checkNotNull(keyFieldIndices);
this.requestFactory = Preconditions.checkNotNull(requestFactory);
this.keyNullLiteral = Preconditions.checkNotNull(keyNullLiteral);
}
@Override
public void process(Tuple2<Boolean, Row> element, RuntimeContext ctx, RequestIndexer indexer) {
if (element.f0) {
processUpsert(element.f1, indexer);
} else {
processDelete(element.f1, indexer);
}
}
private void processUpsert(Row row, RequestIndexer indexer) {
final byte[] document = serializationSchema.serialize(row);
if (keyFieldIndices.length == 0) {
final IndexRequest indexRequest = requestFactory.createIndexRequest(
index,
docType,
contentType,
document);
indexer.add(indexRequest);
} else {
final String key = createKey(row);
final UpdateRequest updateRequest = requestFactory.createUpdateRequest(
index,
docType,
key,
contentType,
document);
indexer.add(updateRequest);
}
}
private void processDelete(Row row, RequestIndexer indexer) {
final String key = createKey(row);
final DeleteRequest deleteRequest = requestFactory.createDeleteRequest(
index,
docType,
key);
indexer.add(deleteRequest);
}
private String createKey(Row row) {
final StringBuilder builder = new StringBuilder();
for (int i = 0; i < keyFieldIndices.length; i++) {
final int keyFieldIndex = keyFieldIndices[i];
if (i > 0) {
builder.append(keyDelimiter);
}
final Object value = row.getField(keyFieldIndex);
if (value == null) {
builder.append(keyNullLiteral);
} else {
builder.append(value.toString());
}
}
return builder.toString();
}
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
ElasticsearchUpsertSinkFunction that = (ElasticsearchUpsertSinkFunction) o;
return Objects.equals(index, that.index) &&
Objects.equals(docType, that.docType) &&
Objects.equals(keyDelimiter, that.keyDelimiter) &&
Objects.equals(keyNullLiteral, that.keyNullLiteral) &&
Objects.equals(serializationSchema, that.serializationSchema) &&
contentType == that.contentType &&
Objects.equals(requestFactory, that.requestFactory) &&
Arrays.equals(keyFieldIndices, that.keyFieldIndices);
}
@Override
public int hashCode() {
int result = Objects.hash(
index,
docType,
keyDelimiter,
keyNullLiteral,
serializationSchema,
contentType,
requestFactory);
result = 31 * result + Arrays.hashCode(keyFieldIndices);
return result;
}
}
}