Skip to content

Commit ca79294

Browse files
leto-bleto-b
authored
add cli params (#1047)
1 parent 15ee196 commit ca79294

File tree

16 files changed

+240
-176
lines changed

16 files changed

+240
-176
lines changed

‎src/UserGuide/Master/Tree/Tools-System/CLI_apache.md‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -86,17 +86,21 @@ Enter ```quit``` or `exit` can exit Cli.
8686

8787
### 2.2 Cli Parameters
8888

89-
| Parameter name | Parameter type | Required | Description | Example |
90-
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
91-
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
92-
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
93-
| -help | No parameters | No | Print help information for IoTDB | -help |
94-
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
95-
| -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 |
96-
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
97-
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
98-
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
99-
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
89+
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
90+
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
91+
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
92+
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
93+
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
94+
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
95+
| -sql_dialect `<sql_dialect>` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table |
96+
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
97+
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
98+
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
99+
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
100+
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
101+
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
102+
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
103+
| -help | Flag | No | Displays help information for the CLI tool. | -help |
100104

101105
Following is a cli command which connects the host with IP
102106
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.

‎src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -79,17 +79,21 @@ Enter ```quit``` or `exit` can exit Cli.
7979

8080
## 2. Cli Parameters
8181

82-
| Parameter name | Parameter type | Required | Description | Example |
83-
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
84-
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
85-
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
86-
| -help | No parameters | No | Print help information for IoTDB | -help |
87-
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
88-
| -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 |
89-
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
90-
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
91-
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
92-
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
82+
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
83+
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
84+
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
85+
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
86+
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
87+
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
88+
| -sql_dialect `<sql_dialect>` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table |
89+
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
90+
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
91+
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
92+
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
93+
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
94+
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
95+
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
96+
| -help | Flag | No | Displays help information for the CLI tool. | -help |
9397

9498
Following is a cli command which connects the host with IP
9599
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.

‎src/UserGuide/V1.3.x/Tools-System/CLI_apache.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -82,17 +82,20 @@ Enter ```quit``` or `exit` can exit Cli.
8282

8383
### Cli Parameters
8484

85-
| Parameter name | Parameter type | Required | Description | Example |
86-
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
87-
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
88-
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
89-
| -help | No parameters | No | Print help information for IoTDB | -help |
90-
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
91-
| -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 |
92-
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
93-
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
94-
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
95-
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
85+
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
86+
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
87+
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
88+
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
89+
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
90+
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
91+
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
92+
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
93+
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
94+
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
95+
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
96+
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
97+
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
98+
| -help | Flag | No | Displays help information for the CLI tool. | -help |
9699

97100
Following is a cli command which connects the host with IP
98101
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.

‎src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md‎

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,17 +68,20 @@ Enter ```quit``` or `exit` can exit Cli.
6868

6969
## Cli Parameters
7070

71-
| Parameter name | Parameter type | Required | Description | Example |
72-
| :--------------------------- | :------------------------- | :------- | :----------------------------------------------------------- | :------------------ |
73-
| -disableISO8601 | No parameters | No | If this parameter is set, IoTDB will print the timestamp in digital form | -disableISO8601 |
74-
| -h <`host`> | string, no quotation marks | Yes | The IP address of the IoTDB server | -h 10.129.187.21 |
75-
| -help | No parameters | No | Print help information for IoTDB | -help |
76-
| -p <`rpcPort`> | int | Yes | The rpc port number of the IoTDB server. IoTDB runs on rpc port 6667 by default | -p 6667 |
77-
| -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 |
78-
| -u <`username`> | string, no quotation marks | Yes | User name used for IoTDB to connect the server | -u root |
79-
| -maxPRC <`maxPrintRowCount`> | int | No | Set the maximum number of rows that IoTDB returns | -maxPRC 10 |
80-
| -e <`execute`> | string | No | manipulate IoTDB in batches without entering cli input mode | -e "show databases" |
81-
| -c | empty | No | If the server enables `rpc_thrift_compression_enable=true`, then cli must use `-c` | -c |
71+
| **Parameter** | **Type** | **Required** | **Description** | **Example** |
72+
| -------------------------- | -------- | ------------ |-----------------------------------------------------------------------------------| ------------------- |
73+
| -h `<host>` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 |
74+
| -p `<rpcPort>` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 |
75+
| -u `<username>` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root |
76+
| -pw `<password>` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root |
77+
| -e `<execute>` | string | No | Batch operations in non-interactive mode. | -e "show databases" |
78+
| -c | Flag | No | Required if rpc_thrift_compression_enable=true on the server. | -c |
79+
| -disableISO8601 | Flag | No | If set, timestamps will be displayed as numeric values instead of ISO8601 format. | -disableISO8601 |
80+
| -usessl `<use_ssl>` | Boolean | No | Enable SSL connection | -usessl true |
81+
| -ts `<trust_store>` | string | No | SSL certificate store path | -ts /path/to/truststore |
82+
| -tpw `<trust_store_pwd>` | string | No | SSL certificate store password | -tpw myTrustPassword |
83+
| -timeout `<queryTimeout>` | int | No | Query timeout (seconds). If not set, the server's configuration will be used. | -timeout 30 |
84+
| -help | Flag | No | Displays help information for the CLI tool. | -help |
8285

8386
Following is a cli command which connects the host with IP
8487
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.

0 commit comments

Comments
 (0)