twalthr commented on code in PR #27502:
URL: https://github.com/apache/flink/pull/27502#discussion_r2757936704
##########
flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/stream/StreamExecSink.java:
##########
@@ -390,6 +408,20 @@ private OneInputStreamOperator<RowData, RowData>
createSumOperator(
GeneratedRecordEqualiser rowEqualiser,
GeneratedHashFunction rowHashFunction) {
+ // Check if we should use the watermark-compacting materializer for
ERROR/NOTHING strategies
+ if (conflictStrategy != null
+ && (conflictStrategy.getBehavior() ==
InsertConflictStrategy.ConflictBehavior.ERROR
+ || conflictStrategy.getBehavior()
+ ==
InsertConflictStrategy.ConflictBehavior.NOTHING)) {
Review Comment:
safe boolean above in local variable and reuse it here
##########
flink-table/flink-table-planner/src/main/scala/org/apache/flink/table/planner/plan/optimize/program/FlinkChangelogModeInferenceProgram.scala:
##########
@@ -1060,6 +1060,15 @@ class FlinkChangelogModeInferenceProgram extends
FlinkOptimizeProgram[StreamOpti
case UpsertMaterialize.FORCE => primaryKeys.nonEmpty && !sinkIsRetract
case UpsertMaterialize.NONE => false
case UpsertMaterialize.AUTO =>
+ // For NOTHING/ERROR strategies with a primary key, we always need
materialization
+ // to handle conflicts, even for append-only input or insert-only
sinks
+ val requiresMaterializationForConflict = primaryKeys.nonEmpty &&
+ sink.conflictStrategy != null &&
Review Comment:
to my comment above: I would suggest to move this if clause condition to a
static method in StreamPhysicalSink. I added similar helpers for
ProcessTableFunction.
##########
flink-table/flink-table-planner/src/test/java/org/apache/flink/table/planner/plan/nodes/exec/stream/SinkSemanticTests.java:
##########
@@ -18,21 +18,48 @@
package org.apache.flink.table.planner.plan.nodes.exec.stream;
+import org.apache.flink.table.api.TableEnvironment;
import
org.apache.flink.table.planner.plan.nodes.exec.testutils.SemanticTestBase;
+import org.apache.flink.table.test.program.SinkTestStep;
import org.apache.flink.table.test.program.TableTestProgram;
+import org.apache.flink.table.test.program.TestStep;
+import org.apache.flink.table.test.program.TestStep.TestKind;
+import java.util.EnumSet;
import java.util.List;
+import java.util.Map;
/** Semantic tests for {@link StreamExecSink}. */
public class SinkSemanticTests extends SemanticTestBase {
+ @Override
+ public EnumSet<TestKind> supportedSetupSteps() {
+ EnumSet<TestKind> steps = super.supportedSetupSteps();
Review Comment:
what is the reason for this change? all sinks seem to have data?
##########
flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/stream/StreamExecSink.java:
##########
@@ -358,9 +353,32 @@ protected Transformation<RowData> applyUpsertMaterialize(
.mapToObj(idx -> fieldNames[idx])
.collect(Collectors.toList());
+ // For ERROR/NOTHING strategies, apply WatermarkTimestampAssigner first
+ // This assigns the current watermark as the timestamp to each record,
+ // which is required for the WatermarkCompactingSinkMaterializer to
work correctly
+ Transformation<RowData> transformForMaterializer = inputTransform;
+ if (conflictStrategy != null
+ && (conflictStrategy.getBehavior() ==
InsertConflictStrategy.ConflictBehavior.ERROR
Review Comment:
nit: static import ConflictBehavior and maybe put behavior into a local
variable. goal: a short and readable if clause.
##########
flink-table/flink-table-runtime/src/main/java/org/apache/flink/table/runtime/operators/sink/WatermarkCompactingSinkMaterializer.java:
##########
@@ -0,0 +1,341 @@
+/*
+ * 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.table.runtime.operators.sink;
+
+import org.apache.flink.api.common.state.MapState;
+import org.apache.flink.api.common.state.MapStateDescriptor;
+import org.apache.flink.api.common.state.ValueState;
+import org.apache.flink.api.common.state.ValueStateDescriptor;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.ListSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.runtime.state.KeyedStateBackend;
+import org.apache.flink.runtime.state.VoidNamespace;
+import org.apache.flink.runtime.state.VoidNamespaceSerializer;
+import org.apache.flink.streaming.api.operators.OneInputStreamOperator;
+import org.apache.flink.streaming.api.operators.TimestampedCollector;
+import org.apache.flink.streaming.api.watermark.Watermark;
+import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
+import org.apache.flink.table.api.InsertConflictStrategy;
+import org.apache.flink.table.api.InsertConflictStrategy.ConflictBehavior;
+import org.apache.flink.table.api.TableRuntimeException;
+import org.apache.flink.table.data.RowData;
+import org.apache.flink.table.data.utils.ProjectedRowData;
+import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser;
+import org.apache.flink.table.runtime.generated.RecordEqualiser;
+import org.apache.flink.table.runtime.operators.TableStreamOperator;
+import org.apache.flink.table.runtime.typeutils.InternalSerializers;
+import org.apache.flink.table.types.logical.RowType;
+import org.apache.flink.types.RowKind;
+import org.apache.flink.util.Preconditions;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.apache.flink.types.RowKind.DELETE;
+import static org.apache.flink.types.RowKind.INSERT;
+import static org.apache.flink.types.RowKind.UPDATE_AFTER;
+
+/**
+ * A sink materializer that buffers records and compacts them on watermark
progression.
+ *
+ * <p>This operator implements the watermark-based compaction algorithm from
FLIP-558 for handling
+ * changelog disorder when the upsert key differs from the sink's primary key.
+ */
+public class WatermarkCompactingSinkMaterializer extends
TableStreamOperator<RowData>
+ implements OneInputStreamOperator<RowData, RowData> {
+
+ private static final long serialVersionUID = 1L;
+
+ private static final Logger LOG =
+ LoggerFactory.getLogger(WatermarkCompactingSinkMaterializer.class);
+
+ private static final String STATE_CLEARED_WARN_MSG =
+ "The state is cleared because of state ttl. This will result in
incorrect result. "
+ + "You can increase the state ttl to avoid this.";
+ private static final Set<String> ORDERED_STATE_BACKENDS =
Set.of("rocksdb", "forst");
+
+ private final InsertConflictStrategy conflictStrategy;
+ private final TypeSerializer<RowData> serializer;
+ private final GeneratedRecordEqualiser generatedRecordEqualiser;
+ private final GeneratedRecordEqualiser generatedUpsertKeyEqualiser;
+ private final int[] inputUpsertKey;
+ private final boolean hasUpsertKey;
+
+ private transient MapStateDescriptor<Long, List<RowData>> bufferDescriptor;
+ private transient MapState<Long, List<RowData>> buffer;
+ private transient ValueState<RowData> currentValue;
+ private transient RecordEqualiser equaliser;
+ private transient RecordEqualiser upsertKeyEqualiser;
+ private transient TimestampedCollector<RowData> collector;
+ private transient boolean isOrderedStateBackend;
+
+ // Reused ProjectedRowData for comparing upsertKey if hasUpsertKey.
+ private transient ProjectedRowData upsertKeyProjectedRow1;
+ private transient ProjectedRowData upsertKeyProjectedRow2;
+
+ public WatermarkCompactingSinkMaterializer(
+ InsertConflictStrategy conflictStrategy,
+ TypeSerializer<RowData> serializer,
+ GeneratedRecordEqualiser generatedRecordEqualiser,
+ @Nullable GeneratedRecordEqualiser generatedUpsertKeyEqualiser,
+ @Nullable int[] inputUpsertKey) {
+ validateConflictStrategy(conflictStrategy);
+ this.conflictStrategy = conflictStrategy;
+ this.serializer = serializer;
+ this.generatedRecordEqualiser = generatedRecordEqualiser;
+ this.generatedUpsertKeyEqualiser = generatedUpsertKeyEqualiser;
+ this.inputUpsertKey = inputUpsertKey;
+ this.hasUpsertKey = inputUpsertKey != null && inputUpsertKey.length >
0;
+ }
+
+ private static void validateConflictStrategy(InsertConflictStrategy
strategy) {
+ Preconditions.checkArgument(
+ strategy.getBehavior() == ConflictBehavior.ERROR
+ || strategy.getBehavior() == ConflictBehavior.NOTHING,
+ "Only ERROR and NOTHING strategies are supported, got: %s",
+ strategy);
+ }
+
+ @Override
+ public void open() throws Exception {
+ super.open();
+ initializeEqualisers();
+ detectOrderedStateBackend();
+ initializeState();
+ this.collector = new TimestampedCollector<>(output);
+ }
+
+ private void initializeEqualisers() {
+ if (hasUpsertKey) {
+ this.upsertKeyEqualiser =
+ generatedUpsertKeyEqualiser.newInstance(
+ getRuntimeContext().getUserCodeClassLoader());
+ upsertKeyProjectedRow1 = ProjectedRowData.from(inputUpsertKey);
+ upsertKeyProjectedRow2 = ProjectedRowData.from(inputUpsertKey);
+ }
+ this.equaliser =
+
generatedRecordEqualiser.newInstance(getRuntimeContext().getUserCodeClassLoader());
+ }
+
+ private void detectOrderedStateBackend() {
+ KeyedStateBackend<?> keyedStateBackend = getKeyedStateBackend();
+ String backendType =
+ keyedStateBackend != null ?
keyedStateBackend.getBackendTypeIdentifier() : "";
+ this.isOrderedStateBackend =
ORDERED_STATE_BACKENDS.contains(backendType);
+
+ if (isOrderedStateBackend) {
+ LOG.info("Using ordered state backend optimization for {}
backend", backendType);
+ }
+ }
+
+ private void initializeState() {
+ this.bufferDescriptor =
+ new MapStateDescriptor<>(
+ "watermark-buffer",
+ LongSerializer.INSTANCE,
+ new ListSerializer<>(serializer));
+ this.buffer = getRuntimeContext().getMapState(bufferDescriptor);
+
+ ValueStateDescriptor<RowData> currentValueDescriptor =
+ new ValueStateDescriptor<>("current-value", serializer);
+ this.currentValue =
getRuntimeContext().getState(currentValueDescriptor);
+ }
+
+ @Override
+ public void processElement(StreamRecord<RowData> element) throws Exception
{
+ RowData row = element.getValue();
+ long assignedTimestamp = element.getTimestamp();
+ bufferRecord(assignedTimestamp, row);
+ }
+
+ private void bufferRecord(long timestamp, RowData row) throws Exception {
+ List<RowData> records = buffer.get(timestamp);
+ if (records == null) {
+ records = new ArrayList<>();
Review Comment:
nit: should we pre initialize with 1?
##########
flink-table/flink-table-planner/src/main/java/org/apache/flink/table/planner/plan/nodes/exec/common/CommonExecSink.java:
##########
@@ -187,8 +187,7 @@ protected Transformation<Object> createSinkTransformation(
Optional<LineageVertex> lineageVertexOpt =
TableLineageUtils.extractLineageDataset(outputObject);
- // only add materialization if input has change
- final boolean needMaterialization = !inputInsertOnly &&
upsertMaterialize;
+ final boolean needMaterialization = upsertMaterialize;
Review Comment:
remove this variable?
##########
flink-table/flink-table-runtime/src/main/java/org/apache/flink/table/runtime/operators/sink/WatermarkCompactingSinkMaterializer.java:
##########
@@ -0,0 +1,341 @@
+/*
+ * 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.table.runtime.operators.sink;
+
+import org.apache.flink.api.common.state.MapState;
+import org.apache.flink.api.common.state.MapStateDescriptor;
+import org.apache.flink.api.common.state.ValueState;
+import org.apache.flink.api.common.state.ValueStateDescriptor;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.ListSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.runtime.state.KeyedStateBackend;
+import org.apache.flink.runtime.state.VoidNamespace;
+import org.apache.flink.runtime.state.VoidNamespaceSerializer;
+import org.apache.flink.streaming.api.operators.OneInputStreamOperator;
+import org.apache.flink.streaming.api.operators.TimestampedCollector;
+import org.apache.flink.streaming.api.watermark.Watermark;
+import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
+import org.apache.flink.table.api.InsertConflictStrategy;
+import org.apache.flink.table.api.InsertConflictStrategy.ConflictBehavior;
+import org.apache.flink.table.api.TableRuntimeException;
+import org.apache.flink.table.data.RowData;
+import org.apache.flink.table.data.utils.ProjectedRowData;
+import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser;
+import org.apache.flink.table.runtime.generated.RecordEqualiser;
+import org.apache.flink.table.runtime.operators.TableStreamOperator;
+import org.apache.flink.table.runtime.typeutils.InternalSerializers;
+import org.apache.flink.table.types.logical.RowType;
+import org.apache.flink.types.RowKind;
+import org.apache.flink.util.Preconditions;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.apache.flink.types.RowKind.DELETE;
+import static org.apache.flink.types.RowKind.INSERT;
+import static org.apache.flink.types.RowKind.UPDATE_AFTER;
+
+/**
+ * A sink materializer that buffers records and compacts them on watermark
progression.
+ *
+ * <p>This operator implements the watermark-based compaction algorithm from
FLIP-558 for handling
+ * changelog disorder when the upsert key differs from the sink's primary key.
+ */
+public class WatermarkCompactingSinkMaterializer extends
TableStreamOperator<RowData>
+ implements OneInputStreamOperator<RowData, RowData> {
+
+ private static final long serialVersionUID = 1L;
+
+ private static final Logger LOG =
+ LoggerFactory.getLogger(WatermarkCompactingSinkMaterializer.class);
+
+ private static final String STATE_CLEARED_WARN_MSG =
+ "The state is cleared because of state ttl. This will result in
incorrect result. "
+ + "You can increase the state ttl to avoid this.";
+ private static final Set<String> ORDERED_STATE_BACKENDS =
Set.of("rocksdb", "forst");
+
+ private final InsertConflictStrategy conflictStrategy;
+ private final TypeSerializer<RowData> serializer;
+ private final GeneratedRecordEqualiser generatedRecordEqualiser;
+ private final GeneratedRecordEqualiser generatedUpsertKeyEqualiser;
+ private final int[] inputUpsertKey;
+ private final boolean hasUpsertKey;
+
+ private transient MapStateDescriptor<Long, List<RowData>> bufferDescriptor;
+ private transient MapState<Long, List<RowData>> buffer;
+ private transient ValueState<RowData> currentValue;
+ private transient RecordEqualiser equaliser;
+ private transient RecordEqualiser upsertKeyEqualiser;
+ private transient TimestampedCollector<RowData> collector;
+ private transient boolean isOrderedStateBackend;
+
+ // Reused ProjectedRowData for comparing upsertKey if hasUpsertKey.
+ private transient ProjectedRowData upsertKeyProjectedRow1;
+ private transient ProjectedRowData upsertKeyProjectedRow2;
+
+ public WatermarkCompactingSinkMaterializer(
+ InsertConflictStrategy conflictStrategy,
+ TypeSerializer<RowData> serializer,
+ GeneratedRecordEqualiser generatedRecordEqualiser,
+ @Nullable GeneratedRecordEqualiser generatedUpsertKeyEqualiser,
+ @Nullable int[] inputUpsertKey) {
+ validateConflictStrategy(conflictStrategy);
+ this.conflictStrategy = conflictStrategy;
+ this.serializer = serializer;
+ this.generatedRecordEqualiser = generatedRecordEqualiser;
+ this.generatedUpsertKeyEqualiser = generatedUpsertKeyEqualiser;
+ this.inputUpsertKey = inputUpsertKey;
+ this.hasUpsertKey = inputUpsertKey != null && inputUpsertKey.length >
0;
+ }
+
+ private static void validateConflictStrategy(InsertConflictStrategy
strategy) {
+ Preconditions.checkArgument(
+ strategy.getBehavior() == ConflictBehavior.ERROR
+ || strategy.getBehavior() == ConflictBehavior.NOTHING,
+ "Only ERROR and NOTHING strategies are supported, got: %s",
+ strategy);
+ }
+
+ @Override
+ public void open() throws Exception {
+ super.open();
+ initializeEqualisers();
+ detectOrderedStateBackend();
+ initializeState();
+ this.collector = new TimestampedCollector<>(output);
+ }
+
+ private void initializeEqualisers() {
+ if (hasUpsertKey) {
+ this.upsertKeyEqualiser =
+ generatedUpsertKeyEqualiser.newInstance(
+ getRuntimeContext().getUserCodeClassLoader());
+ upsertKeyProjectedRow1 = ProjectedRowData.from(inputUpsertKey);
+ upsertKeyProjectedRow2 = ProjectedRowData.from(inputUpsertKey);
+ }
+ this.equaliser =
+
generatedRecordEqualiser.newInstance(getRuntimeContext().getUserCodeClassLoader());
+ }
+
+ private void detectOrderedStateBackend() {
+ KeyedStateBackend<?> keyedStateBackend = getKeyedStateBackend();
+ String backendType =
+ keyedStateBackend != null ?
keyedStateBackend.getBackendTypeIdentifier() : "";
+ this.isOrderedStateBackend =
ORDERED_STATE_BACKENDS.contains(backendType);
+
+ if (isOrderedStateBackend) {
+ LOG.info("Using ordered state backend optimization for {}
backend", backendType);
+ }
+ }
+
+ private void initializeState() {
+ this.bufferDescriptor =
+ new MapStateDescriptor<>(
+ "watermark-buffer",
+ LongSerializer.INSTANCE,
+ new ListSerializer<>(serializer));
+ this.buffer = getRuntimeContext().getMapState(bufferDescriptor);
+
+ ValueStateDescriptor<RowData> currentValueDescriptor =
+ new ValueStateDescriptor<>("current-value", serializer);
+ this.currentValue =
getRuntimeContext().getState(currentValueDescriptor);
+ }
+
+ @Override
+ public void processElement(StreamRecord<RowData> element) throws Exception
{
+ RowData row = element.getValue();
+ long assignedTimestamp = element.getTimestamp();
+ bufferRecord(assignedTimestamp, row);
+ }
+
+ private void bufferRecord(long timestamp, RowData row) throws Exception {
+ List<RowData> records = buffer.get(timestamp);
+ if (records == null) {
+ records = new ArrayList<>();
+ }
+ records.add(row);
+ buffer.put(timestamp, records);
+ }
+
+ @Override
+ public void processWatermark(Watermark mark) throws Exception {
+ final long watermarkTimestamp = mark.getTimestamp();
+
+ // Iterate over all keys and compact their buffered records
+ this.<RowData>getKeyedStateBackend()
+ .applyToAllKeys(
+ VoidNamespace.INSTANCE,
+ VoidNamespaceSerializer.INSTANCE,
+ bufferDescriptor,
+ (key, state) -> compactAndEmit(watermarkTimestamp));
+
+ super.processWatermark(mark);
+ }
+
+ private void compactAndEmit(long newWatermark) throws Exception {
+ RowData previousValue = currentValue.value();
+ List<RowData> pendingRecords = collectPendingRecords(previousValue,
newWatermark);
+
+ if (pendingRecords.size() > 1) {
+ if (conflictStrategy.getBehavior() == ConflictBehavior.ERROR) {
+ throw new TableRuntimeException(
+ "Primary key constraint violation: multiple distinct
records with "
+ + "the same primary key detected. Use ON
CONFLICT DO NOTHING "
+ + "to keep the first record.");
+ } else if (previousValue == null) {
+ final RowData newValue = pendingRecords.get(0);
+ emit(newValue, INSERT);
+ currentValue.update(newValue);
+ }
+ } else if (pendingRecords.isEmpty()) {
+ if (previousValue != null) {
+ emit(previousValue, DELETE);
+ currentValue.clear();
+ }
+ } else {
+ final RowData newValue = pendingRecords.get(0);
+ if (previousValue == null) {
+ emit(newValue, INSERT);
+ currentValue.update(newValue);
+ } else if (!recordEquals(previousValue, newValue)) {
+ emit(newValue, UPDATE_AFTER);
+ currentValue.update(newValue);
+ }
+ }
+ }
+
+ private List<RowData> collectPendingRecords(RowData previousValue, long
newWatermark)
+ throws Exception {
+ List<RowData> records = new ArrayList<>();
+ if (previousValue != null) {
+ records.add(previousValue);
+ }
+ Iterator<Map.Entry<Long, List<RowData>>> iterator =
buffer.entries().iterator();
+
+ while (iterator.hasNext()) {
+ Map.Entry<Long, List<RowData>> entry = iterator.next();
+ if (entry.getKey() <= newWatermark) {
+ for (RowData pendingRecord : entry.getValue()) {
+ switch (pendingRecord.getRowKind()) {
+ case INSERT:
+ case UPDATE_AFTER:
+ addRow(records, pendingRecord);
+ break;
+
+ case UPDATE_BEFORE:
+ case DELETE:
+ retractRow(records, pendingRecord);
+ break;
+ }
+ }
+ iterator.remove();
+ } else if (isOrderedStateBackend) {
Review Comment:
the logic breaks if the watermark is before 1970 right? it is a byte
ordering, not a Long order, right?
##########
flink-table/flink-table-runtime/src/main/java/org/apache/flink/table/runtime/operators/sink/WatermarkCompactingSinkMaterializer.java:
##########
@@ -0,0 +1,341 @@
+/*
+ * 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.table.runtime.operators.sink;
+
+import org.apache.flink.api.common.state.MapState;
+import org.apache.flink.api.common.state.MapStateDescriptor;
+import org.apache.flink.api.common.state.ValueState;
+import org.apache.flink.api.common.state.ValueStateDescriptor;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.ListSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.runtime.state.KeyedStateBackend;
+import org.apache.flink.runtime.state.VoidNamespace;
+import org.apache.flink.runtime.state.VoidNamespaceSerializer;
+import org.apache.flink.streaming.api.operators.OneInputStreamOperator;
+import org.apache.flink.streaming.api.operators.TimestampedCollector;
+import org.apache.flink.streaming.api.watermark.Watermark;
+import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
+import org.apache.flink.table.api.InsertConflictStrategy;
+import org.apache.flink.table.api.InsertConflictStrategy.ConflictBehavior;
+import org.apache.flink.table.api.TableRuntimeException;
+import org.apache.flink.table.data.RowData;
+import org.apache.flink.table.data.utils.ProjectedRowData;
+import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser;
+import org.apache.flink.table.runtime.generated.RecordEqualiser;
+import org.apache.flink.table.runtime.operators.TableStreamOperator;
+import org.apache.flink.table.runtime.typeutils.InternalSerializers;
+import org.apache.flink.table.types.logical.RowType;
+import org.apache.flink.types.RowKind;
+import org.apache.flink.util.Preconditions;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.apache.flink.types.RowKind.DELETE;
+import static org.apache.flink.types.RowKind.INSERT;
+import static org.apache.flink.types.RowKind.UPDATE_AFTER;
+
+/**
+ * A sink materializer that buffers records and compacts them on watermark
progression.
+ *
+ * <p>This operator implements the watermark-based compaction algorithm from
FLIP-558 for handling
+ * changelog disorder when the upsert key differs from the sink's primary key.
+ */
+public class WatermarkCompactingSinkMaterializer extends
TableStreamOperator<RowData>
+ implements OneInputStreamOperator<RowData, RowData> {
+
+ private static final long serialVersionUID = 1L;
+
+ private static final Logger LOG =
+ LoggerFactory.getLogger(WatermarkCompactingSinkMaterializer.class);
+
+ private static final String STATE_CLEARED_WARN_MSG =
+ "The state is cleared because of state ttl. This will result in
incorrect result. "
Review Comment:
```suggestion
"The state is cleared because of state TTL. This will result in
incorrect result. "
```
##########
flink-table/flink-table-runtime/src/main/java/org/apache/flink/table/runtime/operators/sink/WatermarkCompactingSinkMaterializer.java:
##########
@@ -0,0 +1,341 @@
+/*
+ * 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.table.runtime.operators.sink;
+
+import org.apache.flink.api.common.state.MapState;
+import org.apache.flink.api.common.state.MapStateDescriptor;
+import org.apache.flink.api.common.state.ValueState;
+import org.apache.flink.api.common.state.ValueStateDescriptor;
+import org.apache.flink.api.common.typeutils.TypeSerializer;
+import org.apache.flink.api.common.typeutils.base.ListSerializer;
+import org.apache.flink.api.common.typeutils.base.LongSerializer;
+import org.apache.flink.runtime.state.KeyedStateBackend;
+import org.apache.flink.runtime.state.VoidNamespace;
+import org.apache.flink.runtime.state.VoidNamespaceSerializer;
+import org.apache.flink.streaming.api.operators.OneInputStreamOperator;
+import org.apache.flink.streaming.api.operators.TimestampedCollector;
+import org.apache.flink.streaming.api.watermark.Watermark;
+import org.apache.flink.streaming.runtime.streamrecord.StreamRecord;
+import org.apache.flink.table.api.InsertConflictStrategy;
+import org.apache.flink.table.api.InsertConflictStrategy.ConflictBehavior;
+import org.apache.flink.table.api.TableRuntimeException;
+import org.apache.flink.table.data.RowData;
+import org.apache.flink.table.data.utils.ProjectedRowData;
+import org.apache.flink.table.runtime.generated.GeneratedRecordEqualiser;
+import org.apache.flink.table.runtime.generated.RecordEqualiser;
+import org.apache.flink.table.runtime.operators.TableStreamOperator;
+import org.apache.flink.table.runtime.typeutils.InternalSerializers;
+import org.apache.flink.table.types.logical.RowType;
+import org.apache.flink.types.RowKind;
+import org.apache.flink.util.Preconditions;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import javax.annotation.Nullable;
+
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+import static org.apache.flink.types.RowKind.DELETE;
+import static org.apache.flink.types.RowKind.INSERT;
+import static org.apache.flink.types.RowKind.UPDATE_AFTER;
+
+/**
+ * A sink materializer that buffers records and compacts them on watermark
progression.
+ *
+ * <p>This operator implements the watermark-based compaction algorithm from
FLIP-558 for handling
+ * changelog disorder when the upsert key differs from the sink's primary key.
+ */
+public class WatermarkCompactingSinkMaterializer extends
TableStreamOperator<RowData>
+ implements OneInputStreamOperator<RowData, RowData> {
+
+ private static final long serialVersionUID = 1L;
+
+ private static final Logger LOG =
+ LoggerFactory.getLogger(WatermarkCompactingSinkMaterializer.class);
+
+ private static final String STATE_CLEARED_WARN_MSG =
+ "The state is cleared because of state ttl. This will result in
incorrect result. "
+ + "You can increase the state ttl to avoid this.";
+ private static final Set<String> ORDERED_STATE_BACKENDS =
Set.of("rocksdb", "forst");
+
+ private final InsertConflictStrategy conflictStrategy;
+ private final TypeSerializer<RowData> serializer;
+ private final GeneratedRecordEqualiser generatedRecordEqualiser;
+ private final GeneratedRecordEqualiser generatedUpsertKeyEqualiser;
+ private final int[] inputUpsertKey;
+ private final boolean hasUpsertKey;
+
+ private transient MapStateDescriptor<Long, List<RowData>> bufferDescriptor;
+ private transient MapState<Long, List<RowData>> buffer;
+ private transient ValueState<RowData> currentValue;
+ private transient RecordEqualiser equaliser;
+ private transient RecordEqualiser upsertKeyEqualiser;
+ private transient TimestampedCollector<RowData> collector;
+ private transient boolean isOrderedStateBackend;
+
+ // Reused ProjectedRowData for comparing upsertKey if hasUpsertKey.
+ private transient ProjectedRowData upsertKeyProjectedRow1;
+ private transient ProjectedRowData upsertKeyProjectedRow2;
+
+ public WatermarkCompactingSinkMaterializer(
+ InsertConflictStrategy conflictStrategy,
+ TypeSerializer<RowData> serializer,
+ GeneratedRecordEqualiser generatedRecordEqualiser,
+ @Nullable GeneratedRecordEqualiser generatedUpsertKeyEqualiser,
+ @Nullable int[] inputUpsertKey) {
+ validateConflictStrategy(conflictStrategy);
+ this.conflictStrategy = conflictStrategy;
+ this.serializer = serializer;
+ this.generatedRecordEqualiser = generatedRecordEqualiser;
+ this.generatedUpsertKeyEqualiser = generatedUpsertKeyEqualiser;
+ this.inputUpsertKey = inputUpsertKey;
+ this.hasUpsertKey = inputUpsertKey != null && inputUpsertKey.length >
0;
+ }
+
+ private static void validateConflictStrategy(InsertConflictStrategy
strategy) {
+ Preconditions.checkArgument(
+ strategy.getBehavior() == ConflictBehavior.ERROR
+ || strategy.getBehavior() == ConflictBehavior.NOTHING,
+ "Only ERROR and NOTHING strategies are supported, got: %s",
+ strategy);
+ }
+
+ @Override
+ public void open() throws Exception {
+ super.open();
+ initializeEqualisers();
+ detectOrderedStateBackend();
+ initializeState();
+ this.collector = new TimestampedCollector<>(output);
+ }
+
+ private void initializeEqualisers() {
+ if (hasUpsertKey) {
+ this.upsertKeyEqualiser =
+ generatedUpsertKeyEqualiser.newInstance(
+ getRuntimeContext().getUserCodeClassLoader());
+ upsertKeyProjectedRow1 = ProjectedRowData.from(inputUpsertKey);
+ upsertKeyProjectedRow2 = ProjectedRowData.from(inputUpsertKey);
+ }
+ this.equaliser =
+
generatedRecordEqualiser.newInstance(getRuntimeContext().getUserCodeClassLoader());
+ }
+
+ private void detectOrderedStateBackend() {
+ KeyedStateBackend<?> keyedStateBackend = getKeyedStateBackend();
+ String backendType =
+ keyedStateBackend != null ?
keyedStateBackend.getBackendTypeIdentifier() : "";
+ this.isOrderedStateBackend =
ORDERED_STATE_BACKENDS.contains(backendType);
+
+ if (isOrderedStateBackend) {
+ LOG.info("Using ordered state backend optimization for {}
backend", backendType);
+ }
+ }
+
+ private void initializeState() {
+ this.bufferDescriptor =
+ new MapStateDescriptor<>(
+ "watermark-buffer",
+ LongSerializer.INSTANCE,
+ new ListSerializer<>(serializer));
+ this.buffer = getRuntimeContext().getMapState(bufferDescriptor);
+
+ ValueStateDescriptor<RowData> currentValueDescriptor =
+ new ValueStateDescriptor<>("current-value", serializer);
+ this.currentValue =
getRuntimeContext().getState(currentValueDescriptor);
+ }
+
+ @Override
+ public void processElement(StreamRecord<RowData> element) throws Exception
{
+ RowData row = element.getValue();
+ long assignedTimestamp = element.getTimestamp();
+ bufferRecord(assignedTimestamp, row);
+ }
+
+ private void bufferRecord(long timestamp, RowData row) throws Exception {
+ List<RowData> records = buffer.get(timestamp);
+ if (records == null) {
+ records = new ArrayList<>();
+ }
+ records.add(row);
+ buffer.put(timestamp, records);
+ }
+
+ @Override
+ public void processWatermark(Watermark mark) throws Exception {
+ final long watermarkTimestamp = mark.getTimestamp();
+
+ // Iterate over all keys and compact their buffered records
+ this.<RowData>getKeyedStateBackend()
+ .applyToAllKeys(
+ VoidNamespace.INSTANCE,
+ VoidNamespaceSerializer.INSTANCE,
+ bufferDescriptor,
+ (key, state) -> compactAndEmit(watermarkTimestamp));
+
+ super.processWatermark(mark);
+ }
+
+ private void compactAndEmit(long newWatermark) throws Exception {
+ RowData previousValue = currentValue.value();
+ List<RowData> pendingRecords = collectPendingRecords(previousValue,
newWatermark);
+
+ if (pendingRecords.size() > 1) {
+ if (conflictStrategy.getBehavior() == ConflictBehavior.ERROR) {
+ throw new TableRuntimeException(
+ "Primary key constraint violation: multiple distinct
records with "
Review Comment:
should we print at least the conflicting key?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
