[FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types #18135

matriv · 2021-12-16T15:30:59Z

What is the purpose of the change

Fix precision for agg functions on decimal types.

Brief change log

Small code optimisations for aggregate functions
Fix existing test for SumWithRetractAggFunction which didn't actually use it but instead used the normal SumAggFunction.
Since Sum0AggFunction,SumWithRetractAggFunction and AvgAggFunction are using internally plus() and minus() operators to implement the sum and avg aggregation (minus() is used also for the WithRetract), the decimal return type calculated by LogicalTypeMerging#findSumAggType() (also for the AvgAggFunctions internal SumType) gets overriden by the calculation for the plus() (and/or minus()) operator done by LogicalTypeMerging#findAdditionDecimalType(). To prevent this add a special aggDecimalMinus() operator and use it together with the previously added aggDecimalPlus() in those aggregate functions to avoid overriding the calculated precision of their decimal return type.

Verifying this change

This change added tests and can be verified as follows:

Added tests to AggregateITCase.scala both for SQL and TableApi.

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

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

Documentation

Does this pull request introduce a new feature? no
If yes, how is the feature documented? not applicable

flinkbot · 2021-12-16T15:35:15Z

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 6dcc619 (Thu Dec 16 15:35:15 UTC 2021)

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 · 2021-12-16T15:35:52Z

CI report:

ea55785 Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run azure re-run the last Azure build

twalthr

Thanks for the PR @matriv. I had only minor comments. Should be good in the next iteration.

twalthr · 2021-12-20T09:52:15Z

...-table-common/src/main/java/org/apache/flink/table/functions/BuiltInFunctionDefinitions.java

-     * on a Decimal type. Uses the {@link LogicalTypeMerging#findSumAggType(LogicalType)} to avoid
-     * the normal {@link #PLUS} override the special calculation for precision and scale needed by
-     * SUM.
+     * Special "+" operator used internally by {@code SumAggFunction}, {@code Sum0AggFunction},


remove IncrSumAggFunction. how about we keep this section a bit more generic to not update it whenever we update the implementation? maybe just used internally by for implementing SUM/AVG aggregations (with and without retractions)

twalthr · 2021-12-20T10:32:42Z

...nner/src/main/java/org/apache/flink/table/planner/functions/aggfunctions/AvgAggFunction.java

        return ifThenElse(equalTo(count, literal(0L)), ifTrue, ifFalse);
    }

+    protected UnresolvedCallExpression doPlus(


doPlus sounds a bit generic, how about specializedPlus or adjustedPlus?

twalthr · 2021-12-20T10:44:08Z

...anner/src/test/scala/org/apache/flink/table/planner/runtime/stream/sql/AggregateITCase.scala

+    tEnv.sqlQuery(sql).toRetractStream[Row].addSink(sink)
+    env.execute()
+
+    val expected = List("6.41671935,65947.23071935707000000000,609.02867403703699700000")


can you add a comment to explain the result? for me as a reviewer that is not super familiar with the topic anymore, it is difficult to see something in those numbers

twalthr · 2021-12-20T11:04:19Z

Btw the issue number is incorrect for both the PR and commit

matriv · 2021-12-20T11:56:55Z

Btw the issue number is incorrect for both the PR and commit

Thx, fixing.

matriv · 2021-12-20T15:22:05Z

@cshuo @JingsongLi Could you please also take a look at this one?

matriv · 2021-12-21T09:09:29Z

@flinkbot run azure

JingsongLi

Thanks! Looks good to me overall. Left minor comments.

JingsongLi · 2021-12-22T03:45:35Z

...anner/src/test/scala/org/apache/flink/table/planner/runtime/stream/sql/AggregateITCase.scala

+      changelogRow("+I", Byte.box(3), Short.box(3), Int.box(3), Long.box(3),
+        Float.box(3.0F), Double.box(3.0), "a"))
+
+    val upsertSourceDataId = registerData(upsertSourceCurrencyData);


minor: remove ";"

JingsongLi · 2021-12-22T03:47:31Z

...in/java/org/apache/flink/table/planner/functions/aggfunctions/SumWithRetractAggFunction.java

            return literal(0);
        }
+
+        protected UnresolvedCallExpression adjustedPlus(


JingsongLi · 2021-12-22T03:47:36Z

...in/java/org/apache/flink/table/planner/functions/aggfunctions/SumWithRetractAggFunction.java

+            return aggDecimalPlus(arg1, arg2);
+        }
+
+        protected UnresolvedCallExpression adjustedMinus(


twalthr · 2021-12-22T15:11:45Z

@flinkbot run azure

Apply some small code optimisations for the build-in aggregate functions.

Use `TestValuesTableFactory` to setup the source changelog stream any make sure that the SQL query will generate `SumWithRetractAggFunction` to implement sum aggregations.

…DECIMAL types Since `Sum0AggFunction`,`SumWithRetractAggFunction` and `AvgAggFunction` are using internally `plus()` and `minus()` operators to implement the sum and avg aggregation (`minus()` is used also for the `WithRetract`), the decimal return type calculated by `LogicalTypeMerging#findSumAggType()` (also for the `AvgAggFunction`s internal `SumType`) gets overriden by the calculation for the `plus()` (and/or `minus()`) operator done by `LogicalTypeMerging#findAdditionDecimalType()`. To prevent this add a special `aggDecimalMinus()` operator and use it together with the previously added `aggDecimalPlus()` in those aggregate functions to avoid overriding the calculated precision of their decimal return type. Follows: apache#17634

…DECIMAL types Since `Sum0AggFunction`,`SumWithRetractAggFunction` and `AvgAggFunction` are using internally `plus()` and `minus()` operators to implement the sum and avg aggregation (`minus()` is used also for the `WithRetract`), the decimal return type calculated by `LogicalTypeMerging#findSumAggType()` (also for the `AvgAggFunction`s internal `SumType`) gets overriden by the calculation for the `plus()` (and/or `minus()`) operator done by `LogicalTypeMerging#findAdditionDecimalType()`. To prevent this add a special `aggDecimalMinus()` operator and use it together with the previously added `aggDecimalPlus()` in those aggregate functions to avoid overriding the calculated precision of their decimal return type. See also FLINK-24691. This closes apache#18135.

rmetzger added the component=TableSQL/Planner label Dec 16, 2021

matriv force-pushed the FLINK-25304 branch from 0a7a78b to a78956c Compare December 17, 2021 14:53

twalthr requested changes Dec 20, 2021

View reviewed changes

matriv changed the title ~~[FLINK-25304][table-common][table-planner] Fix precision for aggs on DECIMAL types~~ [FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types Dec 20, 2021

matriv force-pushed the FLINK-25304 branch from a78956c to e4a9ca3 Compare December 20, 2021 15:14

matriv requested a review from twalthr December 20, 2021 15:14

matriv force-pushed the FLINK-25304 branch from e4a9ca3 to 4ace2eb Compare December 20, 2021 18:32

JingsongLi reviewed Dec 22, 2021

View reviewed changes

matriv force-pushed the FLINK-25304 branch 2 times, most recently from 7f37df4 to dee9315 Compare December 27, 2021 10:07

matriv added 3 commits December 28, 2021 11:42

[hotfix][table-planner] Code fixes for Aggregate Functions

c49e1f1

Apply some small code optimisations for the build-in aggregate functions.

[hotfix][table-planner][tests] Fix test for SumWithRetractAgg

6d3a317

Use `TestValuesTableFactory` to setup the source changelog stream any make sure that the SQL query will generate `SumWithRetractAggFunction` to implement sum aggregations.

matriv force-pushed the FLINK-25304 branch from dee9315 to ea55785 Compare December 28, 2021 09:42

twalthr closed this in ec893d2 Dec 30, 2021

matriv deleted the FLINK-25304 branch January 17, 2022 08:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types #18135

[FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types #18135

Uh oh!

matriv commented Dec 16, 2021 •

edited

Loading

Uh oh!

flinkbot commented Dec 16, 2021

Uh oh!

flinkbot commented Dec 16, 2021 •

edited

Loading

Uh oh!

twalthr left a comment

Uh oh!

twalthr Dec 20, 2021

Uh oh!

twalthr Dec 20, 2021

Uh oh!

twalthr Dec 20, 2021

Uh oh!

twalthr commented Dec 20, 2021

Uh oh!

matriv commented Dec 20, 2021

Uh oh!

matriv commented Dec 20, 2021

Uh oh!

matriv commented Dec 21, 2021

Uh oh!

JingsongLi left a comment

Uh oh!

JingsongLi Dec 22, 2021

Uh oh!

JingsongLi Dec 22, 2021

Uh oh!

JingsongLi Dec 22, 2021

Uh oh!

twalthr commented Dec 22, 2021

Uh oh!

Uh oh!

[FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types #18135

[FLINK-24809][table-common][table-planner] Fix precision for aggs on DECIMAL types #18135

Uh oh!

Conversation

matriv commented Dec 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

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

Uh oh!

flinkbot commented Dec 16, 2021

Automated Checks

Review Progress

Uh oh!

flinkbot commented Dec 16, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CI report:

Uh oh!

twalthr left a comment

Choose a reason for hiding this comment

Uh oh!

twalthr Dec 20, 2021

Choose a reason for hiding this comment

Uh oh!

twalthr Dec 20, 2021

Choose a reason for hiding this comment

Uh oh!

twalthr Dec 20, 2021

Choose a reason for hiding this comment

Uh oh!

twalthr commented Dec 20, 2021

Uh oh!

matriv commented Dec 20, 2021

Uh oh!

matriv commented Dec 20, 2021

Uh oh!

matriv commented Dec 21, 2021

Uh oh!

JingsongLi left a comment

Choose a reason for hiding this comment

Uh oh!

JingsongLi Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

JingsongLi Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

JingsongLi Dec 22, 2021

Choose a reason for hiding this comment

Uh oh!

twalthr commented Dec 22, 2021

Uh oh!

Uh oh!

matriv commented Dec 16, 2021 •

edited

Loading

flinkbot commented Dec 16, 2021 •

edited

Loading