infoverload commented on a change in pull request #18812:
URL: https://github.com/apache/flink/pull/18812#discussion_r809822569
##########
File path: docs/content/docs/dev/configuration/advanced.md
##########
@@ -102,20 +97,28 @@ For more details, check out how to [connect to external
systems]({{< ref "docs/c
Starting from Flink 1.15, the distribution contains two planners:
--`flink-table-planner{{< scala_version >}}-{{< version >}}.jar`, in `/opt`,
contains the query planner
--`flink-table-planner-loader-{{< version >}}.jar`, loaded by default in
`/lib`, contains the query planner
+- `flink-table-planner{{< scala_version >}}-{{< version >}}.jar`, in `/opt`,
contains the query planner
+- `flink-table-planner-loader-{{< version >}}.jar`, loaded by default in
`/lib`, contains the query planner
hidden behind an isolated classpath (you won't be able to address any
`io.apache.flink.table.planner` directly)
-The planners contain the same code, but they are packaged differently. In one
case, you must use the
+The two planner JARs contain the same code, but they are packaged differently.
In one case, you must use the
same Scala version of the JAR. In the other, you do not need to make
considerations about Scala, since
it is hidden inside the JAR.
-If you need to access and use the internals of the query planner, you can swap
the JARs (copying and
-pasting them in the downloaded distribution). Be aware that you will be
constrained to using the Scala
-version of the Flink distribution that you are using.
+By default,`flink-table-planner-loader` is used by the distribution. If you
need to access and use the internals of the query planner,
+you can swap the JARs (copying and pasting `flink-table-planner{{<
scala_version >}}.jar` in the distribution `/lib` folder).
+Be aware that you will be constrained to using the Scala version of the Flink
distribution that you are using.
-**Note:** The two planners cannot co-exist at the same time in the classpath.
If you load both of them
+{{< hint danger >}}
+The two planners cannot co-exist at the same time in the classpath. If you
load both of them
in `/lib` your Table Jobs will fail.
+{{< /hint >}}
+
+{{< hint warning >}}
+In the next Flink versions we will stop shipping the `flink-table-planner{{<
scala_version >}}` artifact in the Flink distribution.
+We strongly suggest migrating your jobs and your custom connector/formats to
work with the api modules, without relying on planner internals.
+If you need some functionality from the planner, which is currently not
exposed through the api modules, please open a ticket in order to discuss it
with the community.
Review comment:
```suggestion
In the upcoming Flink versions, we will stop shipping the
`flink-table-planner{{< scala_version >}}` artifact in the Flink distribution.
We strongly suggest migrating your jobs and your custom connectors/formats
to work with the API modules, without relying on planner internals.
If you need some functionality from the planner, which is currently not
exposed through the API modules, please open a ticket in order to discuss it
with the community.
```
--
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]