imbajin commented on code in PR #445: URL: https://github.com/apache/incubator-hugegraph-doc/pull/445#discussion_r2716150831
##########
content/cn/docs/quickstart/toolchain/hugegraph-loader.md:
##########
@@ -807,47 +807,71 @@ schema: 必填
##### 3.4.1 参数说明
-| 参数 | 默认值 | 是否必传 | 描述信息
|
-|---------------------------|-----------|------|-------------------------------------------------------------------|
-| `-f` 或 `--file` | | Y | 配置脚本的路径
|
-| `-g` 或 `--graph` | | Y | 图名称
|
-| `-gs` 或 `--graphspace` | DEFAULT | | 图空间
|
-| `-s` 或 `--schema` | | Y | schema 文件路径
|
-| `-h` 或 `--host` 或 `-i` | localhost | | HugeGraphServer 的地址
|
-| `-p` 或 `--port` | 8080 | | HugeGraphServer 的端口号
|
-| `--username` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 username |
-| `--password` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 password |
-| `--create-graph` | false | | 是否在图不存在时自动创建
|
-| `--token` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 token |
-| `--protocol` | http | | 向服务端发请求的协议，可选 http 或 https
|
-| `--pd-peers` | | | PD 服务节点地址
|
-| `--pd-token` | | | 访问 PD 服务的 token
|
-| `--meta-endpoints` | | | 元信息存储服务地址
|
-| `--direct` | false | | 是否直连 HugeGraph-Store
|
-| `--route-type` | NODE_PORT | | 路由选择方式（可选值：NODE_PORT / DDS /
BOTH） |
-| `--cluster` | hg | | 集群名
|
-| `--trust-store-file` | | | 请求协议为 https 时，客户端的证书文件路径
|
-| `--trust-store-password` | | | 请求协议为 https 时，客户端证书密码
|
-| `--clear-all-data` | false | | 导入数据前是否清除服务端的原有数据
|
-| `--clear-timeout` | 240 | | 导入数据前清除服务端的原有数据的超时时间
|
-| `--incremental-mode` | false | | 是否使用断点续导模式，仅输入源为 FILE 和 HDFS
支持该模式，启用该模式能从上一次导入停止的地方开始导入 |
-| `--failure-mode` | false | | 失败模式为 true
时，会导入之前失败了的数据，一般来说失败数据文件需要在人工更正编辑好后，再次进行导入 |
-| `--batch-insert-threads` | CPUs | | 批量插入线程池大小 (CPUs 是当前 OS
可用**逻辑核**个数) |
-| `--single-insert-threads` | 8 | | 单条插入线程池的大小
|
-| `--max-conn` | 4 * CPUs | | HugeClient 与 HugeGraphServer
的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
-| `--max-conn-per-route` | 2 * CPUs | | HugeClient 与 HugeGraphServer
每个路由的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
-| `--batch-size` | 500 | | 导入数据时每个批次包含的数据条数
|
-| `--max-parse-errors` | 1 | | 最多允许多少行数据解析错误，达到该值则程序退出
|
-| `--max-insert-errors` | 500 | | 最多允许多少行数据插入错误，达到该值则程序退出
|
-| `--timeout` | 60 | | 插入结果返回的超时时间（秒）
|
-| `--shutdown-timeout` | 10 | | 多线程停止的等待时间（秒）
|
-| `--retry-times` | 0 | | 发生特定异常时的重试次数
|
-| `--retry-interval` | 10 | | 重试之前的间隔时间（秒）
|
-| `--check-vertex` | false | | 插入边时是否检查边所连接的顶点是否存在
|
-| `--print-progress` | true | | 是否在控制台实时打印导入条数
|
-| `--dry-run` | false | | 打开该模式，只解析不导入，通常用于测试
|
-| `--help` | false | | 打印帮助信息
|
-
+| 参数 | 默认值 | 是否必传 | 描述信息
|
+|-----------------------------------------|-------------|------|-------------------------------------------------------------------|
+| `-f` 或 `--file` | | Y | 配置脚本的路径
|
+| `-g` 或 `--graph` | | Y | 图名称
|
+| `--graphspace` | DEFAULT | | 图空间
|
+| `-s` 或 `--schema` | | Y | schema 文件路径
|
+| `-h` 或 `--host` 或 `-i` | localhost | |
HugeGraphServer 的地址 |
+| `-p` 或 `--port` | 8080 | |
HugeGraphServer 的端口号 |
+| `--username` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 username |
+| `--password` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 password |
+| `--create-graph` | false | | 是否在图不存在时自动创建
|
+| `--token` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 token |
+| `--protocol` | http | | 向服务端发请求的协议，可选
http 或 https |
+| `--pd-peers` | | | PD 服务节点地址
|
+| `--pd-token` | | | 访问 PD 服务的
token |
+| `--meta-endpoints` | | | 元信息存储服务地址
|
+| `--direct` | false | | 是否直连
HugeGraph-Store |
+| `--route-type` | NODE_PORT | |
路由选择方式（可选值：NODE_PORT / DDS / BOTH） |
+| `--cluster` | hg | | 集群名
|
+| `--trust-store-file` | | | 请求协议为 https
时，客户端的证书文件路径 |
+| `--trust-store-password` | | | 请求协议为 https
时，客户端证书密码 |
+| `--clear-all-data` | false | |
导入数据前是否清除服务端的原有数据 |
+| `--clear-timeout` | 240 | |
导入数据前清除服务端的原有数据的超时时间 |
+| `--incremental-mode` | false | |
是否使用断点续导模式，仅输入源为 FILE 和 HDFS 支持该模式，启用该模式能从上一次导入停止的地方开始导入 |
+| `--failure-mode` | false | | 失败模式为 true
时，会导入之前失败了的数据，一般来说失败数据文件需要在人工更正编辑好后，再次进行导入 |
+| `--batch-insert-threads` | CPUs | | 批量插入线程池大小
(CPUs 是当前 OS 可用**逻辑核**个数) |
+| `--single-insert-threads` | 8 | | 单条插入线程池的大小
|
+| `--max-conn` | 4 * CPUs | | HugeClient 与
HugeGraphServer 的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
+| `--max-conn-per-route` | 2 * CPUs | | HugeClient 与
HugeGraphServer 每个路由的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
+| `--batch-size` | 500 | |
导入数据时每个批次包含的数据条数 |
+| `--max-parse-errors` | 1 | |
最多允许多少行数据解析错误，达到该值则程序退出 |
+| `--max-insert-errors` | 500 | |
最多允许多少行数据插入错误，达到该值则程序退出 |
+| `--timeout` | 60 | |
插入结果返回的超时时间（秒） |
+| `--shutdown-timeout` | 10 | | 多线程停止的等待时间（秒）
|
+| `--retry-times` | 0 | | 发生特定异常时的重试次数
|
+| `--retry-interval` | 10 | | 重试之前的间隔时间（秒）
|
+| `--check-vertex` | false | |
插入边时是否检查边所连接的顶点是否存在 |
+| `--print-progress` | true | |
是否在控制台实时打印导入条数 |
+| `--dry-run` | false | |
打开该模式，只解析不导入，通常用于测试 |
+| `--help` 或 `-help` | false | | 打印帮助信息
|
+| `--parallel-count` 或 `--parallel-count` | max(2,CPUS) | | 并行读取数据文件最大线程数
|
+| `--start-file` | 0 | |
用于部分（分片）导入的起始文件索引 |
+| `--end-file` | -1 | | 用于部分导入的截止文件索引
|
+| `--scatter-sources` | false | |
分散（并行）读取多个数据源以优化 I/O 性能 |
+| `--cdc-flush-interval` | 30000 | | Flink CDC
的数据刷新间隔 |
+| `--cdc-sink-parallelism` | 1 | | Flink CDC
写入端（Sink）的并行度 |
+| `--max-read-errors` | 1 | |
程序退出前允许的最大读取错误行数 |
+| `--max-read-lines` | -1L | |
最大读取行数限制；一旦达到此行数，导入任务将停止 |
+| `--test-mode` | false | | 是否开启测试模式
|
+| `--use-prefilter` | false | | 是否预先过滤顶点
|
+| `--short-id` | | | 将自定义 ID
映射为更短的 ID |
Review Comment:
⚠️ **参数默认值与类型不匹配**
`--short-id` 参数的默认值为空,但描述是"将自定义 ID 映射为更短的 ID",这让用户不清楚:
1. 该参数的数据类型是什么?(布尔值?字符串?)
2. 如何使用此参数?(需要传入映射规则?还是只是开关?)
建议:
1. 补充参数类型说明
2. 提供使用示例,例如:`--short-id=true` 或 `--short-id=mapping-file.json`
##########
content/cn/docs/quickstart/toolchain/hugegraph-loader.md:
##########
@@ -807,47 +807,71 @@ schema: 必填
##### 3.4.1 参数说明
-| 参数 | 默认值 | 是否必传 | 描述信息
|
-|---------------------------|-----------|------|-------------------------------------------------------------------|
-| `-f` 或 `--file` | | Y | 配置脚本的路径
|
-| `-g` 或 `--graph` | | Y | 图名称
|
-| `-gs` 或 `--graphspace` | DEFAULT | | 图空间
|
-| `-s` 或 `--schema` | | Y | schema 文件路径
|
-| `-h` 或 `--host` 或 `-i` | localhost | | HugeGraphServer 的地址
|
-| `-p` 或 `--port` | 8080 | | HugeGraphServer 的端口号
|
-| `--username` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 username |
-| `--password` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 password |
-| `--create-graph` | false | | 是否在图不存在时自动创建
|
-| `--token` | null | | 当 HugeGraphServer
开启了权限认证时，当前图的 token |
-| `--protocol` | http | | 向服务端发请求的协议，可选 http 或 https
|
-| `--pd-peers` | | | PD 服务节点地址
|
-| `--pd-token` | | | 访问 PD 服务的 token
|
-| `--meta-endpoints` | | | 元信息存储服务地址
|
-| `--direct` | false | | 是否直连 HugeGraph-Store
|
-| `--route-type` | NODE_PORT | | 路由选择方式（可选值：NODE_PORT / DDS /
BOTH） |
-| `--cluster` | hg | | 集群名
|
-| `--trust-store-file` | | | 请求协议为 https 时，客户端的证书文件路径
|
-| `--trust-store-password` | | | 请求协议为 https 时，客户端证书密码
|
-| `--clear-all-data` | false | | 导入数据前是否清除服务端的原有数据
|
-| `--clear-timeout` | 240 | | 导入数据前清除服务端的原有数据的超时时间
|
-| `--incremental-mode` | false | | 是否使用断点续导模式，仅输入源为 FILE 和 HDFS
支持该模式，启用该模式能从上一次导入停止的地方开始导入 |
-| `--failure-mode` | false | | 失败模式为 true
时，会导入之前失败了的数据，一般来说失败数据文件需要在人工更正编辑好后，再次进行导入 |
-| `--batch-insert-threads` | CPUs | | 批量插入线程池大小 (CPUs 是当前 OS
可用**逻辑核**个数) |
-| `--single-insert-threads` | 8 | | 单条插入线程池的大小
|
-| `--max-conn` | 4 * CPUs | | HugeClient 与 HugeGraphServer
的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
-| `--max-conn-per-route` | 2 * CPUs | | HugeClient 与 HugeGraphServer
每个路由的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
-| `--batch-size` | 500 | | 导入数据时每个批次包含的数据条数
|
-| `--max-parse-errors` | 1 | | 最多允许多少行数据解析错误，达到该值则程序退出
|
-| `--max-insert-errors` | 500 | | 最多允许多少行数据插入错误，达到该值则程序退出
|
-| `--timeout` | 60 | | 插入结果返回的超时时间（秒）
|
-| `--shutdown-timeout` | 10 | | 多线程停止的等待时间（秒）
|
-| `--retry-times` | 0 | | 发生特定异常时的重试次数
|
-| `--retry-interval` | 10 | | 重试之前的间隔时间（秒）
|
-| `--check-vertex` | false | | 插入边时是否检查边所连接的顶点是否存在
|
-| `--print-progress` | true | | 是否在控制台实时打印导入条数
|
-| `--dry-run` | false | | 打开该模式，只解析不导入，通常用于测试
|
-| `--help` | false | | 打印帮助信息
|
-
+| 参数 | 默认值 | 是否必传 | 描述信息
|
+|-----------------------------------------|-------------|------|-------------------------------------------------------------------|
+| `-f` 或 `--file` | | Y | 配置脚本的路径
|
+| `-g` 或 `--graph` | | Y | 图名称
|
+| `--graphspace` | DEFAULT | | 图空间
|
+| `-s` 或 `--schema` | | Y | schema 文件路径
|
+| `-h` 或 `--host` 或 `-i` | localhost | |
HugeGraphServer 的地址 |
+| `-p` 或 `--port` | 8080 | |
HugeGraphServer 的端口号 |
+| `--username` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 username |
+| `--password` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 password |
+| `--create-graph` | false | | 是否在图不存在时自动创建
|
+| `--token` | null | | 当
HugeGraphServer 开启了权限认证时，当前图的 token |
+| `--protocol` | http | | 向服务端发请求的协议，可选
http 或 https |
+| `--pd-peers` | | | PD 服务节点地址
|
+| `--pd-token` | | | 访问 PD 服务的
token |
+| `--meta-endpoints` | | | 元信息存储服务地址
|
+| `--direct` | false | | 是否直连
HugeGraph-Store |
+| `--route-type` | NODE_PORT | |
路由选择方式（可选值：NODE_PORT / DDS / BOTH） |
+| `--cluster` | hg | | 集群名
|
+| `--trust-store-file` | | | 请求协议为 https
时，客户端的证书文件路径 |
+| `--trust-store-password` | | | 请求协议为 https
时，客户端证书密码 |
+| `--clear-all-data` | false | |
导入数据前是否清除服务端的原有数据 |
+| `--clear-timeout` | 240 | |
导入数据前清除服务端的原有数据的超时时间 |
+| `--incremental-mode` | false | |
是否使用断点续导模式，仅输入源为 FILE 和 HDFS 支持该模式，启用该模式能从上一次导入停止的地方开始导入 |
+| `--failure-mode` | false | | 失败模式为 true
时，会导入之前失败了的数据，一般来说失败数据文件需要在人工更正编辑好后，再次进行导入 |
+| `--batch-insert-threads` | CPUs | | 批量插入线程池大小
(CPUs 是当前 OS 可用**逻辑核**个数) |
+| `--single-insert-threads` | 8 | | 单条插入线程池的大小
|
+| `--max-conn` | 4 * CPUs | | HugeClient 与
HugeGraphServer 的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
+| `--max-conn-per-route` | 2 * CPUs | | HugeClient 与
HugeGraphServer 每个路由的最大 HTTP 连接数，**调整线程**的时候建议同时调整此项 |
+| `--batch-size` | 500 | |
导入数据时每个批次包含的数据条数 |
+| `--max-parse-errors` | 1 | |
最多允许多少行数据解析错误，达到该值则程序退出 |
+| `--max-insert-errors` | 500 | |
最多允许多少行数据插入错误，达到该值则程序退出 |
+| `--timeout` | 60 | |
插入结果返回的超时时间（秒） |
+| `--shutdown-timeout` | 10 | | 多线程停止的等待时间（秒）
|
+| `--retry-times` | 0 | | 发生特定异常时的重试次数
|
+| `--retry-interval` | 10 | | 重试之前的间隔时间（秒）
|
+| `--check-vertex` | false | |
插入边时是否检查边所连接的顶点是否存在 |
+| `--print-progress` | true | |
是否在控制台实时打印导入条数 |
+| `--dry-run` | false | |
打开该模式，只解析不导入，通常用于测试 |
+| `--help` 或 `-help` | false | | 打印帮助信息
|
+| `--parallel-count` 或 `--parallel-count` | max(2,CPUS) | | 并行读取数据文件最大线程数
|
+| `--start-file` | 0 | |
用于部分（分片）导入的起始文件索引 |
+| `--end-file` | -1 | | 用于部分导入的截止文件索引
|
+| `--scatter-sources` | false | |
分散（并行）读取多个数据源以优化 I/O 性能 |
+| `--cdc-flush-interval` | 30000 | | Flink CDC
的数据刷新间隔 |
+| `--cdc-sink-parallelism` | 1 | | Flink CDC
写入端（Sink）的并行度 |
+| `--max-read-errors` | 1 | |
程序退出前允许的最大读取错误行数 |
+| `--max-read-lines` | -1L | |
最大读取行数限制；一旦达到此行数，导入任务将停止 |
+| `--test-mode` | false | | 是否开启测试模式
|
+| `--use-prefilter` | false | | 是否预先过滤顶点
|
+| `--short-id` | | | 将自定义 ID
映射为更短的 ID |
+| `--vertex-edge-limit` | -1L | | 单个顶点的最大边数限制
|
+| `--sink-type` | true | |
数据接收端（Sink）存储类型开关 |
+| `--vertex-partitions` | 64 | | HBase
顶点表的预分区数量 |
+| `--edge-partitions` | 64 | | HBase
边表的预分区数量 |
+| `--vertex-table-name` | | | HBase 顶点表名称
|
+| `--edge-table-name` | | | HBase 边表名称
|
+| `--hbase-zk-quorum` | | | HBase
Zookeeper 集群地址 |
+| `--hbase-zk-port` | | | HBase
Zookeeper 端口号 |
+| `--hbase-zk-parent` | | | HBase
Zookeeper 根路径 |
+| `--restore` | false | | 将图模式设置为恢复模式
(RESTORING) |
+| `--backend` | hstore | |
自动创建图（如果不存在）时的后端存储类型 |
+| `--serializer` | binary | |
自动创建图（如果不存在）时的序列化器类型 |
+| `--scheduler-type` | distributed | |
自动创建图（如果不存在）时的任务调度器类型 |
+| `--batch-failure-fallback` | true | |
批量插入失败时是否回退至单条插入模式 |
Review Comment:
⚠️ **缺少参数使用示例 - 易用性问题**
新增的 24 个参数都没有实际使用示例。建议在文档的"3.4.4 执行命令"或"4 完整示例"章节补充:
1. 高性能导入配置示例(包含 `--parallel-count`, `--scatter-sources` 等)
2. HBase 后端导入示例
3. CDC 流式导入示例
4. 分片导入示例(`--start-file`, `--end-file`)
这样可以显著提升文档的实用性。
--
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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
