Skip to content

add parameters in table cli #661

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CritasWang merged 1 commit into from
Mar 25, 2025
Merged

add parameters in table cli #661

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/UserGuide/Master/Table/Tools-System/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
| -help | Flag | No | Displays help information for the CLI tool. | -help |

The figure below indicates a successful startup:
Expand Down
4 changes: 4 additions & 0 deletions src/UserGuide/latest-Table/Tools-System/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
| -help | Flag | No | Displays help information for the CLI tool. | -help |

The figure below indicates a successful startup:
Expand Down
26 changes: 15 additions & 11 deletions src/zh/UserGuide/Master/Table/Tools-System/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,21 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab

更多参数见：

| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** |
| :------------------------- | :----------- | :----------------- | :----------------------------------------------------------- | :------------------ |
| -h `<host>` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 |
| -p `<rpcPort>` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 |
| -u `<username>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root |
| -pw `<password>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 root。 | -pw root |
| -sql_dialect `<sql_dialect>` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table |
| -e `<execute>` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" |
| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c |
| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 |
| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help |
| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** |
|:-----------------------------|:-----------|:------------| :----------------------------------------------------------- |:---------------------|
| -h `<host>` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 |
| -p `<rpcPort>` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 |
| -u `<username>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root |
| -pw `<password>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 root。 | -pw root |
| -sql_dialect `<sql_dialect>` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table |
| -e `<execute>` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" |
| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c |
| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 |
| -usessl `<use_ssl>` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true |
| -ts `<trust_store>` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore |
| -tpw `<trust_store_pwd>` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword |
| -timeout `<queryTimeout>` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 |
| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help |

启动后出现如图提示即为启动成功。

Expand Down
26 changes: 15 additions & 11 deletions src/zh/UserGuide/latest-Table/Tools-System/CLI.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,21 @@ Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect tab

更多参数见：

| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** |
| :------------------------- | :----------- | :----------------- | :----------------------------------------------------------- | :------------------ |
| -h `<host>` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 |
| -p `<rpcPort>` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 |
| -u `<username>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root |
| -pw `<password>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 root。 | -pw root |
| -sql_dialect `<sql_dialect>` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table |
| -e `<execute>` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" |
| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c |
| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 |
| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help |
| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** |
|:-----------------------------|:-----------|:------------| :----------------------------------------------------------- |:---------------------|
| -h `<host>` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 |
| -p `<rpcPort>` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 |
| -u `<username>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root |
| -pw `<password>` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 root。 | -pw root |
| -sql_dialect `<sql_dialect>` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table |
| -e `<execute>` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" |
| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c |
| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 |
| -usessl `<use_ssl>` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true |
| -ts `<trust_store>` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore |
| -tpw `<trust_store_pwd>` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword |
| -timeout `<queryTimeout>` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 |
| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help |

启动后出现如图提示即为启动成功。

Expand Down