[FLINK-19694][table] Support Upsert ChangelogMode for ScanTableSource #13721

wuchong · 2020-10-21T10:25:04Z

What is the purpose of the change

Support [UPDATE_AFTER, DELETE] ChangelogMode which indicates the source will emit only UPDATE_AFTER and DELETE messages during runtime (e.g. an upsert source). The planner will add the a materialization operator when the ChangelogMode of the source is [UPDATE_AFTER, DELETE].

The materialization operator will materialize the upsert stream and generate changelog stream with full change messages. In the physical operator, we will use state to know whether the key is the first time to be seen. The operator will produce INSERT rows, or additionally generate UPDATE_BEFORE rows for the previous image, or produce DELETE rows with all columns filled with values.

Brief change log

Support in planner: Generate a StreamExecUpsertMaterialize when the scan is a upsert source.
Update metadata handlers: Update ColumnUniqueness, ModifiedMonotonicity, UniqueKeys metadatas and fix some minor bugs in FlinkRelMdModifiedMonotonicity.
Support in runtime: Reuse the implementation of deduplicate function, add a new process path for changelog input stream.

Verifying this change

Added many tests for plan and runtime to cover different operations on upsert source.

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (yes / no)
The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
The serializers: (yes / no / don't know)
The runtime per-record code paths (performance sensitive): (yes / no / don't know)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Yarn/Mesos, ZooKeeper: (yes / no / don't know)
The S3 file system connector: (yes / no / don't know)

Documentation

Does this pull request introduce a new feature? (yes / no)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

wuchong · 2020-10-21T10:25:57Z

Hi @leonardBang , could you help to review this?
Appreciate if @godfreyhe can help to review the plan and metadata part.

flinkbot · 2020-10-21T10:28:43Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit a62fac3 (Wed Oct 21 10:28:42 UTC 2020)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-10-21T11:02:45Z

CI report:

abcd6ad Azure: SUCCESS
5ee687b Azure: PENDING

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

wuchong · 2020-10-23T08:39:36Z

I have rebased the branch to resolve conflicts. Appreciate if you can have a look @leonardBang .

leonardBang

Thanks @wuchong for the contribution, I left some comments

leonardBang · 2020-10-24T04:52:03Z

.../org/apache/flink/table/planner/plan/nodes/physical/stream/StreamExecUpsertMaterialize.scala

+import scala.collection.JavaConversions._
+
+/**
+ * Stream physical RelNode which materializes an upsert stream where where each data record


Suggested change

* Stream physical RelNode which materializes an upsert stream where where each data record

* Stream physical RelNode which materializes an upsert stream where each record

leonardBang · 2020-10-24T04:53:33Z

.../org/apache/flink/table/planner/plan/nodes/physical/stream/StreamExecUpsertMaterialize.scala

+        false,  // inputInsertOnly
+        rowSerializer,
+        // disable state ttl, the upsert materialize should keep all state to have data integrity
+        // we can enable state ttl if this is really needed in some cases


Looks like this conflicts with global TTL setting? I understand the motivation, but it may confuse user.

leonardBang · 2020-10-24T04:56:29Z

...anner-blink/src/test/scala/org/apache/flink/table/planner/plan/batch/sql/TableScanTest.scala

+        |)
+      """.stripMargin)
+    thrown.expect(classOf[UnsupportedOperationException])
+    thrown.expectMessage(


The test failed, please update the exception message.

leonardBang · 2020-10-24T05:05:24Z

.../src/test/resources/org/apache/flink/table/planner/plan/stream/sql/join/SemiAntiJoinTest.xml

@@ -307,7 +307,7 @@ Join(joinType=[LeftSemiJoin], where=[$f0], select=[a, b, c], leftInputSpec=[NoUn
 :  +- LegacyTableSourceScan(table=[[default_catalog, default_database, l, source: [TestTableSource(a, b, c)]]], fields=[a, b, c])
 +- Exchange(distribution=[single])
   +- Calc(select=[IS NOT NULL(m) AS $f0])
-      +- GroupAggregate(select=[MIN(i) AS m])
+      +- GroupAggregate(select=[MIN_RETRACT(i) AS m])


Why the function change for existed test?

This is a bug in previous FlinkRelMdModifiedMonotonicity, the need retraction inference was not correct.

godfreyhe

Thanks for the contribution @wuchong , I left a few comments

godfreyhe · 2020-10-25T14:52:08Z

...e-planner-blink/src/main/java/org/apache/flink/table/planner/sources/DynamicSourceUtils.java

+			if (!schema.getPrimaryKey().isPresent()) {
+				throw new TableException(
+					String.format(
+						"Table '%s' produces a changelog stream contains UPDATE_AFTER no UPDATE_BEFORE, " +


which contains only UPDATE_AFTER, no UPDATE_BEFORE. ?

godfreyhe · 2020-10-25T15:01:16Z

...rg/apache/flink/table/planner/plan/rules/physical/stream/StreamExecTableSourceScanRule.scala

+        .replace(FlinkConventions.STREAM_PHYSICAL)
+      val newInput: RelNode = RelOptRule.convert(newScan, requiredTraitSet)
+
+      new StreamExecUpsertMaterialize(


If the primary key fields are not required, we should add a Calc here to reduce output fields.

Why we have to add a Calc here? The transformed tree has the same output row type with the original Scan node. If the primary key fields are never used in the following nodes, there should already be a Calc after the Scan node. So I think we shouldn't add a Calc.

godfreyhe · 2020-10-25T15:06:35Z

...er-blink/src/test/resources/org/apache/flink/table/planner/plan/stream/sql/TableScanTest.xml

+   :  +- Calc(select=[amount, currency, PROCTIME() AS proctime], changelogMode=[I])
+   :     +- TableSourceScan(table=[[default_catalog, default_database, orders]], fields=[amount, currency], changelogMode=[I])
+   +- Exchange(distribution=[hash[currency]], changelogMode=[I,UB,UA,D])
+      +- UpsertMaterialize(key=[currency], changelogMode=[I,UB,UA,D])


does UpsertMaterialize produce UB message ?

It depends on whether the following nodes requires UB messages.
In this case, the temporal join currently always root requires UB, therefore UpsertMaterialize has to emit `UB.

godfreyhe · 2020-10-25T15:09:22Z

...src/main/scala/org/apache/flink/table/planner/plan/metadata/FlinkRelMdColumnUniqueness.scala

+      mq: RelMetadataQuery,
+      columns: ImmutableBitSet,
+      ignoreNulls: Boolean): JBoolean = {
+    columns != null && util.Arrays.equals(columns.toArray, rel.uniqueKeys)


is the values of rel.uniqueKeys in order ?

Good point!

wuchong · 2020-10-26T06:15:03Z

After discussing with @leonardBang , I renamed UpsertMaterialize into ChangelogNormalize. Because this can be more general purpose and can be used for cdc source to drop duplications in the future.

wuchong · 2020-10-27T02:53:11Z

Hi @godfreyhe , I have added the plan test as we discussed offline, and I did find a bug. Appreciate if you can have another look .

leonardBang

Thanks @wuchong for the update, LGTM +1

wuchong · 2020-10-27T07:11:05Z

Build is passed in my own Azure build: https://dev.azure.com/imjark/Flink/_build/results?buildId=308&view=results

godfreyhe

LGTM overall, I left a few minor comments

godfreyhe · 2020-10-27T09:04:51Z

...k/src/test/scala/org/apache/flink/table/planner/plan/metadata/FlinkRelMdUniqueKeysTest.scala

+  }
+
+  @Test
+  def testGetUniqueKeysOnStreamExecUpsertMaterialize(): Unit = {


rename to testGetUniqueKeysOnStreamExecChangelogNormalize

godfreyhe · 2020-10-27T09:05:24Z

.../src/test/scala/org/apache/flink/table/planner/plan/metadata/FlinkRelMdHandlerTestBase.scala

@@ -691,6 +691,18 @@ class FlinkRelMdHandlerTestBase {
    (calcOfFirstRow, calcOfLastRow)
  }

+  protected lazy val streamUpsertMaterialize = {


rename to streamChangelogNormalize

godfreyhe · 2020-10-27T09:06:28Z

.../scala/org/apache/flink/table/planner/plan/metadata/FlinkRelMdModifiedMonotonicityTest.scala

+  }
+
+  @Test
+  def testGetRelMonotonicityOnUpsertMaterialize(): Unit = {


rename to testGetRelMonotonicityOnChangelogNormalize

godfreyhe · 2020-10-27T09:07:58Z

...test/scala/org/apache/flink/table/planner/plan/metadata/FlinkRelMdColumnUniquenessTest.scala

@@ -275,6 +275,15 @@ class FlinkRelMdColumnUniquenessTest extends FlinkRelMdHandlerTestBase {
    assertFalse(mq.areColumnsUnique(streamDeduplicateLastRow, ImmutableBitSet.of(0, 1, 2)))
  }

+  @Test
+  def testAreColumnsUniqueCountOnStreamExecUpsertMaterialize(): Unit = {


rename to testAreColumnsUniqueCountOnStreamExecChangelogNormalize

godfreyhe · 2020-10-27T09:11:51Z

...nner-blink/src/test/scala/org/apache/flink/table/planner/runtime/stream/sql/JoinITCase.scala

@@ -1140,48 +1140,4 @@ class JoinITCase(state: StateBackendMode) extends StreamingWithStateTestBase(sta
    val expected = Seq("Hi,Hallo", "Hello,Hallo Welt", "Hello world,Hallo Welt")
    assertEquals(expected.sorted, sink.getRetractResults.sorted)
  }
-
-  @Test
-  def testJoinOnChangelogSource(): Unit = {


why this test is removed ?

This has been moved to ChangelogSourceITCase#testRegularJoin to reuse the tests.

…canTableSource in planner This closes apache#13721

…w introduced StreamExecUpsertMaterialize node This closes apache#13721

…canTableSource in runtime This closes apache#13721

wuchong · 2020-10-27T09:38:08Z

Thanks for the reviewing @godfreyhe . I have rebased and squashed the commits and hope I have addressed all the comments.

Will merge this pull request once build passed.

wuchong · 2020-10-27T14:11:37Z

Build has been passed:
https://dev.azure.com/apache-flink/apache-flink/_build/results?buildId=8389&view=results
https://dev.azure.com/imjark/Flink/_build/results?buildId=312&view=results

…canTableSource in planner This closes #13721

…w introduced StreamExecUpsertMaterialize node This closes #13721

rmetzger added the review=description? label Oct 21, 2020

rmetzger added component=TableSQL/Planner component=TableSQL/API labels Oct 21, 2020

wuchong force-pushed the upsert-mode branch 3 times, most recently from d5e77b2 to b03cd2b Compare October 23, 2020 08:39

leonardBang reviewed Oct 24, 2020

View reviewed changes

godfreyhe reviewed Oct 25, 2020

View reviewed changes

leonardBang approved these changes Oct 27, 2020

View reviewed changes

godfreyhe reviewed Oct 27, 2020

View reviewed changes

wuchong added 3 commits October 27, 2020 17:36

[FLINK-19694][table-planner-blink] Support upsert ChangelogMode for S…

1d2af46

…canTableSource in planner This closes apache#13721

[FLINK-19694][table-planner-blink] Update MetadataHandlers for the ne…

f5eb931

…w introduced StreamExecUpsertMaterialize node This closes apache#13721

[FLINK-19694][table-runtime-blink] Support upsert ChangelogMode for S…

5ee687b

…canTableSource in runtime This closes apache#13721

wuchong force-pushed the upsert-mode branch from abcd6ad to 5ee687b Compare October 27, 2020 09:37

wuchong merged commit 436a4c2 into apache:master Oct 27, 2020

wuchong added a commit that referenced this pull request Oct 27, 2020

[FLINK-19694][table-planner-blink] Support upsert ChangelogMode for S…

3c67cce

…canTableSource in planner This closes #13721

wuchong added a commit that referenced this pull request Oct 27, 2020

[FLINK-19694][table-planner-blink] Update MetadataHandlers for the ne…

92a2648

…w introduced StreamExecUpsertMaterialize node This closes #13721

wuchong deleted the upsert-mode branch October 27, 2020 14:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-19694][table] Support Upsert ChangelogMode for ScanTableSource #13721

[FLINK-19694][table] Support Upsert ChangelogMode for ScanTableSource #13721

wuchong commented Oct 21, 2020

wuchong commented Oct 21, 2020

flinkbot commented Oct 21, 2020

flinkbot commented Oct 21, 2020 •

edited

wuchong commented Oct 23, 2020

leonardBang left a comment

leonardBang Oct 24, 2020

leonardBang Oct 24, 2020

leonardBang Oct 24, 2020

leonardBang Oct 24, 2020

wuchong Oct 26, 2020

godfreyhe left a comment

godfreyhe Oct 25, 2020

godfreyhe Oct 25, 2020

wuchong Oct 26, 2020

godfreyhe Oct 25, 2020

wuchong Oct 26, 2020

godfreyhe Oct 25, 2020

wuchong Oct 26, 2020

wuchong commented Oct 26, 2020

wuchong commented Oct 27, 2020

leonardBang left a comment

wuchong commented Oct 27, 2020

godfreyhe left a comment

godfreyhe Oct 27, 2020

godfreyhe Oct 27, 2020

godfreyhe Oct 27, 2020

godfreyhe Oct 27, 2020

godfreyhe Oct 27, 2020

wuchong Oct 27, 2020

wuchong commented Oct 27, 2020

wuchong commented Oct 27, 2020

	* Stream physical RelNode which materializes an upsert stream where where each data record
	* Stream physical RelNode which materializes an upsert stream where each record

[FLINK-19694][table] Support Upsert ChangelogMode for ScanTableSource #13721

[FLINK-19694][table] Support Upsert ChangelogMode for ScanTableSource #13721

Conversation

wuchong commented Oct 21, 2020

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

wuchong commented Oct 21, 2020

flinkbot commented Oct 21, 2020

Automated Checks

Review Progress

flinkbot commented Oct 21, 2020 • edited

CI report:

wuchong commented Oct 23, 2020

leonardBang left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

godfreyhe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wuchong commented Oct 26, 2020

wuchong commented Oct 27, 2020

leonardBang left a comment

Choose a reason for hiding this comment

wuchong commented Oct 27, 2020

godfreyhe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wuchong commented Oct 27, 2020

wuchong commented Oct 27, 2020

flinkbot commented Oct 21, 2020 •

edited