From a784e08b6d4051ecf91239308997d3a05b34dd38 Mon Sep 17 00:00:00 2001 From: W1y1r <2730956796@qq.com> Date: Thu, 14 Nov 2024 18:52:45 +0800 Subject: [PATCH 1/3] Data export script document merging --- src/.vuepress/sidebar/V1.3.x/en.ts | 3 +- src/.vuepress/sidebar/V1.3.x/zh.ts | 3 +- src/.vuepress/sidebar_timecho/V1.3.x/en.ts | 3 +- src/.vuepress/sidebar_timecho/V1.3.x/zh.ts | 3 +- .../Master/Tools-System/Data-Export-Tool.md | 213 ++++++++++++++++++ .../Data-Import-Export-Tool.md | 0 .../TsFile-Import-Export-Tool.md | 0 .../latest/Tools-System/Data-Export-Tool.md | 213 ++++++++++++++++++ .../Data-Import-Export-Tool.md | 0 .../TsFile-Import-Export-Tool.md | 0 .../Master/Tools-System/Data-Export-Tool.md | 199 ++++++++++++++++ .../Data-Import-Export-Tool.md | 0 .../TsFile-Import-Export-Tool.md | 0 .../latest/Tools-System/Data-Export-Tool.md | 199 ++++++++++++++++ .../Data-Import-Export-Tool.md | 0 .../TsFile-Import-Export-Tool.md | 0 16 files changed, 828 insertions(+), 8 deletions(-) create mode 100644 src/UserGuide/Master/Tools-System/Data-Export-Tool.md rename src/UserGuide/Master/{Tools-System => stage}/Data-Import-Export-Tool.md (100%) rename src/UserGuide/Master/{Tools-System => stage}/TsFile-Import-Export-Tool.md (100%) create mode 100644 src/UserGuide/latest/Tools-System/Data-Export-Tool.md rename src/UserGuide/latest/{Tools-System => stage}/Data-Import-Export-Tool.md (100%) rename src/UserGuide/latest/{Tools-System => stage}/TsFile-Import-Export-Tool.md (100%) create mode 100644 src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md rename src/zh/UserGuide/Master/{Tools-System => stage}/Data-Import-Export-Tool.md (100%) rename src/zh/UserGuide/Master/{Tools-System => stage}/TsFile-Import-Export-Tool.md (100%) create mode 100644 src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md rename src/zh/UserGuide/latest/{Tools-System => stage}/Data-Import-Export-Tool.md (100%) rename src/zh/UserGuide/latest/{Tools-System => stage}/TsFile-Import-Export-Tool.md (100%) diff --git a/src/.vuepress/sidebar/V1.3.x/en.ts b/src/.vuepress/sidebar/V1.3.x/en.ts index daa3fb6f7..65a40b20d 100644 --- a/src/.vuepress/sidebar/V1.3.x/en.ts +++ b/src/.vuepress/sidebar/V1.3.x/en.ts @@ -99,8 +99,7 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_apache' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_apache' }, - { text: 'Data Import Export Script', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export Script', link: 'TsFile-Import-Export-Tool' }, + { text: 'Data Export Script', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar/V1.3.x/zh.ts b/src/.vuepress/sidebar/V1.3.x/zh.ts index 4fa047b3c..1ba459741 100644 --- a/src/.vuepress/sidebar/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar/V1.3.x/zh.ts @@ -99,8 +99,7 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_apache' }, { text: '测试工具', link: 'Benchmark' }, { text: '运维工具', link: 'Maintenance-Tool_apache' }, - { text: '数据导入导出脚本', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile导入导出脚本', link: 'TsFile-Import-Export-Tool' }, + { text: '导出工具', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts index 063b1daff..8b35b7b5d 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts @@ -108,8 +108,7 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_timecho' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_timecho' }, - { text: 'Data Import Export Script', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export Script', link: 'TsFile-Import-Export-Tool' }, + { text: 'Data Export Script', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts index 3e8f86497..30fe5e82b 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts @@ -108,8 +108,7 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_timecho' }, { text: '测试工具', link: 'Benchmark' }, { text: '运维工具', link: 'Maintenance-Tool_timecho' }, - { text: '数据导入导出脚本', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile导入导出脚本', link: 'TsFile-Import-Export-Tool' }, + { text: '导出工具', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/UserGuide/Master/Tools-System/Data-Export-Tool.md b/src/UserGuide/Master/Tools-System/Data-Export-Tool.md new file mode 100644 index 000000000..6b1834fb6 --- /dev/null +++ b/src/UserGuide/Master/Tools-System/Data-Export-Tool.md @@ -0,0 +1,213 @@ +# Data Export Script + +## 1. Introduction to Export Tools + +Export tools can export data queried from SQL into specified formats, including the `export-tsfile.sh/bat` script for exporting TsFile files and the `export-data.sh/bat` script that supports exporting in CSV and SQL formats. + +## 2. Supported Data Types + +- CSV: A plain text format for storing formatted data, which needs to be constructed according to the specified CSV format mentioned below. + +- SQL: A file containing custom SQL statements. + +- TsFile: The file format for time series used in IoTDB. + +## 3. export-tsfile Script + +Supports TsFile: The file format for time series used in IoTDB. + + +#### 3.1 Command + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h -p -u -pw -td [-f -q -s ] + +# Windows +tools\export-tsfile.bat -h -p -u -pw -td [-f -q -s ] +``` + +#### 3.2 Parameter Introduction + +| **Parameter** | **Definition** | **Required** | **Default** | +| -------- | ------------------------------------------------------------ | ------------ | --------- | +| -h | Hostname | No | root | +| -p | Port | No | root | +| -u | Username | No | 127.0.0.1 | +| -pw | Password | No | 6667 | +| -t | Target file directory, used to specify the directory where the output file should be saved | Yes | - | +| -tfn | Name of the export file | No | - | +| -q | Number of query commands to be executed, possibly used for batch execution of queries | No | - | +| -s | SQL file path, used to specify the location of the file containing the SQL statements to be executed | No | - | +| -timeout | Session query timeout, used to specify the maximum allowed time before the query operation is automatically terminated | No | - | + +In addition, if the `-s` and `-q` parameters are not used, after the export script is started, you need to enter the query statement according to the program prompt, and different query results will be saved to different TsFile files. + + + +#### 3.3 Running Examples + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 + +# Windows +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 +``` + +## 4. export-data Script + +Supports CSV: A plain text format for storing formatted data, which needs to be constructed according to the specified CSV format below. + +Supports SQL: A file containing custom SQL statements. + +#### 4.1 Command + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +#### 4.2 Parameter Introduction + +| **Parameter** | **Definition** | **Required** | **Default** | +| --------- | ------------------------------------------------------------ | ------------ | ------------------------ | +| -h | Hostname | No | 127.0.0.1 | +| -p | Port | No | 6667 | +| -u | Username | No | root | +| -pw | Password | No | root | +| -t | Exported CSV or SQL file output path (In V1.3.2, the parameter was `-td`) | Yes | | +| -datatype | Whether to print the corresponding data type behind the time series in the CSV file header, options are true or false | No | true | +| -q | Directly specify the query statement to be executed in the command (currently only supports some statements, detailed list see below) Note: -q and -s parameters are required to fill in one, if filled in at the same time, -q takes effect. For detailed supported SQL statement examples, please refer to "SQL Statement Support Details" below | 否 | | +| -s | Specify the SQL file, which may contain one or more SQL statements. If it contains multiple SQL statements, they should be separated by newlines (carriage returns). Each SQL statement corresponds to one or more output CSV or SQL files. Note: -q and -s parameters are required to fill in one, if filled in at the same time, -q takes effect. For detailed supported SQL statement examples, please refer to "SQL Statement Support Rules" below | 否 | | +| -type | Specify the type of exported file, options are csv or sql | No | csv | +| -tf | Specify the time format. The time format must comply with the[ISO 8601](https://calendars.wikia.org/wiki/ISO_8601)standard, or `timestamp` Explanation: Only effective when the - type is CSV | 否 | yyyy-MM-dd HH:mm:ss.SSSz | +| -lpf | Specify the maximum number of lines in the dump file to be exported (V1.3.2 version parameter is`-linesPerFile`) | No | 10000 | +| -timeout | Specify the timeout period for session queries, in ms | No | -1 | + +#### 4.3 SQL 语句支持规则 + +1. Only query statements are supported; non-query statements (such as metadata management, system management, etc.) are not supported. For unsupported SQL, the program will automatically skip and output an error message. + +2. In query statements, the current version only supports the export of raw data. If there are group by, aggregate functions, UDFs, operational operators, etc., they are not supported for export as SQL. When exporting raw data, please note that if exporting data from multiple devices, please use the align by device statement. Detailed examples are as follows: + + +| | **支持导出** | **示例** | +| ----------------------------------------- | ------------ | --------------------------------------------- | +| Raw data single device query | Supported | select * from root.s_0.d_0 | +| | 原始数据多设备查询（aligin by device） | Supported | select * from root.** align by device | + | 支持 | select * from root.** align by device | +| Raw data multi-device query (without align by device) | Not Supported | select * from root.**select * from root.s_0.* | + +#### 4.4 Running Examples + +- Export all data within the scope of a SQL execution to a CSV file. + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +- Export results + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- Export all data within the scope of all SQL executions in a SQL file to a CSV file. + + +```Bash +# Unix/OS X +>tools/export-data.sh -t ./data/ -s export.sql +# Windows +>tools/export-data.bat -t ./data/ -s export.sql +``` + +- Content of export.sql file (file pointed to by -s parameter) + + +```Bash +select * from root.stock.** limit 100 +select * from root.db.** limit 100 +``` + +- Export result file 1 + + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- Export result file 2 + + +```Bash +Time,root.db.Random.RandomBoolean +2024-07-22T17:16:05.820+08:00,true +2024-07-22T17:16:02.597+08:00,false +``` + +- Export data defined in the SQL file within the IoTDB database in an aligned format as SQL statements. + + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- Export results + + +```Bash +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249629831,0.62308747,2.0,0.012206747854849653,-6.0,false,0.14164352); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249630834,0.7520042,3.0,0.22760657101910464,-5.0,true,0.089064896); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249631835,0.3981064,3.0,0.6254559288663467,-6.0,false,0.9767922); +``` + +- Export all data within the scope of a SQL execution to a CSV file, specifying the export time format as `yyyy-MM-dd HH:mm:ss`, and print the corresponding data type behind the table header time series. + + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- Export results + + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice(DOUBLE),root.stock.Legacy.0700HK.Type(DOUBLE),root.stock.Legacy.0700HK.L1_BidSize(DOUBLE),root.stock.Legacy.0700HK.Domain(DOUBLE),root.stock.Legacy.0700HK.L1_BuyNo(BOOLEAN),root.stock.Legacy.0700HK.L1_AskPrice(DOUBLE) +2024-07-30 10:33:55,0.44574088,3.0,0.21476832811611501,-4.0,true,0.5951748 +2024-07-30 10:33:56,0.6880933,3.0,0.6289119476165305,-5.0,false,0.114634395 +``` \ No newline at end of file diff --git a/src/UserGuide/Master/Tools-System/Data-Import-Export-Tool.md b/src/UserGuide/Master/stage/Data-Import-Export-Tool.md similarity index 100% rename from src/UserGuide/Master/Tools-System/Data-Import-Export-Tool.md rename to src/UserGuide/Master/stage/Data-Import-Export-Tool.md diff --git a/src/UserGuide/Master/Tools-System/TsFile-Import-Export-Tool.md b/src/UserGuide/Master/stage/TsFile-Import-Export-Tool.md similarity index 100% rename from src/UserGuide/Master/Tools-System/TsFile-Import-Export-Tool.md rename to src/UserGuide/Master/stage/TsFile-Import-Export-Tool.md diff --git a/src/UserGuide/latest/Tools-System/Data-Export-Tool.md b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md new file mode 100644 index 000000000..6b1834fb6 --- /dev/null +++ b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -0,0 +1,213 @@ +# Data Export Script + +## 1. Introduction to Export Tools + +Export tools can export data queried from SQL into specified formats, including the `export-tsfile.sh/bat` script for exporting TsFile files and the `export-data.sh/bat` script that supports exporting in CSV and SQL formats. + +## 2. Supported Data Types + +- CSV: A plain text format for storing formatted data, which needs to be constructed according to the specified CSV format mentioned below. + +- SQL: A file containing custom SQL statements. + +- TsFile: The file format for time series used in IoTDB. + +## 3. export-tsfile Script + +Supports TsFile: The file format for time series used in IoTDB. + + +#### 3.1 Command + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h -p -u -pw -td [-f -q -s ] + +# Windows +tools\export-tsfile.bat -h -p -u -pw -td [-f -q -s ] +``` + +#### 3.2 Parameter Introduction + +| **Parameter** | **Definition** | **Required** | **Default** | +| -------- | ------------------------------------------------------------ | ------------ | --------- | +| -h | Hostname | No | root | +| -p | Port | No | root | +| -u | Username | No | 127.0.0.1 | +| -pw | Password | No | 6667 | +| -t | Target file directory, used to specify the directory where the output file should be saved | Yes | - | +| -tfn | Name of the export file | No | - | +| -q | Number of query commands to be executed, possibly used for batch execution of queries | No | - | +| -s | SQL file path, used to specify the location of the file containing the SQL statements to be executed | No | - | +| -timeout | Session query timeout, used to specify the maximum allowed time before the query operation is automatically terminated | No | - | + +In addition, if the `-s` and `-q` parameters are not used, after the export script is started, you need to enter the query statement according to the program prompt, and different query results will be saved to different TsFile files. + + + +#### 3.3 Running Examples + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 + +# Windows +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 +``` + +## 4. export-data Script + +Supports CSV: A plain text format for storing formatted data, which needs to be constructed according to the specified CSV format below. + +Supports SQL: A file containing custom SQL statements. + +#### 4.1 Command + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +#### 4.2 Parameter Introduction + +| **Parameter** | **Definition** | **Required** | **Default** | +| --------- | ------------------------------------------------------------ | ------------ | ------------------------ | +| -h | Hostname | No | 127.0.0.1 | +| -p | Port | No | 6667 | +| -u | Username | No | root | +| -pw | Password | No | root | +| -t | Exported CSV or SQL file output path (In V1.3.2, the parameter was `-td`) | Yes | | +| -datatype | Whether to print the corresponding data type behind the time series in the CSV file header, options are true or false | No | true | +| -q | Directly specify the query statement to be executed in the command (currently only supports some statements, detailed list see below) Note: -q and -s parameters are required to fill in one, if filled in at the same time, -q takes effect. For detailed supported SQL statement examples, please refer to "SQL Statement Support Details" below | 否 | | +| -s | Specify the SQL file, which may contain one or more SQL statements. If it contains multiple SQL statements, they should be separated by newlines (carriage returns). Each SQL statement corresponds to one or more output CSV or SQL files. Note: -q and -s parameters are required to fill in one, if filled in at the same time, -q takes effect. For detailed supported SQL statement examples, please refer to "SQL Statement Support Rules" below | 否 | | +| -type | Specify the type of exported file, options are csv or sql | No | csv | +| -tf | Specify the time format. The time format must comply with the[ISO 8601](https://calendars.wikia.org/wiki/ISO_8601)standard, or `timestamp` Explanation: Only effective when the - type is CSV | 否 | yyyy-MM-dd HH:mm:ss.SSSz | +| -lpf | Specify the maximum number of lines in the dump file to be exported (V1.3.2 version parameter is`-linesPerFile`) | No | 10000 | +| -timeout | Specify the timeout period for session queries, in ms | No | -1 | + +#### 4.3 SQL 语句支持规则 + +1. Only query statements are supported; non-query statements (such as metadata management, system management, etc.) are not supported. For unsupported SQL, the program will automatically skip and output an error message. + +2. In query statements, the current version only supports the export of raw data. If there are group by, aggregate functions, UDFs, operational operators, etc., they are not supported for export as SQL. When exporting raw data, please note that if exporting data from multiple devices, please use the align by device statement. Detailed examples are as follows: + + +| | **支持导出** | **示例** | +| ----------------------------------------- | ------------ | --------------------------------------------- | +| Raw data single device query | Supported | select * from root.s_0.d_0 | +| | 原始数据多设备查询（aligin by device） | Supported | select * from root.** align by device | + | 支持 | select * from root.** align by device | +| Raw data multi-device query (without align by device) | Not Supported | select * from root.**select * from root.s_0.* | + +#### 4.4 Running Examples + +- Export all data within the scope of a SQL execution to a CSV file. + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +- Export results + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- Export all data within the scope of all SQL executions in a SQL file to a CSV file. + + +```Bash +# Unix/OS X +>tools/export-data.sh -t ./data/ -s export.sql +# Windows +>tools/export-data.bat -t ./data/ -s export.sql +``` + +- Content of export.sql file (file pointed to by -s parameter) + + +```Bash +select * from root.stock.** limit 100 +select * from root.db.** limit 100 +``` + +- Export result file 1 + + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- Export result file 2 + + +```Bash +Time,root.db.Random.RandomBoolean +2024-07-22T17:16:05.820+08:00,true +2024-07-22T17:16:02.597+08:00,false +``` + +- Export data defined in the SQL file within the IoTDB database in an aligned format as SQL statements. + + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- Export results + + +```Bash +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249629831,0.62308747,2.0,0.012206747854849653,-6.0,false,0.14164352); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249630834,0.7520042,3.0,0.22760657101910464,-5.0,true,0.089064896); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249631835,0.3981064,3.0,0.6254559288663467,-6.0,false,0.9767922); +``` + +- Export all data within the scope of a SQL execution to a CSV file, specifying the export time format as `yyyy-MM-dd HH:mm:ss`, and print the corresponding data type behind the table header time series. + + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- Export results + + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice(DOUBLE),root.stock.Legacy.0700HK.Type(DOUBLE),root.stock.Legacy.0700HK.L1_BidSize(DOUBLE),root.stock.Legacy.0700HK.Domain(DOUBLE),root.stock.Legacy.0700HK.L1_BuyNo(BOOLEAN),root.stock.Legacy.0700HK.L1_AskPrice(DOUBLE) +2024-07-30 10:33:55,0.44574088,3.0,0.21476832811611501,-4.0,true,0.5951748 +2024-07-30 10:33:56,0.6880933,3.0,0.6289119476165305,-5.0,false,0.114634395 +``` \ No newline at end of file diff --git a/src/UserGuide/latest/Tools-System/Data-Import-Export-Tool.md b/src/UserGuide/latest/stage/Data-Import-Export-Tool.md similarity index 100% rename from src/UserGuide/latest/Tools-System/Data-Import-Export-Tool.md rename to src/UserGuide/latest/stage/Data-Import-Export-Tool.md diff --git a/src/UserGuide/latest/Tools-System/TsFile-Import-Export-Tool.md b/src/UserGuide/latest/stage/TsFile-Import-Export-Tool.md similarity index 100% rename from src/UserGuide/latest/Tools-System/TsFile-Import-Export-Tool.md rename to src/UserGuide/latest/stage/TsFile-Import-Export-Tool.md diff --git a/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md new file mode 100644 index 000000000..d0c9ae0f8 --- /dev/null +++ b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md @@ -0,0 +1,199 @@ +# 数据导出脚本 + +## 1. 导出工具介绍 + +导出工具可以将 SQL 查询的数据导出为指定的格式，包含用于导出 TsFile 文件的 export-tsfile.sh/bat 脚本和支持 CSV 和 SQL 格式的导出的 export-data.sh/bat 脚本。 + +## 2. 支持的数据类型 + +- CSV：纯文本格式，存储格式化数据，需按照下文指定 CSV 格式进行构造 + +- SQL：包含自定义 SQL 语句的文件 + +- TsFile： IoTDB 中使用的时间序列的文件格式 + +## 3. export-tsfile 脚本 + +支持 TsFile： IoTDB 中使用的时间序列的文件格式 + +#### 3.1 运行命令 + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h -p -u -pw -td [-f -q -s ] + +# Windows +tools\export-tsfile.bat -h -p -u -pw -td [-f -q -s ] +``` + +#### 3.2 参数介绍 + +| **参数** | **定义** | **是否必填** | **默认** | +| -------- | ------------------------------------------------------------ | ------------ | --------- | +| -h | 主机名 | 否 | root | +| -p | 端口号 | 否 | root | +| -u | 用户名 | 否 | 127.0.0.1 | +| -pw | 密码 | 否 | 6667 | +| -t | 目标文件目录，用于指定输出文件应该保存到的目录 | 是 | - | +| -tfn | 导出文件的名称 | 否 | - | +| -q | 想要执行的查询命令的数量，可能用于批量执行查询 | 否 | - | +| -s | SQL 文件路径，用于指定包含要执行的 SQL 语句的文件位置 | 否 | - | +| -timeout | 会话查询的超时时间，用于指定查询操作在自动终止前允许的最长时间 | 否 | - | + +除此之外，如果没有使用`-s`和`-q`参数，在导出脚本被启动之后你需要按照程序提示输入查询语句，不同的查询结果会被保存到不同的TsFile文件中。 + +#### 3.3 运行示例 + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 + +# Windows +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 +``` + +## 4. export-data 脚本 + +支持 CSV：纯文本格式，存储格式化数据，需按照下文指定 CSV 格式进行构造 + +支持 SQL：包含自定义 SQL 语句的文件 + +#### 4.1 运行命令 + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +#### 4.2 参数介绍 + +| **参数** | **定义** | **是否必填** | **默认** | +| --------- | ------------------------------------------------------------ | ------------ | ------------------------ | +| -h | 主机名 | 否 | 127.0.0.1 | +| -p | 端口号 | 否 | 6667 | +| -u | 用户名 | 否 | root | +| -pw | 密码 | 否 | root | +| -t | 导出的 CSV 或 SQL 文件的输出路径(V1.3.2版本参数是`-td`) | 是 | | +| -datatype | 是否在 CSV 文件的 header 中时间序列的后面打印出对应的数据类型，选项为 true 或者 false | 否 | true | +| -q | 在命令中直接指定想要执行的查询语句（目前仅支持部分语句，详细明细见下表）说明：-q 与 -s 参数必填其一，同时填写则 -q 生效。详细支持的 SQL 语句示例，请参考下方“SQL语句支持明细” | 否 | | +| -s | 指定 SQL 文件，该文件可包含一条或多条 SQL 语句。如果包含多条 SQL 语句，语句之间应该用换行(回车)进行分割。每一条 SQL 语句对应一个或多个输出的CSV或 SQL 文件说明：-q 与 -s 参数必填其一，同时填写则-q生效。详细支持的 SQL 语句示例，请参考下方“SQL语句支持规则” | 否 | | +| -type | 指定导出的文件类型，选项为 csv 或者 sql | 否 | csv | +| -tf | 指定时间格式。时间格式必须遵守[ISO 8601](https://calendars.wikia.org/wiki/ISO_8601)标准，或时间戳（`timestamp`） 说明：只在 -type 为 csv 时生效 | 否 | yyyy-MM-dd HH:mm:ss.SSSz | +| -lpf | 指定导出的 dump 文件最大行数(V1.3.2版本参数是`-linesPerFile`) | 否 | 10000 | +| -timeout | 指定 session 查询时的超时时间，单位为ms | 否 | -1 | + +#### 4.3 SQL 语句支持规则 + +1. 只支持查询语句，非查询语句（如：元数据管理、系统管理等语句）不支持。对于不支持的 SQL ，程序会自动跳过，同时输出错误信息。 +2. 查询语句中目前版本仅支持原始数据的导出，如果有使用 group by、聚合函数、udf、操作运算符等则不支持导出为 SQL。原始数据导出时请注意，若导出多个设备数据，请使用 align by device 语句。详细示例如下： + +| | **支持导出** | **示例** | +| ----------------------------------------- | ------------ | --------------------------------------------- | +| 原始数据单设备查询 | 支持 | select * from root.s_0.d_0 | +| 原始数据多设备查询（aligin by device） | 支持 | select * from root.** align by device | +| 原始数据多设备查询（无 aligin by device） | 不支持 | select * from root.**select * from root.s_0.* | + +#### 4.4 运行示例 + +- 导出某 SQL 执行范围下的所有数据至 CSV 文件。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +- 导出结果 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- 导出 SQL 文件内所有 SQL 执行范围下的所有数据至 CSV 文件。 + +```Bash +# Unix/OS X +>tools/export-data.sh -t ./data/ -s export.sql +# Windows +>tools/export-data.bat -t ./data/ -s export.sql +``` + +- export.sql 文件内容（-s 参数指向的文件） + +```Bash +select * from root.stock.** limit 100 +select * from root.db.** limit 100 +``` + +- 导出结果文件1 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- 导出结果文件2 + +```Bash +Time,root.db.Random.RandomBoolean +2024-07-22T17:16:05.820+08:00,true +2024-07-22T17:16:02.597+08:00,false +``` + +- 将 IoTDB 数据库中在 SQL 文件内定义的数据，以对齐的格式将其导出为 SQL 语句。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- 导出结果 + +```Bash +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249629831,0.62308747,2.0,0.012206747854849653,-6.0,false,0.14164352); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249630834,0.7520042,3.0,0.22760657101910464,-5.0,true,0.089064896); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249631835,0.3981064,3.0,0.6254559288663467,-6.0,false,0.9767922); +``` + +- 将某 SQL 执行范围下的所有数据导出至 CSV 文件，指定导出的时间格式为`yyyy-MM-dd HH:mm:ss`，且表头时间序列的后面打印出对应的数据类型。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- 导出结果 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice(DOUBLE),root.stock.Legacy.0700HK.Type(DOUBLE),root.stock.Legacy.0700HK.L1_BidSize(DOUBLE),root.stock.Legacy.0700HK.Domain(DOUBLE),root.stock.Legacy.0700HK.L1_BuyNo(BOOLEAN),root.stock.Legacy.0700HK.L1_AskPrice(DOUBLE) +2024-07-30 10:33:55,0.44574088,3.0,0.21476832811611501,-4.0,true,0.5951748 +2024-07-30 10:33:56,0.6880933,3.0,0.6289119476165305,-5.0,false,0.114634395 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/Master/Tools-System/Data-Import-Export-Tool.md b/src/zh/UserGuide/Master/stage/Data-Import-Export-Tool.md similarity index 100% rename from src/zh/UserGuide/Master/Tools-System/Data-Import-Export-Tool.md rename to src/zh/UserGuide/Master/stage/Data-Import-Export-Tool.md diff --git a/src/zh/UserGuide/Master/Tools-System/TsFile-Import-Export-Tool.md b/src/zh/UserGuide/Master/stage/TsFile-Import-Export-Tool.md similarity index 100% rename from src/zh/UserGuide/Master/Tools-System/TsFile-Import-Export-Tool.md rename to src/zh/UserGuide/Master/stage/TsFile-Import-Export-Tool.md diff --git a/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md new file mode 100644 index 000000000..d0c9ae0f8 --- /dev/null +++ b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -0,0 +1,199 @@ +# 数据导出脚本 + +## 1. 导出工具介绍 + +导出工具可以将 SQL 查询的数据导出为指定的格式，包含用于导出 TsFile 文件的 export-tsfile.sh/bat 脚本和支持 CSV 和 SQL 格式的导出的 export-data.sh/bat 脚本。 + +## 2. 支持的数据类型 + +- CSV：纯文本格式，存储格式化数据，需按照下文指定 CSV 格式进行构造 + +- SQL：包含自定义 SQL 语句的文件 + +- TsFile： IoTDB 中使用的时间序列的文件格式 + +## 3. export-tsfile 脚本 + +支持 TsFile： IoTDB 中使用的时间序列的文件格式 + +#### 3.1 运行命令 + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h -p -u -pw -td [-f -q -s ] + +# Windows +tools\export-tsfile.bat -h -p -u -pw -td [-f -q -s ] +``` + +#### 3.2 参数介绍 + +| **参数** | **定义** | **是否必填** | **默认** | +| -------- | ------------------------------------------------------------ | ------------ | --------- | +| -h | 主机名 | 否 | root | +| -p | 端口号 | 否 | root | +| -u | 用户名 | 否 | 127.0.0.1 | +| -pw | 密码 | 否 | 6667 | +| -t | 目标文件目录，用于指定输出文件应该保存到的目录 | 是 | - | +| -tfn | 导出文件的名称 | 否 | - | +| -q | 想要执行的查询命令的数量，可能用于批量执行查询 | 否 | - | +| -s | SQL 文件路径，用于指定包含要执行的 SQL 语句的文件位置 | 否 | - | +| -timeout | 会话查询的超时时间，用于指定查询操作在自动终止前允许的最长时间 | 否 | - | + +除此之外，如果没有使用`-s`和`-q`参数，在导出脚本被启动之后你需要按照程序提示输入查询语句，不同的查询结果会被保存到不同的TsFile文件中。 + +#### 3.3 运行示例 + +```Bash +# Unix/OS X +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 + +# Windows +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -q "select * from root.**" +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt +# Or +tools/export-tsfile.bat -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile +# Or +tools/export-tsfile.sh -h 127.0.0.1 -p 6667 -u root -pw root -td ./ -s ./sql.txt -f myTsFile -t 10000 +``` + +## 4. export-data 脚本 + +支持 CSV：纯文本格式，存储格式化数据，需按照下文指定 CSV 格式进行构造 + +支持 SQL：包含自定义 SQL 语句的文件 + +#### 4.1 运行命令 + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +#### 4.2 参数介绍 + +| **参数** | **定义** | **是否必填** | **默认** | +| --------- | ------------------------------------------------------------ | ------------ | ------------------------ | +| -h | 主机名 | 否 | 127.0.0.1 | +| -p | 端口号 | 否 | 6667 | +| -u | 用户名 | 否 | root | +| -pw | 密码 | 否 | root | +| -t | 导出的 CSV 或 SQL 文件的输出路径(V1.3.2版本参数是`-td`) | 是 | | +| -datatype | 是否在 CSV 文件的 header 中时间序列的后面打印出对应的数据类型，选项为 true 或者 false | 否 | true | +| -q | 在命令中直接指定想要执行的查询语句（目前仅支持部分语句，详细明细见下表）说明：-q 与 -s 参数必填其一，同时填写则 -q 生效。详细支持的 SQL 语句示例，请参考下方“SQL语句支持明细” | 否 | | +| -s | 指定 SQL 文件，该文件可包含一条或多条 SQL 语句。如果包含多条 SQL 语句，语句之间应该用换行(回车)进行分割。每一条 SQL 语句对应一个或多个输出的CSV或 SQL 文件说明：-q 与 -s 参数必填其一，同时填写则-q生效。详细支持的 SQL 语句示例，请参考下方“SQL语句支持规则” | 否 | | +| -type | 指定导出的文件类型，选项为 csv 或者 sql | 否 | csv | +| -tf | 指定时间格式。时间格式必须遵守[ISO 8601](https://calendars.wikia.org/wiki/ISO_8601)标准，或时间戳（`timestamp`） 说明：只在 -type 为 csv 时生效 | 否 | yyyy-MM-dd HH:mm:ss.SSSz | +| -lpf | 指定导出的 dump 文件最大行数(V1.3.2版本参数是`-linesPerFile`) | 否 | 10000 | +| -timeout | 指定 session 查询时的超时时间，单位为ms | 否 | -1 | + +#### 4.3 SQL 语句支持规则 + +1. 只支持查询语句，非查询语句（如：元数据管理、系统管理等语句）不支持。对于不支持的 SQL ，程序会自动跳过，同时输出错误信息。 +2. 查询语句中目前版本仅支持原始数据的导出，如果有使用 group by、聚合函数、udf、操作运算符等则不支持导出为 SQL。原始数据导出时请注意，若导出多个设备数据，请使用 align by device 语句。详细示例如下： + +| | **支持导出** | **示例** | +| ----------------------------------------- | ------------ | --------------------------------------------- | +| 原始数据单设备查询 | 支持 | select * from root.s_0.d_0 | +| 原始数据多设备查询（aligin by device） | 支持 | select * from root.** align by device | +| 原始数据多设备查询（无 aligin by device） | 不支持 | select * from root.**select * from root.s_0.* | + +#### 4.4 运行示例 + +- 导出某 SQL 执行范围下的所有数据至 CSV 文件。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] + +# Windows +>tools\export-data.bat -h -p -u -pw -t [-tf -datatype -q -s -tfn -lpf -type -aligned ] +``` + +- 导出结果 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- 导出 SQL 文件内所有 SQL 执行范围下的所有数据至 CSV 文件。 + +```Bash +# Unix/OS X +>tools/export-data.sh -t ./data/ -s export.sql +# Windows +>tools/export-data.bat -t ./data/ -s export.sql +``` + +- export.sql 文件内容（-s 参数指向的文件） + +```Bash +select * from root.stock.** limit 100 +select * from root.db.** limit 100 +``` + +- 导出结果文件1 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice,root.stock.Legacy.0700HK.Type,root.stock.Legacy.0700HK.L1_BidSize,root.stock.Legacy.0700HK.Domain,root.stock.Legacy.0700HK.L1_BuyNo,root.stock.Legacy.0700HK.L1_AskPrice +2024-07-29T18:37:18.700+08:00,0.9666617,3.0,0.021367407654674264,-6.0,false,0.8926191 +2024-07-29T18:37:19.701+08:00,0.3057328,3.0,0.9965377284981661,-5.0,false,0.15167356 +``` + +- 导出结果文件2 + +```Bash +Time,root.db.Random.RandomBoolean +2024-07-22T17:16:05.820+08:00,true +2024-07-22T17:16:02.597+08:00,false +``` + +- 将 IoTDB 数据库中在 SQL 文件内定义的数据，以对齐的格式将其导出为 SQL 语句。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- 导出结果 + +```Bash +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249629831,0.62308747,2.0,0.012206747854849653,-6.0,false,0.14164352); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249630834,0.7520042,3.0,0.22760657101910464,-5.0,true,0.089064896); +INSERT INTO root.stock.Legacy.0700HK(TIMESTAMP,L1_BidPrice,Type,L1_BidSize,Domain,L1_BuyNo,L1_AskPrice) ALIGNED VALUES (1722249631835,0.3981064,3.0,0.6254559288663467,-6.0,false,0.9767922); +``` + +- 将某 SQL 执行范围下的所有数据导出至 CSV 文件，指定导出的时间格式为`yyyy-MM-dd HH:mm:ss`，且表头时间序列的后面打印出对应的数据类型。 + +```Bash +# Unix/OS X +>tools/export-data.sh -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +# Windows +>tools/export-data.bat -h 127.0.0.1 -p 6667 -u root -p root -t ./data/ -s export.sql -type sql -aligned true +``` + +- 导出结果 + +```Bash +Time,root.stock.Legacy.0700HK.L1_BidPrice(DOUBLE),root.stock.Legacy.0700HK.Type(DOUBLE),root.stock.Legacy.0700HK.L1_BidSize(DOUBLE),root.stock.Legacy.0700HK.Domain(DOUBLE),root.stock.Legacy.0700HK.L1_BuyNo(BOOLEAN),root.stock.Legacy.0700HK.L1_AskPrice(DOUBLE) +2024-07-30 10:33:55,0.44574088,3.0,0.21476832811611501,-4.0,true,0.5951748 +2024-07-30 10:33:56,0.6880933,3.0,0.6289119476165305,-5.0,false,0.114634395 +``` \ No newline at end of file diff --git a/src/zh/UserGuide/latest/Tools-System/Data-Import-Export-Tool.md b/src/zh/UserGuide/latest/stage/Data-Import-Export-Tool.md similarity index 100% rename from src/zh/UserGuide/latest/Tools-System/Data-Import-Export-Tool.md rename to src/zh/UserGuide/latest/stage/Data-Import-Export-Tool.md diff --git a/src/zh/UserGuide/latest/Tools-System/TsFile-Import-Export-Tool.md b/src/zh/UserGuide/latest/stage/TsFile-Import-Export-Tool.md similarity index 100% rename from src/zh/UserGuide/latest/Tools-System/TsFile-Import-Export-Tool.md rename to src/zh/UserGuide/latest/stage/TsFile-Import-Export-Tool.md From 5ffad13f5d7ed3e5fc00b273715a94a145631c3f Mon Sep 17 00:00:00 2001 From: W1y1r <2730956796@qq.com> Date: Fri, 15 Nov 2024 10:56:14 +0800 Subject: [PATCH 2/3] Update document name --- src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md | 2 +- src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md index d0c9ae0f8..e04027365 100644 --- a/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# 数据导出脚本 +# 数据导出工具 ## 1. 导出工具介绍 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 d0c9ae0f8..e04027365 100644 --- a/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# 数据导出脚本 +# 数据导出工具 ## 1. 导出工具介绍 From 8e05a3e58cba75a976f174d55541ebccabae6c7d Mon Sep 17 00:00:00 2001 From: W1y1r <2730956796@qq.com> Date: Mon, 18 Nov 2024 12:02:12 +0800 Subject: [PATCH 3/3] Change the sidebar name to Data Export --- src/.vuepress/sidebar/V1.3.x/en.ts | 2 +- src/.vuepress/sidebar/V1.3.x/zh.ts | 2 +- src/.vuepress/sidebar_timecho/V1.3.x/en.ts | 2 +- src/.vuepress/sidebar_timecho/V1.3.x/zh.ts | 2 +- src/UserGuide/Master/Tools-System/Data-Export-Tool.md | 2 +- src/UserGuide/latest/Tools-System/Data-Export-Tool.md | 2 +- src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md | 2 +- src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/.vuepress/sidebar/V1.3.x/en.ts b/src/.vuepress/sidebar/V1.3.x/en.ts index 65a40b20d..fbb377dde 100644 --- a/src/.vuepress/sidebar/V1.3.x/en.ts +++ b/src/.vuepress/sidebar/V1.3.x/en.ts @@ -99,7 +99,7 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_apache' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_apache' }, - { text: 'Data Export Script', link: 'Data-Export-Tool' }, + { text: 'Data Export', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar/V1.3.x/zh.ts b/src/.vuepress/sidebar/V1.3.x/zh.ts index 1ba459741..919dc80c7 100644 --- a/src/.vuepress/sidebar/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar/V1.3.x/zh.ts @@ -99,7 +99,7 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_apache' }, { text: '测试工具', link: 'Benchmark' }, { text: '运维工具', link: 'Maintenance-Tool_apache' }, - { text: '导出工具', link: 'Data-Export-Tool' }, + { text: '数据导出', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts index 8b35b7b5d..d887f6ef5 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts @@ -108,7 +108,7 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_timecho' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Maintenance Tool', link: 'Maintenance-Tool_timecho' }, - { text: 'Data Export Script', link: 'Data-Export-Tool' }, + { text: 'Data Export', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts index 30fe5e82b..0eca851e2 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts @@ -108,7 +108,7 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_timecho' }, { text: '测试工具', link: 'Benchmark' }, { text: '运维工具', link: 'Maintenance-Tool_timecho' }, - { text: '导出工具', link: 'Data-Export-Tool' }, + { text: '数据导出', link: 'Data-Export-Tool' }, ], }, { diff --git a/src/UserGuide/Master/Tools-System/Data-Export-Tool.md b/src/UserGuide/Master/Tools-System/Data-Export-Tool.md index 6b1834fb6..1d5736809 100644 --- a/src/UserGuide/Master/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/Master/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# Data Export Script +# Data Export ## 1. Introduction to Export Tools diff --git a/src/UserGuide/latest/Tools-System/Data-Export-Tool.md b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md index 6b1834fb6..1d5736809 100644 --- a/src/UserGuide/latest/Tools-System/Data-Export-Tool.md +++ b/src/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# Data Export Script +# Data Export ## 1. Introduction to Export Tools diff --git a/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md index e04027365..ef57e0c12 100644 --- a/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/Master/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# 数据导出工具 +# 数据导出 ## 1. 导出工具介绍 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 e04027365..ef57e0c12 100644 --- a/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md +++ b/src/zh/UserGuide/latest/Tools-System/Data-Export-Tool.md @@ -1,4 +1,4 @@ -# 数据导出工具 +# 数据导出 ## 1. 导出工具介绍