diff --git a/src/UserGuide/Master/Tree/Tools-System/CLI_apache.md b/src/UserGuide/Master/Tree/Tools-System/CLI_apache.md index 758846624..d05045fe0 100644 --- a/src/UserGuide/Master/Tree/Tools-System/CLI_apache.md +++ b/src/UserGuide/Master/Tree/Tools-System/CLI_apache.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -sql_dialect `` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md b/src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md index 3a3807cb1..4ee1198fb 100644 --- a/src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md +++ b/src/UserGuide/Master/Tree/Tools-System/CLI_timecho.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -sql_dialect `` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/V1.3.x/Tools-System/CLI_apache.md b/src/UserGuide/V1.3.x/Tools-System/CLI_apache.md index 0173bfe64..aa34b2f42 100644 --- a/src/UserGuide/V1.3.x/Tools-System/CLI_apache.md +++ b/src/UserGuide/V1.3.x/Tools-System/CLI_apache.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md b/src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md index 87376dca4..07e4ab9ba 100644 --- a/src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md +++ b/src/UserGuide/V1.3.x/Tools-System/CLI_timecho.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/dev-1.3/Tools-System/CLI_apache.md b/src/UserGuide/dev-1.3/Tools-System/CLI_apache.md index 0173bfe64..aa34b2f42 100644 --- a/src/UserGuide/dev-1.3/Tools-System/CLI_apache.md +++ b/src/UserGuide/dev-1.3/Tools-System/CLI_apache.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/dev-1.3/Tools-System/CLI_timecho.md b/src/UserGuide/dev-1.3/Tools-System/CLI_timecho.md index 87376dca4..07e4ab9ba 100644 --- a/src/UserGuide/dev-1.3/Tools-System/CLI_timecho.md +++ b/src/UserGuide/dev-1.3/Tools-System/CLI_timecho.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/latest/Tools-System/CLI_apache.md b/src/UserGuide/latest/Tools-System/CLI_apache.md index 758846624..d05045fe0 100644 --- a/src/UserGuide/latest/Tools-System/CLI_apache.md +++ b/src/UserGuide/latest/Tools-System/CLI_apache.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -sql_dialect `` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/UserGuide/latest/Tools-System/CLI_timecho.md b/src/UserGuide/latest/Tools-System/CLI_timecho.md index 3a3807cb1..4ee1198fb 100644 --- a/src/UserGuide/latest/Tools-System/CLI_timecho.md +++ b/src/UserGuide/latest/Tools-System/CLI_timecho.md @@ -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 `` | string | No | The IP address of the IoTDB server. (Default: 127.0.0.1) | -h 127.0.0.1 | +| -p `` | int | No | The RPC port of the IoTDB server. (Default: 6667) | -p 6667 | +| -u `` | string | No | The username to connect to the IoTDB server. (Default: root) | -u root | +| -pw `` | string | No | The password to connect to the IoTDB server. (Default: root) | -pw root | +| -sql_dialect `` | string | No | The data model type: tree or table. (Default: tree) | -sql_dialect table | +| -e `` | 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 `` | Boolean | No | Enable SSL connection | -usessl true | +| -ts `` | string | No | SSL certificate store path | -ts /path/to/truststore | +| -tpw `` | string | No | SSL certificate store password | -tpw myTrustPassword | +| -timeout `` | 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. diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/CLI_apache.md b/src/zh/UserGuide/Master/Tree/Tools-System/CLI_apache.md index 62320a0e6..9e81896d7 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/CLI_apache.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/CLI_apache.md @@ -71,17 +71,22 @@ Successfully login at 127.0.0.1:6667 ### 2.2 Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -sql_dialect `` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/CLI_timecho.md b/src/zh/UserGuide/Master/Tree/Tools-System/CLI_timecho.md index e102cd6be..49e1b32f9 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/CLI_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/CLI_timecho.md @@ -65,17 +65,21 @@ Successfully login at 127.0.0.1:6667 ## 2. Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -sql_dialect `` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.md b/src/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.md index 7d0d48e73..42d6952c1 100644 --- a/src/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.md +++ b/src/zh/UserGuide/V1.3.x/Tools-System/CLI_apache.md @@ -67,17 +67,21 @@ Successfully login at 127.0.0.1:6667 ### Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/V1.3.x/Tools-System/CLI_timecho.md b/src/zh/UserGuide/V1.3.x/Tools-System/CLI_timecho.md index 605beefea..4cd3d1744 100644 --- a/src/zh/UserGuide/V1.3.x/Tools-System/CLI_timecho.md +++ b/src/zh/UserGuide/V1.3.x/Tools-System/CLI_timecho.md @@ -82,17 +82,21 @@ Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO ## CLI 特殊命令 下面列举了一些CLI的特殊命令。 -| 命令 | 描述 / 例子 | -|:---|:---| -| `set time_display_type=xxx` | 例如： long, default, ISO8601, yyyy-MM-dd HH:mm:ss | -| `show time_display_type` | 显示时间显示方式 | -| `set time_zone=xxx` | 例如： +08:00, Asia/Shanghai | -| `show time_zone` | 显示CLI的时区 | -| `set fetch_size=xxx` | 设置从服务器查询数据时的读取条数 | -| `show fetch_size` | 显示读取条数的大小 | -| `set max_display_num=xxx` | 设置 CLI 一次展示的最大数据条数， 设置为-1表示无限制 | -| `help` | 获取CLI特殊命令的提示 | -| `exit/quit` | 退出CLI | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + ## Cli 的批量操作 diff --git a/src/zh/UserGuide/dev-1.3/Tools-System/CLI_apache.md b/src/zh/UserGuide/dev-1.3/Tools-System/CLI_apache.md index 7d0d48e73..42d6952c1 100644 --- a/src/zh/UserGuide/dev-1.3/Tools-System/CLI_apache.md +++ b/src/zh/UserGuide/dev-1.3/Tools-System/CLI_apache.md @@ -67,17 +67,21 @@ Successfully login at 127.0.0.1:6667 ### Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/dev-1.3/Tools-System/CLI_timecho.md b/src/zh/UserGuide/dev-1.3/Tools-System/CLI_timecho.md index 605beefea..a4960ec6c 100644 --- a/src/zh/UserGuide/dev-1.3/Tools-System/CLI_timecho.md +++ b/src/zh/UserGuide/dev-1.3/Tools-System/CLI_timecho.md @@ -54,17 +54,23 @@ Successfully login at 127.0.0.1:6667 ## Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | + +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + + 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/latest/Tools-System/CLI_apache.md b/src/zh/UserGuide/latest/Tools-System/CLI_apache.md index 62320a0e6..9e81896d7 100644 --- a/src/zh/UserGuide/latest/Tools-System/CLI_apache.md +++ b/src/zh/UserGuide/latest/Tools-System/CLI_apache.md @@ -71,17 +71,22 @@ Successfully login at 127.0.0.1:6667 ### 2.2 Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -sql_dialect `` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | + 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。 diff --git a/src/zh/UserGuide/latest/Tools-System/CLI_timecho.md b/src/zh/UserGuide/latest/Tools-System/CLI_timecho.md index e102cd6be..49e1b32f9 100644 --- a/src/zh/UserGuide/latest/Tools-System/CLI_timecho.md +++ b/src/zh/UserGuide/latest/Tools-System/CLI_timecho.md @@ -65,17 +65,21 @@ Successfully login at 127.0.0.1:6667 ## 2. Cli 运行参数 -|参数名|参数类型|是否为必需参数| 说明| 例子 | -|:---|:---|:---|:---|:---| -|-disableISO8601 |没有参数 | 否 |如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 (timestamp)。|-disableISO8601| -|-h <`host`> |string 类型，不需要引号|是|IoTDB 客户端连接 IoTDB 服务器的 IP 地址。|-h 10.129.187.21| -|-help|没有参数|否|打印 IoTDB 的帮助信息|-help| -|-p <`rpcPort`>|int 类型|是|IoTDB 连接服务器的端口号，IoTDB 默认运行在 6667 端口。|-p 6667| -|-pw <`password`>|string 类型，不需要引号|否|IoTDB 连接服务器所使用的密码。如果没有输入密码 IoTDB 会在 Cli 端提示输入密码。|-pw root| -|-u <`username`>|string 类型，不需要引号|是|IoTDB 连接服务器锁使用的用户名。|-u root| -|-maxPRC <`maxPrintRowCount`>|int 类型|否|设置 IoTDB 返回客户端命令行中所显示的最大行数。|-maxPRC 10| -|-e <`execute`> |string 类型|否|在不进入客户端输入模式的情况下，批量操作 IoTDB|-e "show databases"| -|-c | 空 | 否 | 如果服务器设置了 `rpc_thrift_compression_enable=true`, 则 CLI 必须使用 `-c` | -c | +| **参数名** | **参数类型** | **是否为必需参数** | **说明** | **示例** | +|:-----------------------------|:-----------|:------------|:-----------------------------------------------------------|:---------------------| +| -h `` | string 类型 | 否 | IoTDB 客户端连接 IoTDB 服务器的 IP 地址， 默认使用：127.0.0.1。 | -h 127.0.0.1 | +| -p `` | int 类型 | 否 | IoTDB 客户端连接服务器的端口号，IoTDB 默认使用 6667。 | -p 6667 | +| -u `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的用户名，默认使用 root。 | -u root | +| -pw `` | string 类型 | 否 | IoTDB 客户端连接服务器所使用的密码，默认使用 TimechoDB@2021（V2.0.6版本之前为root）。 | -pw root | +| -sql_dialect `` | string 类型 | 否 | 目前可选 tree（树模型） 、table（表模型），默认 tree | -sql_dialect table | +| -e `` | string 类型 | 否 | 在不进入客户端输入模式的情况下，批量操作 IoTDB。 | -e "show databases" | +| -c | 空 | 否 | 如果服务器设置了 rpc_thrift_compression_enable=true， 则 CLI 必须使用 -c | -c | +| -disableISO8601 | 空 | 否 | 如果设置了这个参数，IoTDB 将以数字的形式打印时间戳 （timestamp）。 | -disableISO8601 | +| -usessl `` | Boolean 类型 | 否 | 否开启 ssl 连接 | -usessl true | +| -ts `` | string 类型 | 否 | ssl 证书存储路径 | -ts /path/to/truststore | +| -tpw `` | string 类型 | 否 | ssl 证书存储密码 | -tpw myTrustPassword | +| -timeout `` | int 类型 | 否 | 查询超时时间（秒）。如果未设置，则使用服务器的配置。 | -timeout 30 | +| -help | 空 | 否 | 打印 IoTDB 的帮助信息。 | -help | 下面展示一条客户端命令，功能是连接 IP 为 10.129.187.21 的主机，端口为 6667 ，用户名为 root，密码为 root，以数字的形式打印时间戳，IoTDB 命令行显示的最大行数为 10。