[update][docs] improve the document

wgzhao · Aug 30, 2024 · 9176bcb · 9176bcb
1 parent 69bb958
commit 9176bcb
Show file tree

Hide file tree

Showing 33 changed files with 335 additions and 341 deletions.
diff --git a/docs/writer/accesswriter.md b/docs/writer/accesswriter.md
@@ -1,6 +1,6 @@
 # Access Writer
 
-AccessWriter 插件实现了写入数据到 [Access][1] 目的表的功能。
+Access Writer 插件实现了写入数据到 [Access](https://en.wikipedia.org/wiki/Microsoft_Access) 目的表的功能。
 
 ## 示例
 
@@ -30,4 +30,4 @@ bin/addax.sh job/stream2access.json
 
 ## 参数说明
 
-AccessWriter 基于 [rdbmswriter](../rdbmswriter) 实现，因此可以参考 rdbmswriter 的所有配置项。
+该插件基于 [RDBMS Writer](../rdbmswriter) 实现，因此可以参考 RDBMS Writer 的所有配置项。
diff --git a/docs/writer/cassandrawriter.md b/docs/writer/cassandrawriter.md
@@ -1,6 +1,6 @@
 # Cassandra Writer
 
-CassandraWriter 插件用于向 [Cassandra](https://cassandra.apache.org) 写入数据。
+Cassandra Writer 插件用于向 [Cassandra](https://cassandra.apache.org) 写入数据。
 
 ## 配置样例
 
@@ -14,20 +14,28 @@ CassandraWriter 插件用于向 [Cassandra](https://cassandra.apache.org) 写入
 
 ## 参数说明
 
-| 配置项                  | 是否必须 | 默认值       | 描述                                                                                                                        |
-| :---------------------- | :------: | ------------ | --------------------------------------------------------------------------------------------------------------------------- |
-| host                    |    是    | 无           | Cassandra 连接点的域名或 ip，多个 node 之间用逗号分隔                                                                       |
-| port                    |    是    | 9042         | Cassandra 端口                                                                                                              |
-| username                |    否    | 无           | 数据源的用户名                                                                                                              |
-| password                |    否    | 无           | 数据源指定用户名的密码                                                                                                      |
-| useSSL                  |    否    | false        | 是否使用 SSL 连接                                                                                                           |
-| connectionsPerHost      |    否    | 8            | 客户端连接池配置：与服务器每个节点建多少个连接                                                                              |
-| maxPendingPerConnection |    否    | 128          | 客户端连接池配置：每个连接最大请求数                                                                                        |
-| keyspace                |    是    | 无           | 需要同步的表所在的 keyspace                                                                                                 |
-| table                   |    是    | 无           | 所选取的需要同步的表                                                                                                        |
-| column                  |    是    | 无           | 所配置的表中需要同步的列集合,内容可以是列的名称或 `writetime()`。如果将列名配置为 `writetime()`，会将这一列的内容作为时间戳 |
-| consistancyLevel        |    否    | LOCAL_QUORUM | 数据一致性级别, 可选 `ONE, QUORUM, LOCAL_QUORUM, EACH_QUORUM, ALL, ANY, TWO, THREE, LOCAL_ONE`                              |
-| batchSize               |    否    | 1            | 一次批量提交(UNLOGGED BATCH)的记录数大小（条数）                                                                            |
+| 配置项                  | 是否必须 | 数据类型 | 默认值         | 描述                                             |
+| :---------------------- | :------: | -------- | -------------- | ------------------------------------------------ |
+| host                    |    是    | string   | 无             | 连接点的域名或 ip，多个 node 之间用逗号分隔      |
+| port                    |    是    | int      | 9042           | Cassandra 端口                                   |
+| username                |    否    | string   | 无             | 数据源的用户名                                   |
+| password                |    否    | string   | 无             | 数据源指定用户名的密码                           |
+| useSSL                  |    否    | boolean  | false          | 是否使用 SSL 连接                                |
+| connectionsPerHost      |    否    | int      | 8              | 客户端连接池配置：与服务器每个节点建多少个连接   |
+| maxPendingPerConnection |    否    | int      | 128            | 客户端连接池配置：每个连接最大请求数             |
+| keyspace                |    是    | string   | 无             | 需要同步的表所在的 keyspace                      |
+| table                   |    是    | string   | 无             | 所选取的需要同步的表                             |
+| column                  |    是    | list     | 无             | 所配置的表中需要同步的列集合                     |
+| consistancyLevel        |    否    | string   | `LOCAL_QUORUM` | 数据一致性级别,                                  |
+| batchSize               |    否    | int      | 1              | 一次批量提交(UNLOGGED BATCH)的记录数大小（条数） |
+
+### column
+
+内容可以是列的名称或 `writetime()`。如果将列名配置为 `writetime()`，会将这一列的内容作为时间戳
+
+### consistancyLevel
+
+可选 `ONE, QUORUM, LOCAL_QUORUM, EACH_QUORUM, ALL, ANY, TWO, THREE, LOCAL_ONE`
 
 ## 类型转换
 

diff --git a/docs/writer/clickhousewriter.md b/docs/writer/clickhousewriter.md
@@ -1,6 +1,6 @@
 # ClickHouse Writer
 
-ClickHouseWriter 插件用于向 [ClickHouse](https://clickhouse.tech) 写入数据。 
+ClickHouse Writer 插件用于向 [ClickHouse](https://clickhouse.tech) 写入数据。 
 
 ## 示例
 
@@ -42,4 +42,4 @@ bin/addax.sh job/clickhouse2clickhouse.json
 
 ## 参数说明
 
-ClickHouseWriter 基于 [rdbmswriter](../rdbmswriter) 实现，因此可以参考 rdbmswriter 的所有配置项。
+该插件基于 [RDBMS Writer](../rdbmswriter) 实现，因此可以参考 RDBMS Writer 的所有配置项。
diff --git a/docs/writer/databendwriter.md b/docs/writer/databendwriter.md
@@ -36,17 +36,16 @@ bin/addax.sh job/stream2Databend.json
 
 ## 参数说明
 
-DatabendWriter 基于 [rdbmswriter](../rdbmswriter) 实现，因此可以参考 rdbmswriter 的所有配置项，并增加了如下配置项：
+该插件基于 [RDBMS Writer](../rdbmswriter) 实现，因此可以参考 RDBMS Writer 的所有配置项, 并增加了如下配置项：
 
-| 配置项           | 是否必须 | 类型   | 默认值   | 描述                                                                     |
-| :--------------- | :------: | ------ | -------- | ------------------------------------------------------------------------ |
-| writeMode        |    否    | string | `insert` | 写入模式，支持 insert 和 replace 两种模式，默认为 insert。               |
-| onConflictColumn |    否    | string | 无       | 冲突列，当 writeMode 为 replace 时，必须指定冲突列，否则会导致写入失败。 |
+| 配置项           | 是否必须 | 类型   | 默认值   | 描述                                                                       |
+| :--------------- | :------: | ------ | -------- | -------------------------------------------------------------------------- |
+| writeMode        |    否    | string | `insert` | 写入模式，支持 `insert` 和 `replace` 两种模式                              |
+| onConflictColumn |    否    | string | 无       | 冲突列，当 writeMode 为 `replace` 时，必须指定冲突列，否则会导致写入失败。 |
 
 ### writeMode
 
-该参数为 `4.1.2` 版本引入，用来支持 Databend 的 `replace into` 语法，当该参数设定为 `replace`
-时，必须同时指定 `onConflictColumn` 参数，用来判断数据是插入还是更新的依据。
+用来支持 Databend 的 `replace into` 语法，当该参数设定为 `replace` 时，必须同时指定 `onConflictColumn` 参数，用来判断数据是插入还是更新的依据。
 
 两个参数的示例如下：
 

diff --git a/docs/writer/dbfwriter.md b/docs/writer/dbfwriter.md
@@ -1,6 +1,6 @@
 # DBF Writer
 
-DbfWriter 提供了向本地文件写入类dbf格式的一个或者多个表文件。
+Dbf Writer 提供了向本地文件写入类dbf格式的一个或者多个表文件。
 
 ## 配置样例
 
@@ -10,15 +10,15 @@ DbfWriter 提供了向本地文件写入类dbf格式的一个或者多个表文
 
 ## 参数说明
 
-| 配置项     | 是否必须 | 默认值 | 描述                                                                                             |
-| :--------- | :------: | ------ | ------------------------------------------------------------------------------------------------ |
-| path       |    是    | 无     | DBF文件目录，注意这里是文件夹，不是文件                                                          |
-| column     |    是    | 无     | 所配置的表中需要同步的列集合, 是 `{type: value}` 或 `{type: index}` 的集合                       |
-| fileName   |    是    | 无     | DbfFileWriter写入的文件名                                                                        |
-| writeMode  |    是    | 无     | DbfFileWriter写入前数据清理处理模式，支持 `truncate`, `append`, `nonConflict` 三种模式，详见如下 |
-| encoding   |    否    | UTF-8  | DBF文件编码，比如 `GBK`, `UTF-8`                                                                 |
-| nullFormat |    否    | `\N`   | 定义哪个字符串可以表示为null,                                                                    |
-| dateFormat |    否    | 无     | 日期类型的数据序列化到文件中时的格式，例如 `"dateFormat": "yyyy-MM-dd"`                          |
+| 配置项     | 是否必须 | 数据类型    | 默认值 | 描述                                                      |
+| :--------- | :------: | ----------- | ------ | --------------------------------------------------------- |
+| path       |    是    | string      | 无     | 文件目录，注意这里是文件夹，不是文件                   |
+| column     |    是    | `list<map>` | 无     | 所配置的表中需要同步的列集合，详见示例配置                |
+| fileName   |    是    | string      | 无     | 写入的文件名                                              |
+| writeMode  |    是    | string      | 无     | 写入前数据清理处理模式，详见下面描述                      |
+| encoding   |    否    | string      | UTF-8  | 文件编码，比如 `GBK`, `UTF-8`                             |
+| nullFormat |    否    | string      | `\N`   | 定义哪个字符串可以表示为null,                             |
+| dateFormat |    否    | string      | 无     | 日期类型的数据序列化到文件中时的格式，例如 `"yyyy-MM-dd"` |
 
 ### writeMode
 

diff --git a/docs/writer/doriswriter.md b/docs/writer/doriswriter.md
@@ -4,7 +4,7 @@ DorisWriter 插件用于向 [Doris](http://doris.incubator.apache.org/master/zh-
 Doris http 连接(8030)，然后通过 [stream load](http://doris.incubator.apache.org/master/zh-CN/administrator-guide/load-data/stream-load-manual.html)
 加载数据到数据中，相比 `insert into` 方式效率要高不少，也是官方推荐的生产环境下的数据加载方式。
 
-Doris 是一个兼容 MySQL 协议的数据库后端，因此 Doris 读取可以使用 [MySQLReader](../../reader/mysqlreader) 进行访问。
+Doris 是一个兼容 MySQL 协议的数据库后端，因此 Doris 读取可以使用 [MySQL Reader](../../reader/mysqlreader) 进行访问。
 
 ## 示例
 
@@ -46,21 +46,22 @@ bin/addax.sh job/stream2doris.json
 
 ## 参数说明
 
-| 配置项              | 是否必须 | 类型     | 默认值   | 描述                                                  |
-|:-----------------|:----:|--------|-------|-----------------------------------------------------|
-| loadUrl          |  是   | string | 无     | Stream Load 的连接目标 ｜                                 |
-| username         |  是   | string | 无     | 访问Doris数据库的用户名                                      |
-| password         |  否   | string | 无     | 访问Doris数据库的密码                                       |
-| flushInterval    |  否   | int    | 3000  | 数据写入到目标表的间隔时间，单位为毫秒，即每隔多少毫秒写入一次数据    |
-| flushQueueLength |  否   | int    | 1     | 上传数据的队列长度                                           |
-| table            |  是   | string | 无     | 所选取的需要同步的表名                                         |
-| column           |  是   | list   | 无     | 所配置的表中需要同步的列名集合，详细描述见 [rdbmswriter](../rdbmswriter) |
-| batchSize        |  否   | int    | 2048  | 每批次导入数据的最大行数                                        |
-| loadProps        |  否   | map    | `csv` | streamLoad 的请求参数，详情参照[StreamLoad介绍页面][1]            |
-| preSqL           |  否   | list   |       | 写入数据到目标表前要执行的 SQL 语句                                |
-| postSqL          |  否   | list   |       | 数据写完后要执行的 SQL 语句                                    |
-
-[1]: https://github.com/apache/doris-streamloader/tree/master
+| 配置项           | 是否必须 | 类型   | 默认值 | 描述                                                               |
+| :--------------- | :------: | ------ | ------ | ------------------------------------------------------------------ |
+| loadUrl          |    是    | string | 无     | Stream Load 的连接目标 ｜                                          |
+| username         |    是    | string | 无     | 访问Doris数据库的用户名                                            |
+| password         |    否    | string | 无     | 访问Doris数据库的密码                                              |
+| flushInterval    |    否    | int    | 3000   | 数据写入到目标表的间隔时间，单位为毫秒，即每隔多少毫秒写入一次数据 |
+| flushQueueLength |    否    | int    | 1      | 上传数据的队列长度                                                 |
+| table            |    是    | string | 无     | 所选取的需要同步的表名                                             |
+| column           |    是    | list   | 无     | 所配置的表中需要同步的列名集合，详细描述见 [RBDMS Writer][1]       |
+| batchSize        |    否    | int    | 2048   | 每批次导入数据的最大行数                                           |
+| loadProps        |    否    | map    | `csv`  | streamLoad 的请求参数，详情参照[StreamLoad介绍页面][2]             |
+| preSql           |    否    | list   |        | 写入数据到目标表前要执行的 SQL 语句                                |
+| postSql          |    否    | list   |        | 数据写完后要执行的 SQL 语句                                        |
+
+[1]: ../rdbmswriter
+[2]: https://github.com/apache/doris-streamloader/tree/master
 
 ## loadUrl