[FLINK-37536] [TABLE-SQL] Improve SQL Gateway documentation #26378
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
davidradl
reviewed
Mar 31, 2025
| @@ -84,6 +84,14 @@ $ curl --request POST http://localhost:8083/v1/sessions/${sessionHandle}/stateme | |||
|
|
|||
| The `operationHandle` in the return results is used by the SQL Gateway to uniquely identify the submitted SQL. | |||
|
|
|||
| The Flink SQL Gateway allows clients to specify which Flink cluster to submit jobs to, enabling remote execution of SQL statements and facilitating easier interaction with Flink clusters through a REST API. Enrich the POST request body with `executionConfig` variable to set the Flink cluster address. For example: | |||
There was a problem hiding this comment.
Is the executionConfig this if so shouldn't this parameter be documented there? Can the other parts of the executionConfig be specified on the rest call? Or is this a different executionConfig? We should document what the defaults are for the ExecutionContext and its parameters?
Also we should mention in the text why/when you would want to specify a non-default jm endpoint for the gateway.
I think the parameters in the example should be parameterized i.e. {port} and then explain what port is. As is I support port will fail as it is not a number.
@ammu20-dev
davidradl
reviewed
Mar 31, 2025
| You can also override the default job manager configuration in SQL client by explicitly providing the cluster address while initialising the client as below: | ||
|
|
||
| ```bash | ||
| ./bin/sql-client.sh gateway --endpoint <gateway address> -Drest.address=<flink cluster host> -Drest.port=<port> |
There was a problem hiding this comment.
This does not look very consistent.
- endpoint . - I assume this will include the port so it should be
- then the other endpoint for the JM is defined as an address and a port.
Is this an opportunity to make them more consistent?
davidradl
suggested changes
Mar 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What is the purpose of the change
This pull request if for improving the SQL gateway documentation
Brief change log
Updated the doc with details on submitting a job via gateway to a remote host.
Verifying this change
Please make sure both new and modified tests in this PR follow the conventions for tests defined in our code quality guide.
(Please pick either of the following options)
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
@Public(Evolving): (yes / no) - noDocumentation