morrySnow commented on code in PR #2033:
URL: https://github.com/apache/doris-website/pull/2033#discussion_r1965236115
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/SHOW-SYNC-JOB.md:
##########
@@ -26,34 +24,33 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This command is used to currently display the status of resident data
synchronization jobs in all databases.
+This statement displays the status of resident data synchronization jobs in
all databases.
-grammar:
+## Syntax
```sql
SHOW SYNC JOB [FROM db_name]
Review Comment:
```suggestion
SHOW SYNC JOB [FROM <db_name>]
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/STOP-SYNC-JOB.md:
##########
@@ -24,28 +24,33 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-Stop a non-stop resident data synchronization job in a database by `job_name`.
+Stop a running resident data synchronization job in a database by specifying
its `job_name`. Once stopped, the job will cease synchronizing data and release
its occupied resources.
-grammar:
+## Syntax
```sql
-STOP SYNC JOB [db.]job_name
+STOP SYNC JOB [<db>.]<job_name>
```
-## Example
+## Required Parameters
+
+**1. `<job_name>`**
-1. Stop the data sync job named `job_name`
+> Specifies the name of the data synchronization job to be stopped.
+> If a database is specified with the `[db.]` prefix, the job is located in
that database; otherwise, the current database is used.
- ```sql
- STOP SYNC JOB `job_name`;
- ```
Review Comment:
缺少 db 参数的描述
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,103 @@ under the License.
-->
-
## Description
-The data synchronization (Sync Job) function supports users to submit a
resident data synchronization job, and incrementally synchronizes the CDC
(Change Data Capture) of the user's data update operation in the Mysql database
by reading the Binlog log from the specified remote address. Features.
-
-Currently, the data synchronization job only supports connecting to Canal,
obtaining the parsed Binlog data from the Canal Server and importing it into
Doris.
+The data synchronization (Sync Job) function allows users to submit a
persistent data synchronization job. It incrementally synchronizes the CDC
(Change Data Capture) of data update operations from a MySQL database by
reading the Binlog from a specified remote source. Currently, the
synchronization job supports connecting to Canal, obtaining parsed Binlog data
from the Canal server, and importing it into Doris.
-Users can view the data synchronization job status through [SHOW SYNC
JOB](../../../../sql-manual/sql-statements/data-modification/load-and-export/SHOW-SYNC-JOB).
+Users can view the status of synchronization jobs via [SHOW SYNC
JOB](../../../../sql-manual/sql-statements/data-modification/load-and-export/SHOW-SYNC-JOB).
-grammar:
+## Syntax
```sql
-CREATE SYNC [db.]job_name
- (
- channel_desc,
- channel_desc
- ...
- )
-binlog_desc
+CREATE SYNC [<db>.]<job_name>
+(<channel_desc> [, ... ])
+ : FROM <mysql_db>.<src_tbl> INTO <des_tbl> [ <columns_mapping> ]
+<binlog_desc>
+ : FROM BINLOG ("<key>" = "<value>" [, ... ])
Review Comment:
这样写
````suggestion
```sql
CREATE SYNC [<db>.]<job_name>
(<channel_desc> [, ... ])
<binlog_desc>
: FROM BINLOG ("<key>" = "<value>" [, ... ])
```
where:
```sql
channel_desc
: FROM <mysql_db>.<src_tbl> INTO <des_tbl> [ <columns_mapping> ]
```
```sql
binlog_desc
: FROM BINLOG ("<key>" = "<value>" [, ... ])
```
````
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/PAUSE-SYNC-JOB.md:
##########
@@ -24,29 +24,31 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-Pause a running resident data synchronization job in a database via
`job_name`. The suspended job will stop synchronizing data and keep the latest
position of consumption until it is resumed by the user.
+Pause a running resident data synchronization job in a database identified by
`job_name`. The suspended job will stop synchronizing data while retaining its
latest consumption position until it is resumed by the user.
-grammar:
+## Syntax
```sql
-PAUSE SYNC JOB [db.]job_name
+PAUSE SYNC JOB [<db>.]<job_name>
```
-## Example
+## Required Parameters
-1. Pause the data sync job named `job_name`.
+**1. `<job_name>`**
- ```sql
- PAUSE SYNC JOB `job_name`;
- ```
+> Specifies the name of the synchronization job to be paused.
+> If a database is specified using the `[<db.>]` prefix, the job is located in
that database; otherwise, the current database is used.
Review Comment:
缺少 `<db>` 参数的描述
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/SHOW-SYNC-JOB.md:
##########
@@ -26,34 +24,33 @@ specific language governing permissions and limitations
under the License.
-->
-
## Description
-This command is used to currently display the status of resident data
synchronization jobs in all databases.
+This statement displays the status of resident data synchronization jobs in
all databases.
-grammar:
+## Syntax
```sql
SHOW SYNC JOB [FROM db_name]
```
Review Comment:
缺少 `db_name` 参数的描述
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/RESUME-SYNC-JOB.md:
##########
@@ -24,29 +24,33 @@ specific language governing permissions and limitations
under the License.
-->
-
-
## Description
-Resume a resident data synchronization job whose current database has been
suspended by `job_name`, and the job will continue to synchronize data from the
latest position before the last suspension.
+Resume a resident data synchronization job that has been suspended in a
database by its `job_name`. Once resumed, the job continues to synchronize data
starting from the latest position before the suspension.
-grammar:
+## Syntax
```sql
-RESUME SYNC JOB [db.]job_name
+RESUME SYNC JOB [<db>.]<job_name>
```
-## Example
+## Required Parameters
+
+**1. `<job_name>`**
+
+> Specifies the name of the data synchronization job to be resumed.
+> If a database is specified with the `[<db>.]` prefix, the job is located in
that database; otherwise, the current database is used.
+
Review Comment:
缺少 `<db>` 参数的描述
--
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: commits-unsubscr...@doris.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org
For additional commands, e-mail: commits-h...@doris.apache.org
