Skip to content

add cli params #1047

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 26, 2026
Merged

add cli params #1047

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
26 changes: 15 additions & 11 deletions src/UserGuide/Master/Tree/Tools-System/CLI_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,17 +86,21 @@ Enter ```quit``` or `exit` can exit Cli.

### 2.2 Cli Parameters

| Parameter name | Parameter type | Required | Description | Example |
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
| -help | No parameters | No | Print help information for IoTDB | -help |
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
| -pw <`password`> | string, no quotation marks | No | The password used for IoTDB to connect to the server. If no password is entered, IoTDB will ask for password in Cli command | -pw root |
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
| -sql_dialect `<sql_dialect>` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table |
| -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 |

Following is a cli command which connects the host with IP
10.129.187.21, rpc port 6667, username "root", password "root", and prints the timestamp in digital form. The maximum number of lines displayed on the IoTDB command line is 10.
Expand Down
26 changes: 15 additions & 11 deletions src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,17 +79,21 @@ Enter ```quit``` or `exit` can exit Cli.

## 2. Cli Parameters

| Parameter name | Parameter type | Required | Description | Example |
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
| -help | No parameters | No | Print help information for IoTDB | -help |
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
| -pw <`password`> | string, no quotation marks | No | The password used for IoTDB to connect to the server. If no password is entered, IoTDB will ask for password in Cli command | -pw root |
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
| -sql_dialect `<sql_dialect>` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table |
| -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 |

Following is a cli command which connects the host with IP
10.129.187.21, rpc port 6667, username "root", password "root", and prints the timestamp in digital form. The maximum number of lines displayed on the IoTDB command line is 10.
Expand Down
25 changes: 14 additions & 11 deletions src/UserGuide/V1.3.x/Tools-System/CLI_apache.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,17 +82,20 @@ Enter ```quit``` or `exit` can exit Cli.

### Cli Parameters

| Parameter name | Parameter type | Required | Description | Example |
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
| -help | No parameters | No | Print help information for IoTDB | -help |
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
| -pw <`password`> | string, no quotation marks | No | The password used for IoTDB to connect to the server. If no password is entered, IoTDB will ask for password in Cli command | -pw root |
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
| -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 |

Following is a cli command which connects the host with IP
10.129.187.21, rpc port 6667, username "root", password "root", and prints the timestamp in digital form. The maximum number of lines displayed on the IoTDB command line is 10.
Expand Down
25 changes: 14 additions & 11 deletions src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,20 @@ Enter ```quit``` or `exit` can exit Cli.

## Cli Parameters

| Parameter name | Parameter type | Required | Description | Example |
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
| -help | No parameters | No | Print help information for IoTDB | -help |
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
| -pw <`password`> | string, no quotation marks | No | The password used for IoTDB to connect to the server. If no password is entered, IoTDB will ask for password in Cli command | -pw root |
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
| -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 |

Following is a cli command which connects the host with IP
10.129.187.21, rpc port 6667, username "root", password "root", and prints the timestamp in digital form. The maximum number of lines displayed on the IoTDB command line is 10.
Expand Down
Loading
Loading