This is an automated email from the ASF dual-hosted git repository. knaufk pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push: new 538b5d4 [hotfix][sqlclient][docs] Improved sql client docs (#18855) 538b5d4 is described below commit 538b5d4567976f8744e6155942697ebb37709da7 Author: mans2singh <mans2si...@users.noreply.github.com> AuthorDate: Sun Feb 27 13:48:39 2022 -0500 [hotfix][sqlclient][docs] Improved sql client docs (#18855) --- docs/content.zh/docs/dev/table/sqlClient.md | 12 ++++++------ docs/content/docs/dev/table/sqlClient.md | 12 ++++++------ 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/content.zh/docs/dev/table/sqlClient.md b/docs/content.zh/docs/dev/table/sqlClient.md index 4f5bf76..2239121 100644 --- a/docs/content.zh/docs/dev/table/sqlClient.md +++ b/docs/content.zh/docs/dev/table/sqlClient.md @@ -364,7 +364,7 @@ When using `-i <init.sql>` option to initialize SQL Client session, the followin When execute queries or insert statements, please enter the interactive mode or use the -f option to submit the SQL statements. -<span class="label label-danger">Attention</span> If SQL Client meets errors in initialization, SQL Client will exit with error messages. +<span class="label label-danger">Attention</span> If SQL Client receives errors during initialization, SQL Client will exit with error messages. ### Dependencies @@ -388,7 +388,7 @@ In both modes, SQL Client supports to parse and execute all types of the Flink s ### Interactive Command Line -In interactive Command Line, the SQL Client reads user inputs and executes the statement when getting semicolon (`;`). +In interactive Command Line, the SQL Client reads user inputs and executes the statement terminated by semicolon (`;`). SQL Client will print success message if the statement is executed successfully. When getting errors, SQL Client will also print error messages. By default, the error message only contains the error cause. In order to print the full exception stack for debugging, please set the @@ -398,7 +398,7 @@ By default, the error message only contains the error cause. In order to print t SQL Client supports to execute a SQL script file with the `-f` option. SQL Client will execute statements one by one in the SQL script file and print execution messages for each executed statements. -Once a statement is failed, the SQL Client will exist and all the remaining statements will not be executed. +Once a statement fails, the SQL Client will exit and all the remaining statements will not be executed. An example of such a file is presented below. @@ -445,7 +445,7 @@ This configuration: - set the savepoint path, - submit a sql job that load the savepoint from the specified savepoint path. -<span class="label label-danger">Attention</span> Comparing to interactive mode, SQL Client will stop execution and exits when meets errors. +<span class="label label-danger">Attention</span> Compared to the interactive mode, SQL Client will stop execution and exit when there are errors. ### Execute a set of SQL statements @@ -594,9 +594,9 @@ Job ID: 6f922fe5cba87406ff23ae4a7bb79044 <span class="label label-danger">Attention</span> The SQL Client does not track the status of the running Flink job after submission. The CLI process can be shutdown after the submission without affecting the detached query. Flink's `restart strategy` takes care of the fault-tolerance. A query can be cancelled using Flink's web interface, command-line, or REST API. -However, for batch users, it's more common that the next DML statement requires to wait util the +However, for batch users, it's more common that the next DML statement requires waiting until the previous DML statement finishes. In order to execute DML statements synchronously, you can set -`table.dml-sync` option true in SQL Client. +`table.dml-sync` option `true` in SQL Client. ```sql Flink SQL> SET 'table.dml-sync' = 'true'; diff --git a/docs/content/docs/dev/table/sqlClient.md b/docs/content/docs/dev/table/sqlClient.md index 113413a..e9446c5 100644 --- a/docs/content/docs/dev/table/sqlClient.md +++ b/docs/content/docs/dev/table/sqlClient.md @@ -410,7 +410,7 @@ When using `-i <init.sql>` option to initialize SQL Client session, the followin When execute queries or insert statements, please enter the interactive mode or use the -f option to submit the SQL statements. -<span class="label label-danger">Attention</span> If SQL Client meets errors in initialization, SQL Client will exit with error messages. +<span class="label label-danger">Attention</span> If SQL Client receives errors during initialization, SQL Client will exit with error messages. ### Dependencies @@ -437,7 +437,7 @@ In both modes, SQL Client supports to parse and execute all types of the Flink s ### Interactive Command Line -In interactive Command Line, the SQL Client reads user inputs and executes the statement when getting semicolon (`;`). +In interactive Command Line, the SQL Client reads user inputs and executes the statement terminated by a semicolon (`;`). SQL Client will print success message if the statement is executed successfully. When getting errors, SQL Client will also print error messages. By default, the error message only contains the error cause. In order to print the full exception stack for debugging, please set the @@ -447,7 +447,7 @@ By default, the error message only contains the error cause. In order to print t SQL Client supports to execute a SQL script file with the `-f` option. SQL Client will execute statements one by one in the SQL script file and print execution messages for each executed statements. -Once a statement is failed, the SQL Client will exist and all the remaining statements will not be executed. +Once a statement fails, the SQL Client will exit and all the remaining statements will not be executed. An example of such a file is presented below. @@ -494,7 +494,7 @@ This configuration: - set the savepoint path, - submit a sql job that load the savepoint from the specified savepoint path. -<span class="label label-danger">Attention</span> Comparing to interactive mode, SQL Client will stop execution and exits when meets errors. +<span class="label label-danger">Attention</span> Compared to the interactive mode, SQL Client will stop execution and exits when there are errors. ### Execute a set of SQL statements @@ -643,9 +643,9 @@ Job ID: 6f922fe5cba87406ff23ae4a7bb79044 <span class="label label-danger">Attention</span> The SQL Client does not track the status of the running Flink job after submission. The CLI process can be shutdown after the submission without affecting the detached query. Flink's `restart strategy` takes care of the fault-tolerance. A query can be cancelled using Flink's web interface, command-line, or REST API. -However, for batch users, it's more common that the next DML statement requires to wait util the +However, for batch users, it's more common that the next DML statement requires waiting until the previous DML statement finishes. In order to execute DML statements synchronously, you can set -`table.dml-sync` option true in SQL Client. +`table.dml-sync` option to `true` in SQL Client. ```sql Flink SQL> SET 'table.dml-sync' = 'true';