diff --git a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index a097f1414..52cd13240 100644 --- a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -255,14 +255,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux / MacOS :** -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### 4.1.2 Removing a ConfigNode @@ -301,9 +305,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -319,14 +329,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux / MacOS:** -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -365,7 +379,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Issues diff --git a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 33311caf1..2b1f36ebb 100644 --- a/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -303,14 +303,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux / MacOS :** -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### 4.1.2 Removing a ConfigNode @@ -349,9 +353,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -367,14 +377,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux / MacOS:** -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -383,13 +397,13 @@ sbin/start-datanode.bat 1. Connect to the cluster using the CLI and confirm the RPC address and port of the DataNode to be removed: -```Plain +```sql show datanodes; ``` Example output: -```Plain +```sql IoTDB> show datanodes +------+-------+----------+-------+-------------+---------------+ |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| @@ -413,7 +427,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Issues diff --git a/src/UserGuide/Master/Table/Tools-System/CLI.md b/src/UserGuide/Master/Table/Tools-System/CLI.md index 89c3e054d..c8ae8cb21 100644 --- a/src/UserGuide/Master/Table/Tools-System/CLI.md +++ b/src/UserGuide/Master/Table/Tools-System/CLI.md @@ -39,9 +39,15 @@ Shell> bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect #### **Windows** ```Bash +# Before version V2.0.4.x Shell> sbin\start-cli.bat -sql_dialect table #or Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table + +# V2.0.4.x and later versions +Shell> sbin\windows\start-cli.bat -sql_dialect table +#or +Shell> sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table ``` **Parameter Explanation** diff --git a/src/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md b/src/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md index 1c564820c..921cc3783 100644 --- a/src/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md @@ -56,10 +56,17 @@ The data export tool `export-data.sh/bat` is located in the `tools` directory an -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 CSV-Specific Parameters @@ -90,10 +97,17 @@ Parse error: Missing required option: db -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 SQL-Specific Parameters @@ -125,9 +139,15 @@ Parse error: Missing required option: db -t [-pfn ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md b/src/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md index f8084f79c..c7d63735a 100644 --- a/src/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md @@ -5,7 +5,7 @@ IoTDB supports three methods for data import: - Data Import Tool: Use the `import-data.sh/bat` script in the `tools` directory to manually import CSV, SQL, or TsFile (open-source time-series file format) data into IoTDB. - `TsFile` Auto-Loading Feature -- Load `TsFile` SQL +- Load `TsFile` SQL
@@ -57,9 +57,9 @@ IoTDB supports three methods for data import: | `-tz` | `--timezone` | Timezone (e.g., `+08:00`, `-01:00`). | No | System default | | `-help` | `--help` | Display help (general or format-specific: `-help csv`). | No | - | -### 2.2 CSV Format +### 2.2 CSV Format -#### 2.2.1 Command +#### 2.2.1 Command ```Shell # Unix/OS X > tools/import-data.sh -ft [-sql_dialect] -db -table
@@ -69,14 +69,22 @@ IoTDB supports three methods for data import: [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` -#### 2.2.2 CSV-Specific Parameters +#### 2.2.2 CSV-Specific Parameters | Short | Full Parameter | Description | Required | Default | | ---------------- | ------------------------------- |----------------------------------------------------------| ---------- |-----------------| @@ -87,7 +95,7 @@ IoTDB supports three methods for data import: | `-ti` | `--type_infer` | Type mapping (e.g., `BOOLEAN=text,INT=long`). | No | - | | `-tp` | `--timestamp_precision` | Timestamp precision: `ms`, `us`, `ns`. | No | `ms` | -#### 2.2.3 Examples +#### 2.2.3 Examples ```Shell # Valid Example @@ -107,7 +115,7 @@ There are no tables or the target table table5 does not exist - Special Character Escaping Rules: If a text-type field contains special characters (e.g., commas `,`), they must be escaped using a backslash (`\`). - Supported Time Formats: `yyyy-MM-dd'T'HH:mm:ss`, `yyyy-MM-dd HH:mm:ss`, or `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. -- Timestamp Column Requirement: The timestamp column must be the first column in the data file. +- Timestamp Column Requirement: The timestamp column must be the first column in the data file. 2. CSV File Example @@ -118,9 +126,9 @@ time,region,device,model,temperature,humidity ``` -### 2.3 SQL Format +### 2.3 SQL Format -#### 2.3.1 Command +#### 2.3.1 Command ```Shell # Unix/OS X @@ -130,13 +138,20 @@ time,region,device,model,temperature,humidity [-batch ] [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` -#### 2.3.2 SQL-Specific Parameters +#### 2.3.2 SQL-Specific Parameters | Short | Full Parameter | Description | Required | Default | | -------------- | ------------------------------- | -------------------------------------------------------------------- | ---------- | ------------------ | @@ -144,7 +159,7 @@ time,region,device,model,temperature,humidity | `-lpf` | `--lines_per_failed_file` | Max lines per failed file. | No | `100000`
Range: 0 to Integer.Max(2147483647). | | `-batch` | `--batch_size` | Rows processed per API call. | No | `100000`
Range: 0 to Integer.Max(2147483647). | -#### 2.3.3 Examples +#### 2.3.3 Examples ```Shell # Valid Example @@ -158,9 +173,9 @@ Source file or directory ./sql/dump1_1.sql does not exist # Log Example Fail to insert measurements '[column.name]' caused by [data type is not consistent, input '[column.value]', registered '[column.DataType]'] ``` -### 2.4 TsFile Format +### 2.4 TsFile Format -#### 2.4.1 Command +#### 2.4.1 Command ```Shell # Unix/OS X @@ -170,12 +185,19 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste [-tn ] [-tz ] [-tp ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` -#### 2.4.2 TsFile-Specific Parameters +#### 2.4.2 TsFile-Specific Parameters | Short | Full Parameter | Description | Required | Default | | ----------- | ----------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------- | --------------------------- | @@ -185,7 +207,7 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste | `-fd` | `--fail_dir` | Target directory for `mv`/`cp` actions on failure. Required if `-of` is `mv`/`cp`. The file name will be flattened and concatenated with the original file name. | Conditional | `${EXEC_DIR}/fail` | | `-tp` | `--timestamp_precision` | TsFile timestamp precision: `ms`, `us`, `ns`.
For non-remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The system will manually verify if the timestamp precision matches the server. If it does not match, an error will be returned.
​For remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The Pipe system will automatically verify if the timestamp precision matches. If it does not match, a Pipe error will be returned. | No | `ms` | -#### 2.4.3 Examples +#### 2.4.3 Examples ```Shell # Valid Example @@ -225,7 +247,7 @@ load_active_listening_dir/ ``` - Table model TsFile - - `temperature-table.TSFILE`: will be imported into the `temperature` database (because it is located in the `sensors/temperature/` directory) + - `temperature-table.TSFILE`: will be imported into the `temperature` database (because it is located in the `sensors/temperature/` directory) ### 3.3 Notes diff --git a/src/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md b/src/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md index 185514f25..f278576e4 100644 --- a/src/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md +++ b/src/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 Examples diff --git a/src/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md b/src/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md index 94fb11246..cca314db4 100644 --- a/src/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md +++ b/src/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# Before version V2.0.4.x tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x and later versions +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 Examples diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 3bb1c5139..3d2ad29ba 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -263,7 +263,11 @@ sbin/start-confignode.sh # Windows # First switch to the IoTDB root directory -sbin/start-confignode.bat +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` Parameter introduction: @@ -306,8 +310,11 @@ Then use the script to remove the ConfigNode. Script command: sbin/remove-confignode.sh [confignode_id] #Windows -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] ``` ### 4.2 DataNode Node Maintenance @@ -330,7 +337,11 @@ sbin/start-datanode.sh # Windows # First switch to the IoTDB root directory -sbin/start-datanode.bat +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` Parameter introduction: @@ -375,7 +386,11 @@ Then use the script to remove the DataNode. Script command: sbin/remove-datanode.sh [datanode_id] #Windows -sbin/remove-datanode.bat [datanode_id] +# Before version V2.0.4.x +sbin\remove-datanode.bat [datanode_id] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [datanode_id] ``` ## 5. Questions diff --git a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index b373cae89..e87e1cac4 100644 --- a/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -294,7 +294,6 @@ This following section will introduce the specific configuration items in the `i | Effective | After restarting the system | - ## 4. Maintenance ### 4.1 ConfigNode Maintenance @@ -310,14 +309,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux /** **MacOS**: -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### Removing a ConfigNode @@ -356,9 +359,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -374,14 +383,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux /** **MacOS**: -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -420,7 +433,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Questions diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md index e2a3ca1b2..2c7563f30 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md @@ -398,8 +398,12 @@ To enable GC log, just add a parameter "printgc" when you start the DataNode. nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & ``` Or -```cmd +```bash +# Before version V2.0.4.x sbin\start-datanode.bat printgc + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat printgc ``` GC log is stored at `IOTDB_HOME/logs/gc.log`. diff --git a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md index 3c6e3f938..dc91fa81f 100644 --- a/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md @@ -398,8 +398,12 @@ To enable GC log, just add a parameter "printgc" when you start the DataNode. nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & ``` Or -```cmd +```bash +# Before version V2.0.4.x sbin\start-datanode.bat printgc + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat printgc ``` GC log is stored at `IOTDB_HOME/logs/gc.log`. diff --git a/src/UserGuide/Master/Tree/Tools-System/CLI.md b/src/UserGuide/Master/Tree/Tools-System/CLI.md index 9dd4a1248..665af2052 100644 --- a/src/UserGuide/Master/Tree/Tools-System/CLI.md +++ b/src/UserGuide/Master/Tree/Tools-System/CLI.md @@ -49,7 +49,7 @@ Here is an example where the cluster is started locally and the user has not cha 6667
If you need to connect to the remote DataNode or changes the rpc port number of the DataNode running, set the specific IP and RPC PORT at -h and -p.
-You also can set your own environment variable at the front of the start script ("/sbin/start-cli.sh" for linux and "/sbin/start-cli.bat" for windows) +You also can set your own environment variable at the front of the start script The Linux and MacOS system startup commands are as follows: @@ -60,7 +60,11 @@ Shell > bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root The Windows system startup commands are as follows: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root + +# V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root ``` After operating these commands, the cli can be started successfully. The successful status will be as follows: @@ -106,7 +110,11 @@ Shell > bash sbin/start-cli.sh -h 10.129.187.21 -p 6667 -u root -pw root -disabl The Windows system startup commands are as follows: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 + +# # V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 ``` ### 2.3 CLI Special Command @@ -252,7 +260,11 @@ Shell > bash sbin/start-cli.sh -h {host} -p {rpcPort} -u {user} -pw {password} - The Windows system commands: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} + +# V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} ``` In the Windows environment, the SQL statement of the -e parameter needs to use ` `` ` to replace `" "` diff --git a/src/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md b/src/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md index f349f4b8f..5601f3b8a 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md @@ -50,9 +50,15 @@ The data export tool, export-data.sh (Unix/OS X) or export-data.bat (Windows), l [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t + [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 CSV-Specific Parameters @@ -84,9 +90,15 @@ Parse error: Missing required option: t -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 SQL-Specific Parameters @@ -119,8 +131,13 @@ Parse error: Missing required option: t -t [-pfn ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md b/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md index efa6ba679..e330c0564 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md @@ -51,9 +51,9 @@ IoTDB supports three methods for data import: | `-tz` | `--timezone` | Timezone (e.g., `+08:00`, `-01:00`). | No | System default | | `-help` | `--help` | Display help (general or format-specific: `-help csv`). | No | - | -### 2.2 CSV Format +### 2.2 CSV Format -#### 2.2.1 Command +#### 2.2.1 Command ```Shell # Unix/OS X > tools/import-data.sh -ft [-h ] [-p ] [-u ] [-pw ] @@ -62,13 +62,20 @@ IoTDB supports three methods for data import: [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` -#### 2.2.2 CSV-Specific Parameters +#### 2.2.2 CSV-Specific Parameters | Short | Full Parameter | Description | Required | Default | | ---------------- | ------------------------------- |----------------------------------------------------------| ---------- |-----------------| @@ -79,7 +86,7 @@ IoTDB supports three methods for data import: | `-ti` | `--type_infer` | Type mapping (e.g., `BOOLEAN=text,INT=long`). | No | - | | `-tp` | `--timestamp_precision` | Timestamp precision: `ms`, `us`, `ns`. | No | `ms` | -#### 2.2.3 Examples +#### 2.2.3 Examples ```Shell # Valid Example @@ -139,9 +146,9 @@ Time,Device,str(TEXT),var(INT32) ``` -### 2.3 SQL Format +### 2.3 SQL Format -#### 2.3.1 Command +#### 2.3.1 Command ```Shell # Unix/OS X @@ -150,12 +157,18 @@ Time,Device,str(TEXT),var(INT32) [-batch ] [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` -#### 2.3.2 SQL-Specific Parameters +#### 2.3.2 SQL-Specific Parameters | Short | Full Parameter | Description | Required | Default | | -------------- | ------------------------------- | -------------------------------------------------------------------- | ---------- | ------------------ | @@ -163,7 +176,7 @@ Time,Device,str(TEXT),var(INT32) | `-lpf` | `--lines_per_failed_file` | Max lines per failed file. | No | `100000`
Range: 0 to Integer.Max(2147483647). | | `-batch` | `--batch_size` | Rows processed per API call. | No | `100000`
Range: 0 to Integer.Max(2147483647). | -#### 2.3.3 Examples +#### 2.3.3 Examples ```Shell # Valid Example @@ -179,9 +192,9 @@ error: Source file or directory /path/sql does not exist > tools/import-data.sh -ft sql -s /path/sql -tn 0 error: Invalid thread number '0'. Please set a positive integer. ``` -### 2.4 TsFile Format +### 2.4 TsFile Format -#### 2.4.1 Command +#### 2.4.1 Command ```Shell # Unix/OS X @@ -190,11 +203,17 @@ error: Invalid thread number '0'. Please set a positive integer. [-tn ] [-tz ] [-tp ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` -#### 2.4.2 TsFile-Specific Parameters +#### 2.4.2 TsFile-Specific Parameters | Short | Full Parameter | Description | Required | Default | | ----------- | ----------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------- | --------------------------- | @@ -204,7 +223,7 @@ error: Invalid thread number '0'. Please set a positive integer. | `-fd` | `--fail_dir` | Target directory for `mv`/`cp` actions on failure. Required if `-of` is `mv`/`cp`. The file name will be flattened and concatenated with the original file name. | Conditional | `${EXEC_DIR}/fail` | | `-tp` | `--timestamp_precision` | TsFile timestamp precision: `ms`, `us`, `ns`.
For non-remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The system will manually verify if the timestamp precision matches the server. If it does not match, an error will be returned.
​For remote TsFile imports: Use -tp to specify the timestamp precision of the TsFile. The Pipe system will automatically verify if the timestamp precision matches. If it does not match, a Pipe error will be returned. | No | `ms` | -#### 2.4.3 Examples +#### 2.4.3 Examples ```Shell # Valid Example diff --git a/src/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md b/src/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md index 7e11b9d3a..e6b102d06 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md +++ b/src/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 Examples diff --git a/src/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md b/src/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md index d4a1aa68d..c3018730e 100644 --- a/src/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md +++ b/src/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# Before version V2.0.4.x tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x and later versions +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 Examples diff --git a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index a097f1414..52cd13240 100644 --- a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -255,14 +255,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux / MacOS :** -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### 4.1.2 Removing a ConfigNode @@ -301,9 +305,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -319,14 +329,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux / MacOS:** -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -365,7 +379,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Issues diff --git a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 33311caf1..2b1f36ebb 100644 --- a/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -303,14 +303,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux / MacOS :** -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### 4.1.2 Removing a ConfigNode @@ -349,9 +353,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -367,14 +377,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux / MacOS:** -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -383,13 +397,13 @@ sbin/start-datanode.bat 1. Connect to the cluster using the CLI and confirm the RPC address and port of the DataNode to be removed: -```Plain +```sql show datanodes; ``` Example output: -```Plain +```sql IoTDB> show datanodes +------+-------+----------+-------+-------------+---------------+ |NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum| @@ -413,7 +427,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Issues diff --git a/src/UserGuide/latest-Table/Tools-System/CLI.md b/src/UserGuide/latest-Table/Tools-System/CLI.md index 89c3e054d..c8ae8cb21 100644 --- a/src/UserGuide/latest-Table/Tools-System/CLI.md +++ b/src/UserGuide/latest-Table/Tools-System/CLI.md @@ -39,9 +39,15 @@ Shell> bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect #### **Windows** ```Bash +# Before version V2.0.4.x Shell> sbin\start-cli.bat -sql_dialect table #or Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table + +# V2.0.4.x and later versions +Shell> sbin\windows\start-cli.bat -sql_dialect table +#or +Shell> sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table ``` **Parameter Explanation** diff --git a/src/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md b/src/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md index 1c564820c..921cc3783 100644 --- a/src/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md @@ -56,10 +56,17 @@ The data export tool `export-data.sh/bat` is located in the `tools` directory an -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 CSV-Specific Parameters @@ -90,10 +97,17 @@ Parse error: Missing required option: db -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 SQL-Specific Parameters @@ -125,9 +139,15 @@ Parse error: Missing required option: db -t [-pfn ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md b/src/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md index 726ada898..c7d63735a 100644 --- a/src/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md @@ -69,11 +69,19 @@ IoTDB supports three methods for data import: [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 CSV-Specific Parameters @@ -130,10 +138,17 @@ time,region,device,model,temperature,humidity [-batch ] [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` #### 2.3.2 SQL-Specific Parameters @@ -170,10 +185,17 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste [-tn ] [-tz ] [-tp ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md b/src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md index 185514f25..f278576e4 100644 --- a/src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md +++ b/src/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 Examples diff --git a/src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md b/src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md index 94fb11246..cca314db4 100644 --- a/src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md +++ b/src/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# Before version V2.0.4.x tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x and later versions +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 Examples diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 3bb1c5139..3d2ad29ba 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -263,7 +263,11 @@ sbin/start-confignode.sh # Windows # First switch to the IoTDB root directory -sbin/start-confignode.bat +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` Parameter introduction: @@ -306,8 +310,11 @@ Then use the script to remove the ConfigNode. Script command: sbin/remove-confignode.sh [confignode_id] #Windows -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] ``` ### 4.2 DataNode Node Maintenance @@ -330,7 +337,11 @@ sbin/start-datanode.sh # Windows # First switch to the IoTDB root directory -sbin/start-datanode.bat +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` Parameter introduction: @@ -375,7 +386,11 @@ Then use the script to remove the DataNode. Script command: sbin/remove-datanode.sh [datanode_id] #Windows -sbin/remove-datanode.bat [datanode_id] +# Before version V2.0.4.x +sbin\remove-datanode.bat [datanode_id] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [datanode_id] ``` ## 5. Questions diff --git a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 5ef577588..e87e1cac4 100644 --- a/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -309,14 +309,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case **Linux /** **MacOS**: -```Plain +```Bash sbin/start-confignode.sh ``` **Windows:** -```Plain -sbin/start-confignode.bat +```Bash +# Before version V2.0.4.x +sbin\start-confignode.bat + +# V2.0.4.x and later versions +sbin\windows\start-confignode.bat ``` #### Removing a ConfigNode @@ -355,9 +359,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port] **Windows:** ```Bash -sbin/remove-confignode.bat [confignode_id] +# Before version V2.0.4.x +sbin\remove-confignode.bat [confignode_id] +# Or: +sbin\remove-confignode.bat [cn_internal_address:cn_internal_port] + +# V2.0.4.x and later versions +sbin\windows\remove-confignode.bat [confignode_id] # Or: -sbin/remove-confignode.bat [cn_internal_address:cn_internal_port] +sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port] ``` ### 4.2 DataNode Maintenance @@ -373,14 +383,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in **Linux /** **MacOS**: -```Plain +```Bash sbin/start-datanode.sh ``` **Windows:** -```Plain -sbin/start-datanode.bat +```Bash +# Before version V2.0.4.x +sbin\start-datanode.bat + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat ``` **Note:** After adding a DataNode, the cluster load will gradually balance across all nodes as new writes arrive and old data expires (if TTL is set). @@ -419,7 +433,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port] **Windows:** ```Bash -sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port] +# Before version V2.0.4.x +sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port] + +# V2.0.4.x and later versions +sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port] ``` ## 5. Common Questions diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md index e2a3ca1b2..2c7563f30 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md @@ -398,8 +398,12 @@ To enable GC log, just add a parameter "printgc" when you start the DataNode. nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & ``` Or -```cmd +```bash +# Before version V2.0.4.x sbin\start-datanode.bat printgc + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat printgc ``` GC log is stored at `IOTDB_HOME/logs/gc.log`. diff --git a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md index 3c6e3f938..dc91fa81f 100644 --- a/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md +++ b/src/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md @@ -398,8 +398,12 @@ To enable GC log, just add a parameter "printgc" when you start the DataNode. nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & ``` Or -```cmd +```bash +# Before version V2.0.4.x sbin\start-datanode.bat printgc + +# V2.0.4.x and later versions +sbin\windows\start-datanode.bat printgc ``` GC log is stored at `IOTDB_HOME/logs/gc.log`. diff --git a/src/UserGuide/latest/Tools-System/CLI.md b/src/UserGuide/latest/Tools-System/CLI.md index 9dd4a1248..665af2052 100644 --- a/src/UserGuide/latest/Tools-System/CLI.md +++ b/src/UserGuide/latest/Tools-System/CLI.md @@ -49,7 +49,7 @@ Here is an example where the cluster is started locally and the user has not cha 6667
If you need to connect to the remote DataNode or changes the rpc port number of the DataNode running, set the specific IP and RPC PORT at -h and -p.
-You also can set your own environment variable at the front of the start script ("/sbin/start-cli.sh" for linux and "/sbin/start-cli.bat" for windows) +You also can set your own environment variable at the front of the start script The Linux and MacOS system startup commands are as follows: @@ -60,7 +60,11 @@ Shell > bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root The Windows system startup commands are as follows: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root + +# V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root ``` After operating these commands, the cli can be started successfully. The successful status will be as follows: @@ -106,7 +110,11 @@ Shell > bash sbin/start-cli.sh -h 10.129.187.21 -p 6667 -u root -pw root -disabl The Windows system startup commands are as follows: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 + +# # V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 ``` ### 2.3 CLI Special Command @@ -252,7 +260,11 @@ Shell > bash sbin/start-cli.sh -h {host} -p {rpcPort} -u {user} -pw {password} - The Windows system commands: ```shell +# Before version V2.0.4.x Shell > sbin\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} + +# V2.0.4.x and later versions +Shell > sbin\windows\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} ``` In the Windows environment, the SQL statement of the -e parameter needs to use ` `` ` to replace `" "` diff --git a/src/UserGuide/latest/Tools-System/Data-Export-Tool.md b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md index f349f4b8f..5601f3b8a 100644 --- a/src/UserGuide/latest/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -50,9 +50,15 @@ The data export tool, export-data.sh (Unix/OS X) or export-data.bat (Windows), l [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t + [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 CSV-Specific Parameters @@ -84,9 +90,15 @@ Parse error: Missing required option: t -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 SQL-Specific Parameters @@ -119,8 +131,13 @@ Parse error: Missing required option: t -t [-pfn ] [-q ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/latest/Tools-System/Data-Import-Tool.md b/src/UserGuide/latest/Tools-System/Data-Import-Tool.md index 4387a9aea..e330c0564 100644 --- a/src/UserGuide/latest/Tools-System/Data-Import-Tool.md +++ b/src/UserGuide/latest/Tools-System/Data-Import-Tool.md @@ -62,10 +62,17 @@ IoTDB supports three methods for data import: [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 CSV-Specific Parameters @@ -150,9 +157,15 @@ Time,Device,str(TEXT),var(INT32) [-batch ] [-tn ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` #### 2.3.2 SQL-Specific Parameters @@ -190,9 +203,15 @@ error: Invalid thread number '0'. Please set a positive integer. [-tn ] [-tz ] [-tp ] # Windows +# Before version V2.0.4.x > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x and later versions +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 TsFile-Specific Parameters diff --git a/src/UserGuide/latest/Tools-System/Schema-Export-Tool.md b/src/UserGuide/latest/Tools-System/Schema-Export-Tool.md index 7e11b9d3a..e6b102d06 100644 --- a/src/UserGuide/latest/Tools-System/Schema-Export-Tool.md +++ b/src/UserGuide/latest/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# Before version V2.0.4.x > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x and later versions +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 Examples diff --git a/src/UserGuide/latest/Tools-System/Schema-Import-Tool.md b/src/UserGuide/latest/Tools-System/Schema-Import-Tool.md index d4a1aa68d..c3018730e 100644 --- a/src/UserGuide/latest/Tools-System/Schema-Import-Tool.md +++ b/src/UserGuide/latest/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# Before version V2.0.4.x tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x and later versions +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 Examples diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index c260e69a0..817256f96 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -261,7 +261,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` #### 4.1.2 移除ConfigNode节点 @@ -307,7 +311,11 @@ sbin/start-datanode.sh #Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 说明：在添加DataNode后，随着新的写入到来（以及旧数据过期，如果设置了TTL），集群负载会逐渐向新的DataNode均衡，最终在所有节点上达到存算资源的均衡。 diff --git a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 0a2d6676c..6369267ab 100644 --- a/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -315,7 +315,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` #### 4.1.2 移除ConfigNode节点 @@ -361,7 +365,11 @@ sbin/start-datanode.sh #Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 说明：在添加DataNode后，随着新的写入到来（以及旧数据过期，如果设置了TTL），集群负载会逐渐向新的DataNode均衡，最终在所有节点上达到存算资源的均衡。 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/CLI.md b/src/zh/UserGuide/Master/Table/Tools-System/CLI.md index 7c6e55b16..91ece8f04 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/CLI.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/CLI.md @@ -40,9 +40,15 @@ Shell> bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect - Windows 系统常用启动命令为： ```Shell +# V2.0.4.x 版本之前 Shell> sbin\start-cli.bat -sql_dialect table 或 Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table + +# V2.0.4.x 版本及之后 +Shell> sbin\windows\start-cli.bat -sql_dialect table +或 +Shell> sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table ``` 其中： diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md index 185020c60..0855802c9 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md @@ -60,10 +60,17 @@ -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 私有参数 @@ -98,10 +105,17 @@ Parse error: Missing required option: db -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 私有参数 @@ -135,9 +149,15 @@ Parse error: Missing required option: db -t [-pfn ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md index 97cce6f4b..3d5d041cf 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md @@ -72,11 +72,19 @@ IoTDB 支持三种方式进行数据导入： [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 私有参数 @@ -134,10 +142,17 @@ time,region,device,model,temperature,humidity [-batch ] [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` #### 2.3.2 私有参数 @@ -174,10 +189,17 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste [-tn ] [-tz ] [-tp ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md index 0dc236059..8243acec7 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md index 3060e5fa6..26d704be3 100644 --- a/src/zh/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md +++ b/src/zh/UserGuide/Master/Table/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# V2.0.4.x 版本之前 tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x 版本及之后 +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 9b8573a97..9a4b66b4d 100644 --- a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -262,7 +262,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` 参数介绍： @@ -325,7 +329,11 @@ sbin/start-datanode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 参数介绍： diff --git a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 7dbeba90f..8a4fe3c53 100644 --- a/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -299,7 +299,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` 参数介绍： @@ -363,7 +367,11 @@ sbin/start-datanode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 参数介绍： diff --git a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md index be97c7962..ffda14365 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md +++ b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_apache.md @@ -393,7 +393,11 @@ nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & 或者 ```bash +# V2.0.4.x 版本之前 sbin\start-datanode.bat printgc + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat printgc ``` GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log 文件，每个文件最多 10MB。 diff --git a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md index 95f9baf68..20e27fbbb 100644 --- a/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md +++ b/src/zh/UserGuide/Master/Tree/Reference/DataNode-Config-Manual_timecho.md @@ -393,7 +393,11 @@ nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & 或者 ```bash +# V2.0.4.x 版本之前 sbin\start-datanode.bat printgc + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat printgc ``` GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log 文件，每个文件最多 10MB。 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/CLI.md b/src/zh/UserGuide/Master/Tree/Tools-System/CLI.md index 7c62c4aba..23d3470bc 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/CLI.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/CLI.md @@ -39,7 +39,7 @@ IOTDB 为用户提供 cli/Shell 工具用于启动客户端和服务端程序。 ### 2.1 Cli 运行方式 安装后的 IoTDB 中有一个默认用户：`root`，默认密码为`root`。用户可以使用该用户尝试运行 IoTDB 客户端以测试服务器是否正常启动。客户端启动脚本为$IOTDB_HOME/sbin 文件夹下的`start-cli`脚本。启动脚本时需要指定运行 IP 和 RPC PORT。以下为服务器在本机启动，且用户未更改运行端口号的示例，默认端口为 6667。若用户尝试连接远程服务器或更改了服务器运行的端口号，请在-h 和-p 项处使用服务器的 IP 和 RPC PORT。
-用户也可以在启动脚本的最前方设置自己的环境变量，如 JAVA_HOME 等 （对于 linux 用户，脚本路径为："/sbin/start-cli.sh"； 对于 windows 用户，脚本路径为："/sbin/start-cli.bat") +用户也可以在启动脚本的最前方设置自己的环境变量，如 JAVA_HOME 等。 Linux 系统与 MacOS 系统启动命令如下： @@ -49,7 +49,11 @@ Shell > bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root Windows 系统启动命令如下： ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root ``` 回车后即可成功启动客户端。启动后出现如图提示即为启动成功。 @@ -89,7 +93,11 @@ Shell > bash sbin/start-cli.sh -h 10.129.187.21 -p 6667 -u root -pw root -disabl Windows 系统启动命令如下： ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 ``` ### 2.3 CLI 特殊命令 @@ -222,7 +230,11 @@ Shell > bash sbin/start-cli.sh -h {host} -p {rpcPort} -u {user} -pw {password} - Windows 系统指令 ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} ``` 在 Windows 环境下，-e 参数的 SQL 语句需要使用` `` `对于`" "`进行替换 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md index d28536275..cfc3b5105 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Export-Tool.md @@ -54,9 +54,15 @@ [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t + [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 私有参数 @@ -92,9 +98,15 @@ Parse error: Missing required option: t -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 私有参数 @@ -129,8 +141,13 @@ Parse error: Missing required option: t -t [-pfn ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md index 0d8bede0b..57e843a33 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/Data-Import-Tool.md @@ -68,10 +68,17 @@ IoTDB 支持三种方式进行数据导入： [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 私有参数 @@ -156,6 +163,12 @@ Time,Device,str(TEXT),var(INT32) [-batch ] [-tn ] # Windows +# V2.0.4.x 版本之前 +> tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] @@ -197,9 +210,15 @@ error: Invalid thread number '0'. Please set a positive integer. [-tn ] [-tz ] [-tp ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md index ec217b1e7..ec7298763 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md index 22bd3cc3b..7d398cccf 100644 --- a/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md +++ b/src/zh/UserGuide/Master/Tree/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# V2.0.4.x 版本之前 tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x 版本及之后 +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md index ee7bd741f..2ca470772 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -260,7 +260,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` #### 4.1.2 移除ConfigNode节点 @@ -306,7 +310,11 @@ sbin/start-datanode.sh #Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 说明：在添加DataNode后，随着新的写入到来（以及旧数据过期，如果设置了TTL），集群负载会逐渐向新的DataNode均衡，最终在所有节点上达到存算资源的均衡。 diff --git a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 0a2d6676c..6369267ab 100644 --- a/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/latest-Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -315,7 +315,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` #### 4.1.2 移除ConfigNode节点 @@ -361,7 +365,11 @@ sbin/start-datanode.sh #Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 说明：在添加DataNode后，随着新的写入到来（以及旧数据过期，如果设置了TTL），集群负载会逐渐向新的DataNode均衡，最终在所有节点上达到存算资源的均衡。 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/CLI.md b/src/zh/UserGuide/latest-Table/Tools-System/CLI.md index 7c6e55b16..91ece8f04 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/CLI.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/CLI.md @@ -40,9 +40,15 @@ Shell> bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect - Windows 系统常用启动命令为： ```Shell +# V2.0.4.x 版本之前 Shell> sbin\start-cli.bat -sql_dialect table 或 Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table + +# V2.0.4.x 版本及之后 +Shell> sbin\windows\start-cli.bat -sql_dialect table +或 +Shell> sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table ``` 其中： diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md index 185020c60..0855802c9 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Data-Export-Tool.md @@ -60,10 +60,17 @@ -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 私有参数 @@ -98,10 +105,17 @@ Parse error: Missing required option: db -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 私有参数 @@ -135,9 +149,15 @@ Parse error: Missing required option: db -t [-pfn ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-sql_dialect] -db -table
[-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-sql_dialect] -db -table
+ [-start_time] [-end_time] [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md index 49920e218..aa75f662a 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Data-Import-Tool.md @@ -72,11 +72,19 @@ IoTDB 支持三种方式进行数据导入： [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 私有参数 @@ -134,10 +142,17 @@ time,region,device,model,temperature,humidity [-batch ] [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] ``` #### 2.3.2 私有参数 @@ -174,10 +189,17 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste [-tn ] [-tz ] [-tp ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md index 0dc236059..8243acec7 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md index 3060e5fa6..26d704be3 100644 --- a/src/zh/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md +++ b/src/zh/UserGuide/latest-Table/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# V2.0.4.x 版本之前 tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x 版本及之后 +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md index 9b8573a97..9a4b66b4d 100644 --- a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md +++ b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_apache.md @@ -262,7 +262,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` 参数介绍： @@ -325,7 +329,11 @@ sbin/start-datanode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 参数介绍： diff --git a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md index 7dbeba90f..8a4fe3c53 100644 --- a/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md +++ b/src/zh/UserGuide/latest/Deployment-and-Maintenance/Cluster-Deployment_timecho.md @@ -299,7 +299,11 @@ sbin/start-confignode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-confignode.bat +# V2.0.4.x 版本之前 +sbin\start-confignode.bat + +# V2.0.4.x 版本及之后 +sbin\windows\start-confignode.bat ``` 参数介绍： @@ -363,7 +367,11 @@ sbin/start-datanode.sh # Windows # 首先切换到IoTDB根目录 -sbin/start-datanode.bat +# V2.0.4.x 版本之前 +sbin\start-datanode.bat + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat ``` 参数介绍： diff --git a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md index be97c7962..ffda14365 100644 --- a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md +++ b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_apache.md @@ -393,7 +393,11 @@ nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & 或者 ```bash +# V2.0.4.x 版本之前 sbin\start-datanode.bat printgc + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat printgc ``` GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log 文件，每个文件最多 10MB。 diff --git a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md index 95f9baf68..20e27fbbb 100644 --- a/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md +++ b/src/zh/UserGuide/latest/Reference/DataNode-Config-Manual_timecho.md @@ -393,7 +393,11 @@ nohup sbin/start-datanode.sh printgc >/dev/null 2>&1 & 或者 ```bash +# V2.0.4.x 版本之前 sbin\start-datanode.bat printgc + +# V2.0.4.x 版本及之后 +tools\windows\start-datanode.bat printgc ``` GC 日志会被存储在`IOTDB_HOME/logs/gc.log`. 至多会存储 10 个 gc.log 文件，每个文件最多 10MB。 diff --git a/src/zh/UserGuide/latest/Tools-System/CLI.md b/src/zh/UserGuide/latest/Tools-System/CLI.md index 7c62c4aba..23d3470bc 100644 --- a/src/zh/UserGuide/latest/Tools-System/CLI.md +++ b/src/zh/UserGuide/latest/Tools-System/CLI.md @@ -39,7 +39,7 @@ IOTDB 为用户提供 cli/Shell 工具用于启动客户端和服务端程序。 ### 2.1 Cli 运行方式 安装后的 IoTDB 中有一个默认用户：`root`，默认密码为`root`。用户可以使用该用户尝试运行 IoTDB 客户端以测试服务器是否正常启动。客户端启动脚本为$IOTDB_HOME/sbin 文件夹下的`start-cli`脚本。启动脚本时需要指定运行 IP 和 RPC PORT。以下为服务器在本机启动，且用户未更改运行端口号的示例，默认端口为 6667。若用户尝试连接远程服务器或更改了服务器运行的端口号，请在-h 和-p 项处使用服务器的 IP 和 RPC PORT。
-用户也可以在启动脚本的最前方设置自己的环境变量，如 JAVA_HOME 等 （对于 linux 用户，脚本路径为："/sbin/start-cli.sh"； 对于 windows 用户，脚本路径为："/sbin/start-cli.bat") +用户也可以在启动脚本的最前方设置自己的环境变量，如 JAVA_HOME 等。 Linux 系统与 MacOS 系统启动命令如下： @@ -49,7 +49,11 @@ Shell > bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root Windows 系统启动命令如下： ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root ``` 回车后即可成功启动客户端。启动后出现如图提示即为启动成功。 @@ -89,7 +93,11 @@ Shell > bash sbin/start-cli.sh -h 10.129.187.21 -p 6667 -u root -pw root -disabl Windows 系统启动命令如下： ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h 10.129.187.21 -p 6667 -u root -pw root -disableISO8601 -maxPRC 10 ``` ### 2.3 CLI 特殊命令 @@ -222,7 +230,11 @@ Shell > bash sbin/start-cli.sh -h {host} -p {rpcPort} -u {user} -pw {password} - Windows 系统指令 ```shell +# V2.0.4.x 版本之前 Shell > sbin\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} + +# V2.0.4.x 版本及之后 +Shell > sbin\windows\start-cli.bat -h {host} -p {rpcPort} -u {user} -pw {password} -e {sql for iotdb} ``` 在 Windows 环境下，-e 参数的 SQL 语句需要使用` `` `对于`" "`进行替换 diff --git a/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md index d28536275..cfc3b5105 100644 --- a/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -54,9 +54,15 @@ [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-dt ] [-lpf ] [-tf ] [-tz ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t + [-pfn ] [-dt ] [-lpf ] [-tf ] + [-tz ] [-q ] [-timeout ] ``` #### 2.2.2 私有参数 @@ -92,9 +98,15 @@ Parse error: Missing required option: t -lpf - [-tf ] [-tz ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h -p -u -pw ] -t [-pfn -aligned -lpf -tf -tz -q -timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h -p -u -pw ] + -t [-pfn -aligned + -lpf -tf -tz -q -timeout ] ``` #### 2.3.2 私有参数 @@ -129,8 +141,13 @@ Parse error: Missing required option: t -t [-pfn ] [-q ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -t [-pfn ] [-q ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\export-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -t [-pfn ] [-q ] [-timeout ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md b/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md index 0d8bede0b..57e843a33 100644 --- a/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Data-Import-Tool.md @@ -68,10 +68,17 @@ IoTDB 支持三种方式进行数据导入： [-tn ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-aligned ] [-ti ] [-tp ] [-tz ] [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-aligned ] + [-ti ] [-tp ] [-tz ] [-batch ] + [-tn ] ``` #### 2.2.2 私有参数 @@ -156,6 +163,12 @@ Time,Device,str(TEXT),var(INT32) [-batch ] [-tn ] # Windows +# V2.0.4.x 版本之前 +> tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] [-tz ] + [-batch ] [-tn ] + +# V2.0.4.x 版本及之后 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] [-tz ] [-batch ] [-tn ] @@ -197,9 +210,15 @@ error: Invalid thread number '0'. Please set a positive integer. [-tn ] [-tz ] [-tp ] # Windows +# V2.0.4.x 版本之前 > tools\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] -s -os [-sd ] -of [-fd ] [-tn ] [-tz ] [-tp ] + +# V2.0.4.x 版本及之后 +> tools\windows\import-data.bat -ft [-h ] [-p ] [-u ] [-pw ] + -s -os [-sd ] -of [-fd ] + [-tn ] [-tz ] [-tp ] ``` #### 2.4.2 私有参数 diff --git a/src/zh/UserGuide/latest/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/latest/Tools-System/Schema-Export-Tool.md index ec217b1e7..ec7298763 100644 --- a/src/zh/UserGuide/latest/Tools-System/Schema-Export-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Schema-Export-Tool.md @@ -55,10 +55,17 @@ Shell -t [-path ] [-pfn ] [-lpf ] [-timeout ] # Windows +# V2.0.4.x 版本之前 > tools\export-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -t [-path ] [-pfn ] [-lpf ] [-timeout ] + +# V2.0.4.x 版本及之后 +> tools\windows\schema\export-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -t [-path ] [-pfn ] + [-lpf ] [-timeout ] ``` ### 2.3 运行示例 diff --git a/src/zh/UserGuide/latest/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/latest/Tools-System/Schema-Import-Tool.md index 22bd3cc3b..7d398cccf 100644 --- a/src/zh/UserGuide/latest/Tools-System/Schema-Import-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Schema-Import-Tool.md @@ -52,9 +52,15 @@ tools/import-schema.sh [-sql_dialect] -db -table
-s [-fd ] [-lpf ] # Windows +# V2.0.4.x 版本之前 tools\import-schema.bat [-sql_dialect] -db -table
[-h ] [-p ] [-u ] [-pw ] -s [-fd ] [-lpf ] + +# V2.0.4.x 版本及之后 +tools\windows\schema\import-schema.bat [-sql_dialect] -db -table
+ [-h ] [-p ] [-u ] [-pw ] + -s [-fd ] [-lpf ] ``` ### 2.3 运行示例