Ammu Parvathy created FLINK-37536:
-------------------------------------
Summary: Improve SQL gateway documentation
Key: FLINK-37536
URL: https://issues.apache.org/jira/browse/FLINK-37536
Project: Flink
Issue Type: Improvement
Components: Documentation
Reporter: Ammu Parvathy
The documentation around SQL gateway usage is currently limited to local
environment and lacking the necessary steps on how to establish communication
to a remote Flink environment.
* The SQL gateway enables clients to specify which cluster to submit the jobs
to. For example
[https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/deployment/config/#hosts-and-ports]
mentions about a rest.address variable which is the address that should be
used by clients to establish such communication. But this is nowhere mentioned
in the gateway documentation.
* POST request body in this
[request|https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/sql-gateway/rest/#sessions-session_handle-statements-2]
mentions about an executionConfig param which is one way to configure the
gateway to communicate to the desired job manager. I think it is good to
capture the importance of this parameter and how it can be used to achieve the
same.
* This
[documentation|https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/sqlclient/#starting-the-sql-client-cli]
in SQL Client mentions about SQL Client startup in embedded mode as well as
gateway mode. Here also it is important to mention about the client
configuration for remote communication using the gateway.
* Noticed a small mistake
[here|https://nightlies.apache.org/flink/flink-docs-master/docs/dev/table/sql-gateway/overview/#getting-started]
in this line: If you simply want to try out the {color:#FF0000}SQL
Client{color}, you can also start a local cluster with one worker using the
following command. Instead of {color:#FF0000}SQL Client{color}, it should be
SQL Gateway.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
