Skip to content

Commit d382735

Browse files
committed
add new version commands of sbin and tools
1 parent 2f96d1c commit d382735

File tree

64 files changed

+839
-118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+839
-118
lines changed

src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_apache.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -255,14 +255,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case
255255

256256
**Linux / MacOS :**
257257

258-
```Plain
258+
```Bash
259259
sbin/start-confignode.sh
260260
```
261261

262262
**Windows:**
263263

264-
```Plain
265-
sbin/start-confignode.bat
264+
```Bash
265+
# Before version V2.0.4.x
266+
sbin\start-confignode.bat
267+
268+
# V2.0.4.x and later versions
269+
sbin\windows\start-confignode.bat
266270
```
267271

268272
#### 4.1.2 Removing a ConfigNode
@@ -301,9 +305,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port]
301305
**Windows:**
302306

303307
```Bash
304-
sbin/remove-confignode.bat [confignode_id]
308+
# Before version V2.0.4.x
309+
sbin\remove-confignode.bat [confignode_id]
310+
# Or:
311+
sbin\remove-confignode.bat [cn_internal_address:cn_internal_port]
312+
313+
# V2.0.4.x and later versions
314+
sbin\windows\remove-confignode.bat [confignode_id]
305315
# Or:
306-
sbin/remove-confignode.bat [cn_internal_address:cn_internal_port]
316+
sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port]
307317
```
308318

309319
### 4.2 DataNode Maintenance
@@ -319,14 +329,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in
319329

320330
**Linux / MacOS:**
321331

322-
```Plain
332+
```Bash
323333
sbin/start-datanode.sh
324334
```
325335

326336
**Windows:**
327337

328-
```Plain
329-
sbin/start-datanode.bat
338+
```Bash
339+
# Before version V2.0.4.x
340+
sbin\start-datanode.bat
341+
342+
# V2.0.4.x and later versions
343+
sbin\windows\start-datanode.bat
330344
```
331345

332346
**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]
365379
**Windows:**
366380

367381
```Bash
368-
sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port]
382+
# Before version V2.0.4.x
383+
sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port]
384+
385+
# V2.0.4.x and later versions
386+
sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port]
369387
```
370388

371389
## 5. Common Issues

src/UserGuide/Master/Table/Deployment-and-Maintenance/Cluster-Deployment_timecho.md

Lines changed: 29 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -303,14 +303,18 @@ ConfigNode maintenance includes adding and removing ConfigNodes. Common use case
303303
304304
**Linux / MacOS :**
305305
306-
```Plain
306+
```Bash
307307
sbin/start-confignode.sh
308308
```
309309
310310
**Windows:**
311311
312-
```Plain
313-
sbin/start-confignode.bat
312+
```Bash
313+
# Before version V2.0.4.x
314+
sbin\start-confignode.bat
315+
316+
# V2.0.4.x and later versions
317+
sbin\windows\start-confignode.bat
314318
```
315319
316320
#### 4.1.2 Removing a ConfigNode
@@ -349,9 +353,15 @@ sbin/remove-confignode.sh [cn_internal_address:cn_internal_port]
349353
**Windows:**
350354
351355
```Bash
352-
sbin/remove-confignode.bat [confignode_id]
356+
# Before version V2.0.4.x
357+
sbin\remove-confignode.bat [confignode_id]
358+
# Or:
359+
sbin\remove-confignode.bat [cn_internal_address:cn_internal_port]
360+
361+
# V2.0.4.x and later versions
362+
sbin\windows\remove-confignode.bat [confignode_id]
353363
# Or:
354-
sbin/remove-confignode.bat [cn_internal_address:cn_internal_port]
364+
sbin\windows\remove-confignode.bat [cn_internal_address:cn_internal_port]
355365
```
356366
357367
### 4.2 DataNode Maintenance
@@ -367,14 +377,18 @@ DataNode maintenance includes adding and removing DataNodes. Common use cases in
367377

368378
**Linux / MacOS:**
369379

370-
```Plain
380+
```Bash
371381
sbin/start-datanode.sh
372382
```
373383

374384
**Windows:**
375385

376-
```Plain
377-
sbin/start-datanode.bat
386+
```Bash
387+
# Before version V2.0.4.x
388+
sbin\start-datanode.bat
389+
390+
# V2.0.4.x and later versions
391+
sbin\windows\start-datanode.bat
378392
```
379393

