[FLINK-36761][docs] Add document about how to use SQL Gateway and SQL Client to deploy script #25784
+3,058
−23
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
…n application mode
… Client to dpeloy script
davidradl
reviewed
Dec 12, 2024
| @@ -116,6 +116,34 @@ $ curl --request GET http://localhost:8083/v1/sessions/${sessionHandle}/operatio | |||
|
|
|||
| 结果中的 `nextResultUri` 不是null时，用于获取下一批结果。 | |||
|
|
|||
| ### Deploy Script | |||
|
|
|||
| SQL Gateway supports to deploy a script in [Application Mode]({{< ref "docs/deployment/overview" >}}). In application mode, Job Master is responsible for the script compiling. | |||
There was a problem hiding this comment.
nit: to deploy -> deploying
what do we mean by Job Master, we should have a link - do you mean the JobManager?
the script compiling. -> compiling the script.
davidradl
reviewed
Dec 12, 2024
| ### Deploy Script | ||
|
|
||
| SQL Gateway supports to deploy a script in [Application Mode]({{< ref "docs/deployment/overview" >}}). In application mode, Job Master is responsible for the script compiling. | ||
| If you want to use custom resources in the script, e.g. Kafka Source, please use [ADD JAR]({{< ref "docs/dev/table/sql/jar">}}) command to download the required sources. |
There was a problem hiding this comment.
does this download or reference a downloaded jar?
davidradl
reviewed
Dec 12, 2024
| SQL Gateway supports to deploy a script in [Application Mode]({{< ref "docs/deployment/overview" >}}). In application mode, Job Master is responsible for the script compiling. | ||
| If you want to use custom resources in the script, e.g. Kafka Source, please use [ADD JAR]({{< ref "docs/dev/table/sql/jar">}}) command to download the required sources. | ||
|
|
||
| Here is an example to deploy script to Flink native K8S Cluster with cluster id `CLUSTER_ID`. |
There was a problem hiding this comment.
nit:
deploy script -> deploy a script
to Flink native -> to a Flink native
davidradl
reviewed
Dec 12, 2024
| }' | ||
| ``` | ||
|
|
||
| <span class="label label-info">Note</span> If you want to run script with PyFlink, please use an image with PyFlink installed. You can refer to |
There was a problem hiding this comment.
nit:
run script -> run the script
davidradl
reviewed
Dec 12, 2024
| @@ -663,6 +663,24 @@ This configuration: | |||
|
|
|||
| <span class="label label-danger">Attention</span> Compared to the interactive mode, SQL Client will stop execution and exits when there are errors. | |||
|
|
|||
| ### Deploy SQL Files in an Application Cluster | |||
|
|
|||
| SQL Client also supports to deploy a SQL script file to an application cluster with the `-f` option if you specify the deployment target in the config.yaml or startup options. | |||
There was a problem hiding this comment.
nit:
to deploy => deploying
comma before if
davidradl
reviewed
Dec 12, 2024
| @@ -610,7 +610,7 @@ SQL Client will print success message if the statement is executed successfully. | |||
| By default, the error message only contains the error cause. In order to print the full exception stack for debugging, please set the | |||
| `sql-client.verbose` to true through command `SET 'sql-client.verbose' = 'true';`. | |||
|
|
|||
| ### Execute SQL Files | |||
| ### Execute SQL Files in a Session Cluster | |||
|
|
|||
| SQL Client supports to execute a SQL script file with the `-f` option. SQL Client will execute | |||
There was a problem hiding this comment.
nit:
to execute - > executing
davidradl
reviewed
Dec 12, 2024
| ### Deploy SQL Files in an Application Cluster | ||
|
|
||
| SQL Client also supports to deploy a SQL script file to an application cluster with the `-f` option if you specify the deployment target in the config.yaml or startup options. | ||
| Here is an example to deploy script file in an application cluster. |
There was a problem hiding this comment.
nit:
to deploy - deploying
comma before if
Application Cluster is sometimes capitalised and sometimes not - I suggest using the capitalised form consistently
davidradl
reviewed
Dec 12, 2024
| After execution, SQL Client print the cluster id on the terminal. The script can contain any statement that is supported by Flink. But Application cluster only supports one job, please refer to the | ||
| [Application Mode]({{< ref "docs/deployment/overview#application-mode" >}}) for the limitations. | ||
|
|
||
| <span class="label label-danger">Attention</span> When deploying a script to the cluster, SQL Client only supports to run with `--jars` startup option, other options, e.g. `--init` |
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
Add document about how to use sql client and sql gateway to deploy script.