[FLINK-24427] Hide Scala in flink-table-planner from API

• Type: Technical Debt
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Fix Version/s: 1.15.0
• Component/s: API / Scala, Table SQL / API, Table SQL / Planner

Release Note

The new module flink-table-planner-loader replaces flink-table-planner_2.12 and avoids the need for a Scala suffix. It is included in the Flink distribution under /lib. For backwards compatibility, users can still swap it with flink-table-planner_2.12 located in /opt. As a consequence, flink-table-uber has been split into flink-table-api-java-uber, flink-table-planner(-loader), and table-runtime. flink-sql-client has no Scala suffix anymore.

It is recommended to let new projects depend on flink-table-planner-loader (without Scala suffix) in provided scope.

Note that the distribution does not include the Scala API by default. Scala users need to explicitly add a dependency to flink-table-api-scala or flink-table-api-scala-bridge.

• Assignee: Francesco Guardiani
• Reporter: Timo Walther
• Created: 30/Sep/21 10:47
• Updated: 08/Feb/22 13:31
• Resolved: 08/Feb/22 13:31

Description

FLIP-32 has decoupled the planner from the API. However, the planner code base is still the largest Scala code base we have in Flink that we cannot port to Java easily.

In order to allow arbitrary Scala versions in the user API, we suggest to hide the Scala version of the planner from the Scala version of the API. The API is mostly developed in Java and contains only a couple of classes implemented in Scala. Those should be easier to maintain for various Scala versions. The planner is already discovered via Java SPI.

Issue Links

• is blocked by: FLINK-25228 Introduce flink-table-test-utils
• relates to: FLINK-23986 Add support for opting-out of Scala
• relates to: FLINK-25229 Introduce flink-table-api-bridge-base

Sub-Tasks

• Remove reflection to instantiate PlannerExpressionParser: Closed
• Remove flink-scala dependency from flink-table-runtime: Closed
• Move runtime dependencies from table-planner to table-runtime: Closed
• Replace LogicalWindow and related planner expressions: Closed
• Don't generate code in open() methods of Python operators: Closed
• Remove remaining references to planner from Python: Closed
• Reorganize table modules and introduce flink-table-planner-loader: Closed
• Update flink-table-uber to ship flink-table-planner-loader instead of flink-table-planner: Closed
• Update sql client to ship flink-table-planner-loader instead of flink-table-planner: Closed
• Improve exception when flink-table-runtime is not in classpath: Closed
• flink-examples-table is not runnable in the IDE: Closed
• Update docs to use flink-table-planner-loader instead of flink-table-planner: Closed