380394
**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
383397

384398
1. Connect to the cluster using the CLI and confirm the RPC address and port of the DataNode to be removed:
385399

386-
```Plain
400+
```sql
387401
show datanodes;
388402
```
389403

390404
Example output:
391405

392-
```Plain
406+
```sql
393407
IoTDB> show datanodes
394408
+------+-------+----------+-------+-------------+---------------+
395409
|NodeID| Status|RpcAddress|RpcPort|DataRegionNum|SchemaRegionNum|
@@ -413,7 +427,11 @@ sbin/remove-datanode.sh [dn_rpc_address:dn_rpc_port]
413427
**Windows:**
414428

415429
```Bash
416-
sbin/remove-datanode.bat [dn_rpc_address:dn_rpc_port]
430+
# Before version V2.0.4.x
431+
sbin\remove-datanode.bat [dn_rpc_address:dn_rpc_port]
432+
433+
# V2.0.4.x and later versions
434+
sbin\windows\remove-datanode.bat [dn_rpc_address:dn_rpc_port]
417435
```
418436

419437
## 5. Common Issues

src/UserGuide/Master/Table/Tools-System/CLI.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,9 +39,15 @@ Shell> bash sbin/start-cli.sh -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect
3939
#### **Windows**
4040

4141
```Bash
42+
# Before version V2.0.4.x
4243
Shell> sbin\start-cli.bat -sql_dialect table
4344
#or
4445
Shell> sbin\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table
46+
47+
# V2.0.4.x and later versions
48+
Shell> sbin\windows\start-cli.bat -sql_dialect table
49+
#or
50+
Shell> sbin\windows\start-cli.bat -h 127.0.0.1 -p 6667 -u root -pw root -sql_dialect table
4551
```
4652

4753
**Parameter Explanation**

src/UserGuide/Master/Table/Tools-System/Data-Export-Tool.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,17 @@ The data export tool `export-data.sh/bat` is located in the `tools` directory an
5656
-t <target_directory> [-pfn <prefix_file_name>] [-dt <datatype>] [-lpf <lines_per_file>] [-tf <time_format>]
5757
[-tz <timezone>] [-q <query_command>] [-timeout <query_timeout>]
5858
# Windows
59+
# Before version V2.0.4.x
5960
> tools\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
6061
[-start_time<start_time>] [-end_time<end_time>] [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
6162
-t <target_directory> [-pfn <prefix_file_name>] [-dt <datatype>] [-lpf <lines_per_file>] [-tf <time_format>]
6263
[-tz <timezone>] [-q <query_command>] [-timeout <query_timeout>]
64+
65+
# V2.0.4.x and later versions
66+
> tools\windows\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
67+
[-start_time<start_time>] [-end_time<end_time>] [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
68+
-t <target_directory> [-pfn <prefix_file_name>] [-dt <datatype>] [-lpf <lines_per_file>] [-tf <time_format>]
69+
[-tz <timezone>] [-q <query_command>] [-timeout <query_timeout>]
6370
```
6471
#### 2.2.2 CSV-Specific Parameters
6572

@@ -90,10 +97,17 @@ Parse error: Missing required option: db
9097
-lpf <lines_per_file> - [-tf <time_format>] [-tz <timezone>] [-q <query_command>] [-timeout <query_timeout>]
9198

