LadyForest commented on code in PR #21877:
URL: https://github.com/apache/flink/pull/21877#discussion_r1098384346
##########
docs/content.zh/docs/dev/table/sql-gateway/rest.md:
##########
@@ -94,7 +94,12 @@ Endpoint Options
REST API
----------------
-[OpenAPI specification]({{< ref_static "generated/rest_v1_sql_gateway.yml" >}})
+The available OpenAPI specification as follows. The default version is v2.
Review Comment:
Do you have any plans to translate the doc?
##########
docs/content/docs/dev/table/sqlClient.md:
##########
@@ -44,7 +44,10 @@ The SQL Client is bundled in the regular Flink distribution
and thus runnable ou
```
### Starting the SQL Client CLI
-The SQL Client scripts are also located in the binary directory of Flink. [In
the future](#limitations--future), a user will have two possibilities of
starting the SQL Client CLI either by starting an embedded standalone process
or by connecting to a remote SQL Client Gateway. At the moment only the
`embedded` mode is supported, and default mode is `embedded`. You can start the
CLI by calling:
+The SQL Client scripts are also located in the binary directory of Flink. A
user has two possibilities of starting the SQL Client CLI either by starting an
embedded standalone process or by connecting to a remote [SQL Gateway]({{< ref
"docs/dev/table/sql-gateway/overview" >}}).
Review Comment:
```suggestion
The SQL Client scripts are also located in the binary directory of Flink.
Users have two options for starting the SQL Client CLI, either by starting an
embedded standalone process or by connecting to a remote [SQL Gateway]({{< ref
"docs/dev/table/sql-gateway/overview" >}}).
```
##########
docs/content.zh/docs/dev/table/sqlClient.md:
##########
@@ -59,6 +59,17 @@ SQL Client 脚本也位于 Flink 的 bin 目录中。[将来](#局限与未来)
./bin/sql-client.sh embedded
```
+若想使用 gateway 模式，你可以通过一下命令启动 SQL 客户端：
Review Comment:
一下 => 以下
##########
docs/content/docs/dev/table/sql-gateway/rest.md:
##########
@@ -94,7 +94,12 @@ Endpoint Options
REST API
----------------
-[OpenAPI specification]({{< ref_static "generated/rest_v1_sql_gateway.yml" >}})
+The available OpenAPI specification as follows. The default version is v2.
Review Comment:
Nit: The available OpenAPI specification is as follows.
##########
docs/content/docs/dev/table/sqlClient.md:
##########
@@ -54,8 +57,18 @@ or explicitly use `embedded` mode:
```bash
./bin/sql-client.sh embedded
+```
+
+For gateway mode, you can start the CLI by calling:
+
+```bash
+./bin/sql-client.sh gateway --endpoint <gateway address>
```
+In the gateway mode, the CLI submits the SQL to the specified remote gateway
to execute statements.
+
+<span class="label label-danger">Note</span> SQL Client only supports to
connect to the [REST Endpoint]({{< ref "docs/dev/table/sql-gateway/rest"
>}}#rest-api) whose version is larger than v1.
Review Comment:
```suggestion
<span class="label label-danger">Note</span> SQL Client only supports
connecting to the [REST Endpoint]({{< ref "docs/dev/table/sql-gateway/rest"
>}}#rest-api) since version v2.
```
--
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]
