You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/UserGuide/Master/Table/Tools-System/Data-Export-Tool_timecho.md
+81-5Lines changed: 81 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,11 @@
1
1
# Data Export
2
2
3
3
## 1. Function Overview
4
-
The data export tool `export-data.sh/bat` is located in the `tools` directory and can export query results from specified SQL statements into CSV, SQL, or TsFile (open-source time-series file format) formats. Its specific functionalities are as follows:
4
+
5
+
IoTDB supports two methods for data export:
6
+
7
+
* Data Export Tool: `export-data.sh/bat` is located in the `tools` directory. It can export the query results of specified SQL statements into CSV, SQL, and TsFile (open-source time-series file format) files.
8
+
* PIPE Framework-based TsFileBackup: `tsfile-backup.sh/bat` is located in the `tools` directory. It can export specified data files into TsFile format using the PIPE framework.
5
9
6
10
<tablestyle="text-align: left;">
7
11
<tbody>
@@ -19,15 +23,18 @@ The data export tool `export-data.sh/bat` is located in the `tools` directory an
19
23
<td>File containing custom SQL statements.</td>
20
24
</tr>
21
25
<tr>
22
-
<td >TsFile</td>
26
+
<td rowspan="2">TsFile</td>
23
27
<td>Open-source time-series file format.</td>
24
28
</tr>
29
+
<tr>
30
+
<td>tsfile-backup.sh/bat</td>
31
+
<td>An open-source time-series data file format,and this script supports the Object data type.</td>
32
+
</tr>
25
33
</tbody>
26
34
</table>
27
35
28
-
- Does not support the Object data type.
29
36
30
-
## 2. Detailed Features
37
+
## 2. Data Export Tool
31
38
### 2.1 Common Parameters
32
39
| Short | Full Parameter | Description | Required | Default |
Since **V2.0.9.2**, IoTDB supports the `tsfile-backup.sh/bat` script. This script can automatically generate and send the `CREATE PIPE` SQL command to the server, exporting specified data files to TsFile format.
182
+
183
+
**Notes:**
184
+
1.**To use this script, contact the Timecho Team to obtain the customized installation package `timechodb-<version>-extension`.**
185
+
2.**This script supports exporting Object-type data to TsFile files.**
|`-sql_dialect`|`--sql_dialect`| Specifies the data model type. Valid values: `tree` (Tree Model) or `table` (Table Model). | Yes | - |
210
+
|`-h`|`--host`| Local host address (IP of the IoTDB instance where the data resides). | No |`127.0.0.1`|
211
+
|`-p`|`--port`| Port number for the IoTDB RPC service. | No |`6667`|
212
+
|`-u`|`--user`| Username for IoTDB authentication. | No |`root`|
213
+
|`-pw`|`--password`| Password for IoTDB authentication (hidden input supported). | No |`root`|
214
+
|`-t`|`--target`| Export target directory. In SCP mode, this is an absolute physical path on the remote server. TsFile and associated Object directories will be exported here. | Yes | - |
215
+
|`-db`|`--database`| Database name (optional for Table Model). | No |`.*`|
216
+
|`-table`|`--table`| Table name (optional for Table Model). | No |`.*`|
217
+
|`-s`|`--start_time`| Start time (ISO8601 format e.g. `2026-01-01T00:00:00` or millisecond timestamp). Only data from this time onwards is exported. | No | - |
218
+
|`-e`|`--end_time`| End time (same format as above). Only data before this time is exported. | No | - |
219
+
|`-th`|`--target_host`| Remote target host IP. If specified, the script automatically configures Pipe to use SCP for data transfer. | No | - |
220
+
|`-tu`|`--target_host_user`| Username for SSH/SCP login to the remote server. | No | - |
221
+
|`-tpw`|`--target_host_pw`| Password for remote authentication (hidden input supported). | No | - |
222
+
|`-tp`|`--target_host_port`| Remote SSH port. | No |`22`|
223
+
|`--rate_limit`|`--rate_limit`| Transfer rate limit (unit: Bytes/s) to prevent excessive bandwidth usage. | No | - |
224
+
|`--plugin_jar`|`--plugin_jar`| Path to the Pipe plugin JAR file. | No | - |
225
+
|`-help`|`--help`| Show help information. | No | - |
226
+
227
+
228
+
### 3.3 Execution Examples
229
+
230
+
Example 1: SCP Remote Export (Send Data to Another Server)
0 commit comments