9299
# Windows
100+
# Before version V2.0.4.x
93101
> tools\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
94102
[-start_time<start_time>] [-end_time<end_time>] [-h <host> -p <port> -u <username> -pw <password>]
95103
-t <target_directory> [-pfn <prefix_file_name> -aligned <export aligned insert sql>
96104
-lpf <lines_per_file> -tf <time_format> -tz <timezone> -q <query_command> -timeout <query_timeout>]
105+
106+
# V2.0.4.x and later versions
107+
> tools\windows\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
108+
[-start_time<start_time>] [-end_time<end_time>] [-h <host> -p <port> -u <username> -pw <password>]
109+
-t <target_directory> [-pfn <prefix_file_name> -aligned <export aligned insert sql>
110+
-lpf <lines_per_file> -tf <time_format> -tz <timezone> -q <query_command> -timeout <query_timeout>]
97111
```
98112
#### 2.3.2 SQL-Specific Parameters
99113

@@ -125,9 +139,15 @@ Parse error: Missing required option: db
125139
-t <target_directory> [-pfn <prefix_file_name>] [-q <query_command>] [-timeout <query_timeout>]
126140

127141
# Windows
142+
# Before version V2.0.4.x
128143
> tools\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
129144
[-start_time<start_time>] [-end_time<end_time>] [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
130145
-t <target_directory> [-pfn <prefix_file_name>] [-q <query_command>] [-timeout <query_timeout>]
146+
147+
# V2.0.4.x and later versions
148+
> tools\windows\export-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
149+
[-start_time<start_time>] [-end_time<end_time>] [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
150+
-t <target_directory> [-pfn <prefix_file_name>] [-q <query_command>] [-timeout <query_timeout>]
131151
```
132152

133153
#### 2.4.2 TsFile-Specific Parameters

src/UserGuide/Master/Table/Tools-System/Data-Import-Tool.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
IoTDB supports three methods for data import:
66
- 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.
77
- `TsFile` Auto-Loading Feature
8-
- Load `TsFile` SQL
8+
- Load `TsFile` SQL
99

1010
<table style="text-align: left;">
1111
<tbody>
@@ -57,9 +57,9 @@ IoTDB supports three methods for data import:
5757
| `-tz` | `--timezone` | Timezone (e.g., `+08:00`, `-01:00`). | No | System default |
5858
| `-help` | `--help` | Display help (general or format-specific: `-help csv`). | No | - |
5959

60-
### 2.2 CSV Format
60+
### 2.2 CSV Format
6161

62-
#### 2.2.1 Command
62+
#### 2.2.1 Command
6363
```Shell
6464
# Unix/OS X
6565
> tools/import-data.sh -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
@@ -69,14 +69,22 @@ IoTDB supports three methods for data import:
6969
[-tn <thread_num>]
7070

7171
# Windows
72+
# Before version V2.0.4.x
7273
> tools\import-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
7374
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
7475
-s <source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] [-aligned <use the aligned interface>]
7576
[-ti <type_infer>] [-tp <timestamp precision (ms/us/ns)>] [-tz <timezone>] [-batch <batch_size>]
7677
[-tn <thread_num>]
78+
79+
# V2.0.4.x and later versions
80+
> tools\windows\import-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
81+
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
82+
-s <source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] [-aligned <use the aligned interface>]
83+
[-ti <type_infer>] [-tp <timestamp precision (ms/us/ns)>] [-tz <timezone>] [-batch <batch_size>]
84+
[-tn <thread_num>]
7785
```
7886

79-
#### 2.2.2 CSV-Specific Parameters
87+
#### 2.2.2 CSV-Specific Parameters
8088

8189
| Short | Full Parameter | Description | Required | Default |
8290
| ---------------- | ------------------------------- |----------------------------------------------------------| ---------- |-----------------|
@@ -87,7 +95,7 @@ IoTDB supports three methods for data import:
8795
| `-ti` | `--type_infer` | Type mapping (e.g., `BOOLEAN=text,INT=long`). | No | - |
8896
| `-tp` | `--timestamp_precision` | Timestamp precision: `ms`, `us`, `ns`. | No | `ms` |
8997

90-
#### 2.2.3 Examples
98+
#### 2.2.3 Examples
9199

92100
```Shell
93101
# Valid Example
@@ -107,7 +115,7 @@ There are no tables or the target table table5 does not exist
107115

108116
- Special Character Escaping Rules: If a text-type field contains special characters (e.g., commas `,`), they must be escaped using a backslash (`\`).
109117
- 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`.
110-
- Timestamp Column Requirement: The timestamp column must be the first column in the data file.
118+
- Timestamp Column Requirement: The timestamp column must be the first column in the data file.
111119

112120
2. CSV File Example
113121

@@ -118,9 +126,9 @@ time,region,device,model,temperature,humidity
118126
```
119127

120128

121-
### 2.3 SQL Format
129+
### 2.3 SQL Format
122130

123-
#### 2.3.1 Command
131+
#### 2.3.1 Command
124132

125133
```Shell
126134
# Unix/OS X
@@ -130,21 +138,28 @@ time,region,device,model,temperature,humidity
130138
[-batch <batch_size>] [-tn <thread_num>]
131139

