From 699239d3f3c18bcfbbfc569c3b289826407e0b11 Mon Sep 17 00:00:00 2001 From: Liu Xiao <42756849+liuxiaocs7@users.noreply.github.com> Date: Fri, 22 Sep 2023 10:06:32 +0800 Subject: [PATCH] fix loader conf display (#289) --- .../cn/docs/quickstart/hugegraph-loader.md | 62 +++++++++---------- .../en/docs/quickstart/hugegraph-loader.md | 58 ++++++++--------- 2 files changed, 60 insertions(+), 60 deletions(-) diff --git a/content/cn/docs/quickstart/hugegraph-loader.md b/content/cn/docs/quickstart/hugegraph-loader.md index 8e8347ceb..e15e26f4d 100644 --- a/content/cn/docs/quickstart/hugegraph-loader.md +++ b/content/cn/docs/quickstart/hugegraph-loader.md @@ -720,37 +720,37 @@ schema: 必填 ##### 3.4.1 参数说明 -| 参数 | 默认值 | 是否必传 | 描述信息 | -|-------------------------|-----------|------|-------------------------------------------------------------------| -| -f 或 --file | | Y | 配置脚本的路径 | -| -g 或 --graph | | Y | 图数据库空间 | -| -s 或 --schema | | Y | schema文件路径 | -| -h 或 --host | localhost | | HugeGraphServer 的地址 | -| -p 或 --port | 8080 | | HugeGraphServer 的端口号 | -| --username | null | | 当 HugeGraphServer 开启了权限认证时，当前图的 username | -| --token | null | | 当 HugeGraphServer 开启了权限认证时，当前图的 token | -| --protocol | http | | 向服务端发请求的协议，可选 http 或 https | -| --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 | 图数据库空间 | +| `-s` 或 `--schema` | | Y | schema文件路径 | +| `-h` 或 `--host` | localhost | | HugeGraphServer 的地址 | +| `-p` 或 `--port` | 8080 | | HugeGraphServer 的端口号 | +| `--username` | null | | 当 HugeGraphServer 开启了权限认证时，当前图的 username | +| `--token` | null | | 当 HugeGraphServer 开启了权限认证时，当前图的 token | +| `--protocol` | http | | 向服务端发请求的协议，可选 http 或 https | +| `--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 | | 打印帮助信息 | ##### 3.4.2 断点续导模式 diff --git a/content/en/docs/quickstart/hugegraph-loader.md b/content/en/docs/quickstart/hugegraph-loader.md index 7ba2fa435..8cb72cc1c 100644 --- a/content/en/docs/quickstart/hugegraph-loader.md +++ b/content/en/docs/quickstart/hugegraph-loader.md @@ -719,35 +719,35 @@ The import process is controlled by commands submitted by the user, and the user | Parameter | Default value | Required or not | Description | |-------------------------|---------------|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| -f or --file | | Y | path to configure script | -| -g or --graph | | Y | graph space name | -| -s or --schema | | Y | schema file path | -| -h or --host | localhost | | address of HugeGraphServer | -| -p or --port | 8080 | | port number of HugeGraphServer | -| --username | null | | When HugeGraphServer enables permission authentication, the username of the current graph | -| --token | null | | When HugeGraphServer has enabled authorization authentication, the token of the current graph | -| --protocol | http | | Protocol for sending requests to the server, optional http or https | -| --trust-store-file | | | When the request protocol is https, the client's certificate file path | -| --trust-store-password | | | When the request protocol is https, the client certificate password | -| --clear-all-data | false | | Whether to clear the original data on the server before importing data | -| --clear-timeout | 240 | | Timeout for clearing the original data on the server before importing data | -| --incremental-mode | false | | Whether to use the breakpoint resume mode, only the input source is FILE and HDFS support this mode, enabling this mode can start the import from the place where the last import stopped | -| --failure-mode | false | | When the failure mode is true, the data that failed before will be imported. Generally speaking, the failed data file needs to be manually corrected and edited, and then imported again | -| --batch-insert-threads | CPUs | | Batch insert thread pool size (CPUs is the number of **logical cores** available to the current OS) | -| --single-insert-threads | 8 | | Size of single insert thread pool | -| --max-conn | 4 * CPUs | | The maximum number of HTTP connections between HugeClient and HugeGraphServer, it is recommended to adjust this when **adjusting threads** | -| --max-conn-per-route | 2 * CPUs | | The maximum number of HTTP connections for each route between HugeClient and HugeGraphServer, it is recommended to adjust this item at the same time when **adjusting the thread** | -| --batch-size | 500 | | The number of data items in each batch when importing data | -| --max-parse-errors | 1 | | The maximum number of lines of data parsing errors allowed, and the program exits when this value is reached | -| --max-insert-errors | 500 | | The maximum number of rows of data insertion errors allowed, and the program exits when this value is reached | -| --timeout | 60 | | Timeout (seconds) for inserting results to return | -| --shutdown-timeout | 10 | | Waiting time for multithreading to stop (seconds) | -| --retry-times | 0 | | Number of retries when a specific exception occurs | -| --retry-interval | 10 | | interval before retry (seconds) | -| --check-vertex | false | | Whether to check whether the vertex connected by the edge exists when inserting the edge | -| --print-progress | true | | Whether to print the number of imported items in the console in real time | -| --dry-run | false | | Turn on this mode, only parsing but not importing, usually used for testing | -| --help | false | | print help information | +| `-f` or `--file` | | Y | path to configure script | +| `-g` or `--graph` | | Y | graph space name | +| `-s` or `--schema` | | Y | schema file path | +| `-h` or `--host` | localhost | | address of HugeGraphServer | +| `-p` or `--port` | 8080 | | port number of HugeGraphServer | +| `--username` | null | | When HugeGraphServer enables permission authentication, the username of the current graph | +| `--token` | null | | When HugeGraphServer has enabled authorization authentication, the token of the current graph | +| `--protocol` | http | | Protocol for sending requests to the server, optional http or https | +| `--trust-store-file` | | | When the request protocol is https, the client's certificate file path | +| `--trust-store-password` | | | When the request protocol is https, the client certificate password | +| `--clear-all-data` | false | | Whether to clear the original data on the server before importing data | +| `--clear-timeout` | 240 | | Timeout for clearing the original data on the server before importing data | +| `--incremental-mode` | false | | Whether to use the breakpoint resume mode, only the input source is FILE and HDFS support this mode, enabling this mode can start the import from the place where the last import stopped | +| `--failure-mode` | false | | When the failure mode is true, the data that failed before will be imported. Generally speaking, the failed data file needs to be manually corrected and edited, and then imported again | +| `--batch-insert-threads` | CPUs | | Batch insert thread pool size (CPUs is the number of **logical cores** available to the current OS) | +| `--single-insert-threads` | 8 | | Size of single insert thread pool | +| `--max-conn` | 4 * CPUs | | The maximum number of HTTP connections between HugeClient and HugeGraphServer, it is recommended to adjust this when **adjusting threads** | +| `--max-conn-per-route` | 2 * CPUs | | The maximum number of HTTP connections for each route between HugeClient and HugeGraphServer, it is recommended to adjust this item at the same time when **adjusting the thread** | +| `--batch-size` | 500 | | The number of data items in each batch when importing data | +| `--max-parse-errors` | 1 | | The maximum number of lines of data parsing errors allowed, and the program exits when this value is reached | +| `--max-insert-errors` | 500 | | The maximum number of rows of data insertion errors allowed, and the program exits when this value is reached | +| `--timeout` | 60 | | Timeout (seconds) for inserting results to return | +| `--shutdown-timeout` | 10 | | Waiting time for multithreading to stop (seconds) | +| `--retry-times` | 0 | | Number of retries when a specific exception occurs | +| `--retry-interval` | 10 | | interval before retry (seconds) | +| `--check-vertex` | false | | Whether to check whether the vertex connected by the edge exists when inserting the edge | +| `--print-progress` | true | | Whether to print the number of imported items in the console in real time | +| `--dry-run` | false | | Turn on this mode, only parsing but not importing, usually used for testing | +| `--help` | false | | print help information | ##### 3.4.2 Breakpoint Continuation Mode