update docs

apecloud · Jan 3, 2025 · ae38976 · ae38976
1 parent 49976bd
commit ae38976
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/docs/en/config.md b/docs/en/config.md
@@ -1,8 +1,8 @@
 # Config details
 
-# Config content
+Different tasks may require extra configs, refer to [task templates](/docs/templates/) and [tutorial](/docs/en/tutorial/)
 
-Refer to [task templates](../templates/mysql_to_mysql.md) and [tutorial](../en/tutorial/mysql_to_mysql.md)
+# Example: MySQL -> MySQL
 
 # [extractor]
 | Config | Description | Example | Default |
@@ -12,7 +12,13 @@ Refer to [task templates](../templates/mysql_to_mysql.md) and [tutorial](../en/t
 | url | database url | mysql://root:123456@127.0.0.1:3307 | - |
 | batch_size | number of extracted records in a batch | 10000 | same as [pipeline] buffer_size |
 
-Since different tasks may require extra configs, please refer to examples in dt-tests/tests and [task templates](/docs/templates/).
+## URL escaping
+- If the username/password contains special characters, the corresponding parts need to be percent-encoded, for example:
+```
+create user user1@'%' identified by 'abc%$#?@';
+The url should be:
+url=mysql://user1:abc%25%24%23%3F%40@127.0.0.1:3307?ssl-mode=disabled
+```
 
 # [sinker]
 | Config | Description | Example | Default |
@@ -23,7 +29,6 @@ Since different tasks may require extra configs, please refer to examples in dt-
 | batch_size | number of records written in a batch, 1 for serial | 200 | 200 |
 | replace | when inserting data, whether to force replacement if data already exists in target database, used in snapshot/cdc tasks for MySQL/PG | false | true |
 
-Since different tasks may require extra configs, please refer to examples in dt-tests/tests and [task templates](/docs/templates/).
 
 # [filter]
 

diff --git a/docs/img/wechat_group.png b/docs/img/wechat_group.png
diff --git a/docs/zh/config.md b/docs/zh/config.md
@@ -1,8 +1,8 @@
 # 配置详情
 
-# 示例: MySQL -> MySQL
+不同任务类型需要不同的参数，详情请参考 [任务模版](/docs/templates/) 和 [教程](/docs/en/tutorial/)。
 
-参考 [任务模版](../templates/mysql_to_mysql.md) 和 [教程](../en/tutorial/mysql_to_mysql.md)
+# 示例: MySQL -> MySQL
 
 # [extractor]
 | 配置 | 作用 | 示例 | 默认 |
@@ -12,7 +12,13 @@
 | url | 源库连接信息 | mysql://root:123456@127.0.0.1:3307 | - |
 | batch_size | 批量拉取数据条数 | 10000 | 和 [pipeline] buffer_size 一致 |
 
-不同任务类型需要不同的参数，详情请参考 dt-tests/tests 及 [任务模版](/docs/templates/)。
+## url 转义
+- 如果用户名/密码中包含特殊字符，需要对相应部分进行通用的 url 百分号转义，如：
+```
+create user user1@'%' identified by 'abc%$#?@';
+对应的 url 为：
+url=mysql://user1:abc%25%24%23%3F%40@127.0.0.1:3307?ssl-mode=disabled
+```
 
 # [sinker]
 | 配置 | 作用 | 示例 | 默认 |
@@ -23,8 +29,6 @@
 | batch_size | 批量写入数据条数，1 代表串行 | 200 | 200 |
 | replace | 插入数据时，如果已存在于目标库，是否强行替换，适用于 mysql/pg 的全量/增量任务 | false | true |
 
-不同任务类型需要不同的参数，详情请参考 dt-tests/tests 及 [任务模版](/docs/templates/)。
-
 # [filter]
 
 | 配置 | 作用 | 示例 | 默认 |