morrySnow commented on code in PR #2033:
URL: https://github.com/apache/doris-website/pull/2033#discussion_r1953881074
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
Review Comment:
参数应该被尖括号包裹
```suggestion
CREATE SYNC [<db>.]<job_name>
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
- ...
- )
+(
+ channel_desc,
+ channel_desc,
+ ...
+)
Review Comment:
```suggestion
(<channel_desc> [, ... ])
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/RESUME-SYNC-JOB.md:
##########
@@ -24,29 +24,27 @@ 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
Review Comment:
类似的问题
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/PAUSE-SYNC-JOB.md:
##########
@@ -24,29 +24,27 @@ 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
```
-## Example
+## Required Parameters
-1. Pause the data sync job named `job_name`.
+**1. `job_name`**
Review Comment:
```suggestion
**1. `<job_name>`**
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/PAUSE-SYNC-JOB.md:
##########
@@ -24,29 +24,27 @@ 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
Review Comment:
```suggestion
PAUSE SYNC JOB [<db>.]<job_name>
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
- ...
- )
+(
+ channel_desc,
+ channel_desc,
+ ...
+)
binlog_desc
Review Comment:
```suggestion
<binlog_desc>
```
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
- ...
- )
+(
+ channel_desc,
+ channel_desc,
+ ...
+)
binlog_desc
```
-1. `job_name`
-
- The synchronization job name is the unique identifier of the job in the
current database. Only one job with the same `job_name` can be running.
-
-2. `channel_desc`
-
- The data channel under the job is used to describe the mapping relationship
between the mysql source table and the doris target table.
-
- grammar:
+## Required Parameters
+
+**1. `<job_name>`**
+
+> Specifies the unique name of the synchronization job within the current
database. Only one job with the same `<job_name>` can be running at a time.
+
+**2. `<channel_desc>`**
+
+> Describes the mapping relationship between the MySQL source table and the
Doris target table.
+>
+> **Syntax:**
+> ```sql
+> FROM mysql_db.src_tbl INTO des_tbl [columns_mapping]
+> ```
+>
+> - **`mysql_db.src_tbl`**: Specifies the source table in MySQL (including the
database name).
+> - **`des_tbl`**: Specifies the target table in Doris. The target table must
be unique, and its batch delete function must be enabled.
+> - **`[columns_mapping]`** (Optional): Defines the mapping between columns of
the source and target tables. If omitted, columns are mapped one-to-one in
order. Note that the form `col_name = expr` is not supported.
+
+**3. `<binlog_desc>`**
+
+> Describes the remote data source for the Binlog.
+>
+> **Syntax:**
+> ```sql
+> FROM BINLOG
+> (
+> "key1" = "value1",
+> "key2" = "value2",
+> ...
+> )
Review Comment:
和 chaneel_desc 类似，移动到语法章节
````suggestion
```sql
<binlog_desc>
: FROM BINLOG ("<key>" = "<value>" [, ... ])
```
````
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
- ...
- )
+(
+ channel_desc,
+ channel_desc,
+ ...
+)
binlog_desc
```
-1. `job_name`
-
- The synchronization job name is the unique identifier of the job in the
current database. Only one job with the same `job_name` can be running.
-
-2. `channel_desc`
-
- The data channel under the job is used to describe the mapping relationship
between the mysql source table and the doris target table.
-
- grammar:
+## Required Parameters
+
+**1. `<job_name>`**
+
+> Specifies the unique name of the synchronization job within the current
database. Only one job with the same `<job_name>` can be running at a time.
+
+**2. `<channel_desc>`**
+
+> Describes the mapping relationship between the MySQL source table and the
Doris target table.
+>
+> **Syntax:**
+> ```sql
+> FROM mysql_db.src_tbl INTO des_tbl [columns_mapping]
+> ```
Review Comment:
此部分应移动到语法章节使用
````
Where:
```sql
<channel_desc>
: FROM <mysql_db>.<src_tbl> INTO <des_tbl> [ <columns_mapping> ]
##########
docs/sql-manual/sql-statements/data-modification/load-and-export/CREATE-SYNC-JOB.md:
##########
@@ -25,133 +25,112 @@ 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
- ...
- )
+(
+ channel_desc,
+ channel_desc,
+ ...
+)
binlog_desc
```
-1. `job_name`
-
- The synchronization job name is the unique identifier of the job in the
current database. Only one job with the same `job_name` can be running.
-
-2. `channel_desc`
-
- The data channel under the job is used to describe the mapping relationship
between the mysql source table and the doris target table.
-
- grammar:
+## Required Parameters
+
+**1. `<job_name>`**
+
+> Specifies the unique name of the synchronization job within the current
database. Only one job with the same `<job_name>` can be running at a time.
+
+**2. `<channel_desc>`**
+
+> Describes the mapping relationship between the MySQL source table and the
Doris target table.
+>
+> **Syntax:**
+> ```sql
+> FROM mysql_db.src_tbl INTO des_tbl [columns_mapping]
+> ```
+>
+> - **`mysql_db.src_tbl`**: Specifies the source table in MySQL (including the
database name).
+> - **`des_tbl`**: Specifies the target table in Doris. The target table must
be unique, and its batch delete function must be enabled.
+> - **`[columns_mapping]`** (Optional): Defines the mapping between columns of
the source and target tables. If omitted, columns are mapped one-to-one in
order. Note that the form `col_name = expr` is not supported.
+
+**3. `<binlog_desc>`**
+
+> Describes the remote data source for the Binlog.
+>
+> **Syntax:**
+> ```sql
+> FROM BINLOG
+> (
+> "key1" = "value1",
+> "key2" = "value2",
+> ...
+> )
+> ```
+>
+> The properties for the Canal data source (keys prefixed with `canal.`)
include:
+>
+> - **`canal.server.ip`**: Address of the Canal server.
+> - **`canal.server.port`**: Port of the Canal server.
+> - **`canal.destination`**: Identifier of the Canal instance.
+> - **`canal.batchSize`**: Maximum batch size to fetch (default is 8192).
+> - **`canal.username`**: Username for the Canal instance.
+> - **`canal.password`**: Password for the Canal instance.
+> - **`canal.debug`** (Optional): If set to true, prints detailed batch and
row information.
+
+## Usage Notes
+
+- Currently, the synchronization job only supports connecting to a Canal
server.
+- Only one synchronization job with the same `<job_name>` can run concurrently
within a database.
+- The target table specified in `<channel_desc>` must have its batch delete
function enabled.
+
+## Examples
Review Comment:
缺少权限章节
https://doris.apache.org/docs/sql-manual/sql-statements/catalog/ALTER-CATALOG#access-control-requirements
--
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