132140
# Windows
141+
# Before version V2.0.4.x
133142
> tools\import-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
134143
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
135144
-s<source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] [-tz <timezone>]
136145
[-batch <batch_size>] [-tn <thread_num>]
146+
147+
# V2.0.4.x and later versions
148+
> tools\windows\import-data.bat -ft<format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
149+
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
150+
-s<source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] [-tz <timezone>]
151+
[-batch <batch_size>] [-tn <thread_num>]
137152
```
138153

139-
#### 2.3.2 SQL-Specific Parameters
154+
#### 2.3.2 SQL-Specific Parameters
140155

141156
| Short | Full Parameter | Description | Required | Default |
142157
| -------------- | ------------------------------- | -------------------------------------------------------------------- | ---------- | ------------------ |
143158
| `-fd` | `--fail_dir` | Directory to save failed files. | No |YOUR_CSV_FILE_PATH|
144159
| `-lpf` | `--lines_per_failed_file` | Max lines per failed file. | No | `100000` <br> Range: 0 to Integer.Max(2147483647). |
145160
| `-batch` | `--batch_size` | Rows processed per API call. | No | `100000` <br> Range: 0 to Integer.Max(2147483647). |
146161

147-
#### 2.3.3 Examples
162+
#### 2.3.3 Examples
148163

149164
```Shell
150165
# Valid Example
@@ -158,9 +173,9 @@ Source file or directory ./sql/dump1_1.sql does not exist
158173
# Log Example
159174
Fail to insert measurements '[column.name]' caused by [data type is not consistent, input '[column.value]', registered '[column.DataType]']
160175
```
161-
### 2.4 TsFile Format
176+
### 2.4 TsFile Format
162177

163-
#### 2.4.1 Command
178+
#### 2.4.1 Command
164179

165180
```Shell
166181
# Unix/OS X
@@ -170,12 +185,19 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste
170185
[-tn <thread_num> ] [-tz <timezone>] [-tp <timestamp precision (ms/us/ns)>]
171186

172187
# Windows
188+
# Before version V2.0.4.x
173189
> tools\import-data.bat -ft <format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
174190
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
175191
-s <source> -os <on_success> [-sd <success_dir>] -of <on_fail> [-fd <fail_dir>]
176192
[-tn <thread_num> ] [-tz <timezone>] [-tp <timestamp precision (ms/us/ns)>]
193+
194+
# V2.0.4.x and later versions
195+
> tools\windows\import-data.bat -ft <format> [-sql_dialect<sql_dialect>] -db<database> -table<table>
196+
[-h <host>] [-p <port>] [-u <username>] [-pw <password>]
197+
-s <source> -os <on_success> [-sd <success_dir>] -of <on_fail> [-fd <fail_dir>]
198+
[-tn <thread_num> ] [-tz <timezone>] [-tp <timestamp precision (ms/us/ns)>]
177199
```
178-
#### 2.4.2 TsFile-Specific Parameters
200+
#### 2.4.2 TsFile-Specific Parameters
179201

180202
| Short | Full Parameter | Description | Required | Default |
181203
| ----------- | ----------------------------- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| ----------------- | --------------------------- |
@@ -185,7 +207,7 @@ Fail to insert measurements '[column.name]' caused by [data type is not consiste
185207
| `-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` |
186208
| `-tp` | `--timestamp_precision` | TsFile timestamp precision: `ms`, `us`, `ns`. <br> 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. <br> ​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` |
187209

188-
#### 2.4.3 Examples
210+
#### 2.4.3 Examples
189211

190212
```Shell
191213
# Valid Example
@@ -225,7 +247,7 @@ load_active_listening_dir/
225247
```
226248

227249
- Table model TsFile
228-
- `temperature-table.TSFILE`: will be imported into the `temperature` database (because it is located in the `sensors/temperature/` directory)
250+
- `temperature-table.TSFILE`: will be imported into the `temperature` database (because it is located in the `sensors/temperature/` directory)
229251

230252

231253
### 3.3 Notes

0 commit comments

Comments
 (0)