From 9c1721b61baf18b8d5ec94d08b8d7f7f75560fb7 Mon Sep 17 00:00:00 2001 From: Leto_b Date: Thu, 28 May 2026 16:10:39 +0800 Subject: [PATCH] add schema export and import from 1.3.3 --- src/.vuepress/sidebar/V1.3.x/en.ts | 22 +++-- src/.vuepress/sidebar/V1.3.x/zh.ts | 22 +++-- src/.vuepress/sidebar_timecho/V1.3.x/en.ts | 22 +++-- src/.vuepress/sidebar_timecho/V1.3.x/zh.ts | 22 +++-- .../V1.3.x/Tools-System/Schema-Export-Tool.md | 72 ++++++++++++++++ .../V1.3.x/Tools-System/Schema-Import-Tool.md | 82 +++++++++++++++++++ .../Tools-System/Schema-Export-Tool.md | 72 ++++++++++++++++ .../Tools-System/Schema-Import-Tool.md | 82 +++++++++++++++++++ .../V1.3.x/Tools-System/Schema-Export-Tool.md | 72 ++++++++++++++++ .../V1.3.x/Tools-System/Schema-Import-Tool.md | 78 ++++++++++++++++++ .../Tools-System/Schema-Export-Tool.md | 72 ++++++++++++++++ .../Tools-System/Schema-Import-Tool.md | 78 ++++++++++++++++++ 12 files changed, 672 insertions(+), 24 deletions(-) create mode 100644 src/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md create mode 100644 src/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md create mode 100644 src/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md create mode 100644 src/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md create mode 100644 src/zh/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md create mode 100644 src/zh/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md create mode 100644 src/zh/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md create mode 100644 src/zh/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md diff --git a/src/.vuepress/sidebar/V1.3.x/en.ts b/src/.vuepress/sidebar/V1.3.x/en.ts index c74556c9f..24635e73c 100644 --- a/src/.vuepress/sidebar/V1.3.x/en.ts +++ b/src/.vuepress/sidebar/V1.3.x/en.ts @@ -168,12 +168,22 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_apache' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Cluster Management Tool', link: 'Maintenance-Tool_apache' }, - { text: 'Data Import Export(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, - { text: 'Data Import(V1.3.3)', link: 'Data-Import-Tool' }, - { text: 'Data Import(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, - { text: 'Data Export(V1.3.3)', link: 'Data-Export-Tool' }, - { text: 'Data Export(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + { text: 'Data Import & Export', collapsible: true, + children: [ + { text: 'Data Import Export(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, + { text: 'TsFile Import Export(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, + { text: 'Data Import(V1.3.3)', link: 'Data-Import-Tool' }, + { text: 'Data Import(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, + { text: 'Data Export(V1.3.3)', link: 'Data-Export-Tool' }, + { text: 'Data Export(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + ], + }, + { text: 'Schema Import & Export', collapsible: true, + children: [ + { text: 'Schema Import', link: 'Schema-Import-Tool' }, + { text: 'Schema Export', link: 'Schema-Export-Tool' }, + ], + }, { text: 'Full Backup Tool(V1.3.2)', link: 'Backup-Tool' }, { text: 'Health Check Tool(V1.3.2)', link: 'Health-Check-Tool' }, ], diff --git a/src/.vuepress/sidebar/V1.3.x/zh.ts b/src/.vuepress/sidebar/V1.3.x/zh.ts index 479700171..405ee6d5c 100644 --- a/src/.vuepress/sidebar/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar/V1.3.x/zh.ts @@ -159,12 +159,22 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_apache' }, { text: '测试工具', link: 'Benchmark' }, { text: '集群管理工具', link: 'Maintenance-Tool_apache' }, - { text: '数据导入导出(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile导入导出(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, - { text: '数据导入(V1.3.3)', link: 'Data-Import-Tool' }, - { text: '数据导入(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, - { text: '数据导出(V1.3.3)', link: 'Data-Export-Tool' }, - { text: '数据导出(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + { text: '数据导入导出', collapsible: true, + children: [ + { text: '数据导入导出(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, + { text: 'TsFile导入导出(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, + { text: '数据导入(V1.3.3)', link: 'Data-Import-Tool' }, + { text: '数据导入(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, + { text: '数据导出(V1.3.3)', link: 'Data-Export-Tool' }, + { text: '数据导出(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + ], + }, + { text: '元数据导入导出', collapsible: true, + children: [ + { text: '元数据导入', link: 'Schema-Import-Tool' }, + { text: '元数据导出', link: 'Schema-Export-Tool' }, + ], + }, { text: '全量备份工具(V1.3.2)', link: 'Backup-Tool' }, { text: '健康检查工具(V1.3.2)', link: 'Health-Check-Tool' }, ], diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts index 1034998ac..2c398e40d 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/en.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/en.ts @@ -194,12 +194,22 @@ export const enSidebar = { { text: 'Monitor Tool', link: 'Monitor-Tool_timecho' }, { text: 'Benchmark Tool', link: 'Benchmark' }, { text: 'Cluster Management Tool', link: 'Maintenance-Tool_timecho' }, - { text: 'Data Import Export(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile Import Export(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, - { text: 'Data Import(V1.3.3)', link: 'Data-Import-Tool' }, - { text: 'Data Import(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, - { text: 'Data Export(V1.3.3)', link: 'Data-Export-Tool' }, - { text: 'Data Export(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + { text: 'Data Import & Export', collapsible: true, + children: [ + { text: 'Data Import Export(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, + { text: 'TsFile Import Export(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, + { text: 'Data Import(V1.3.3)', link: 'Data-Import-Tool' }, + { text: 'Data Import(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, + { text: 'Data Export(V1.3.3)', link: 'Data-Export-Tool' }, + { text: 'Data Export(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + ], + }, + { text: 'Schema Import & Export', collapsible: true, + children: [ + { text: 'Schema Import', link: 'Schema-Import-Tool' }, + { text: 'Schema Export', link: 'Schema-Export-Tool' }, + ], + }, { text: 'Full Backup Tool(V1.3.2)', link: 'Backup-Tool' }, { text: 'Health Check Tool(V1.3.2)', link: 'Health-Check-Tool' }, ], diff --git a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts index 6ef9d8221..ca4a58281 100644 --- a/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts +++ b/src/.vuepress/sidebar_timecho/V1.3.x/zh.ts @@ -176,12 +176,22 @@ export const zhSidebar = { { text: '监控工具', link: 'Monitor-Tool_timecho' }, { text: '测试工具', link: 'Benchmark' }, { text: '集群管理工具', link: 'Maintenance-Tool_timecho' }, - { text: '数据导入导出(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, - { text: 'TsFile导入导出(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, - { text: '数据导入(V1.3.3)', link: 'Data-Import-Tool' }, - { text: '数据导入(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, - { text: '数据导出(V1.3.3)', link: 'Data-Export-Tool' }, - { text: '数据导出(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + { text: '数据导入导出', collapsible: true, + children: [ + { text: '数据导入导出(V1.3.0/1/2)', link: 'Data-Import-Export-Tool' }, + { text: 'TsFile导入导出(V1.3.0/1/2)', link: 'TsFile-Import-Export-Tool' }, + { text: '数据导入(V1.3.3)', link: 'Data-Import-Tool' }, + { text: '数据导入(V1.3.4)', link: 'Data-Import-Tool-1-3-4' }, + { text: '数据导出(V1.3.3)', link: 'Data-Export-Tool' }, + { text: '数据导出(V1.3.4)', link: 'Data-Export-Tool-1-3-4' }, + ], + }, + { text: '元数据导入导出', collapsible: true, + children: [ + { text: '元数据导入', link: 'Schema-Import-Tool' }, + { text: '元数据导出', link: 'Schema-Export-Tool' }, + ], + }, { text: '全量备份工具(V1.3.2)', link: 'Backup-Tool' }, { text: '健康检查工具(V1.3.2)', link: 'Health-Check-Tool' }, ], diff --git a/src/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md b/src/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md new file mode 100644 index 000000000..9d1ec84ae --- /dev/null +++ b/src/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md @@ -0,0 +1,72 @@ + +# Metadata Export + +## 1. Overview + +The metadata export tool `export-schema.sh/bat` is located in the `tools` directory. It can export metadata from a specified database in IoTDB into CSV files. + +> Supported since version 1.3.3 + +## 2. Detailed Functionality + +### 2.1 Parameter Description + +| Short Parameter | Full Parameter | Description | Required | Default Value | +|-----------------|----------------|-------------|----------|---------------| +| `-h` | `--host` | Hostname | No | 127.0.0.1 | +| `-p` | `--port` | Port number | No | 6667 | +| `-u` | `--username` | Username | No | root | +| `-pw` | `--password` | Password. Hidden input is supported since V2.0.9-beta | No | root | +| `-t` | `--target` | Specifies the target directory for output files. The directory will be created if it does not exist | Yes | - | +| `-path` | `--path_pattern` | Specifies the path pattern for metadata export | Yes | - | +| `-pf` | `--path_pattern_file` | Specifies the name of the export file | No | - | +| `-lpf` | `--lines_per_file` | Specifies the maximum number of lines per exported dump file | No | `10000` | +| `-timeout` | `--queryTimeout` | Query timeout for the session (ms) | No | -1. Range: -1 ~ Long.MAX_VALUE = 9223372036854775807 | +| `-help` | `--help` | Displays help information | No | - | + +### 2.2 Execution Commands + +```Bash +# Unix/OS X +> tools/export-schema.sh [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] + +# Windows +> tools\export-schema.bat [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] +``` + +### 2.3 Usage Example + +```Bash +# Export metadata under the root.ln path +./export-schema.sh -t /home/ -path "root.ln.**" +``` + +```CSV +# Export result format +Timeseries,Alias,DataType,Encoding,Compression +root.ln.wf02.wt02.status,,BOOLEAN,RLE,LZ4 +root.ln.wf02.wt02.hardware,,TEXT,PLAIN,LZ4 +``` \ No newline at end of file diff --git a/src/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md b/src/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md new file mode 100644 index 000000000..f37cb0ab2 --- /dev/null +++ b/src/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md @@ -0,0 +1,82 @@ + + +# Metadata Import + +## 1. Overview + +The metadata import tool `import-schema.sh/bat` is located in the `tools` directory. It can import CSV files containing metadata creation statements from a specified path into IoTDB. + +> Supported since version 1.3.3 + +## 2. Detailed Functionality + +### 2.1 Parameter Description + +| Short Parameter | Full Parameter | Description | Required | Default Value | +|-----------------|----------------|-------------|----------|---------------| +| `-h` | `--host` | Hostname | No | 127.0.0.1 | +| `-p` | `--port` | Port number | No | 6667 | +| `-u` | `--username` | Username | No | root | +| `-pw` | `--password` | Password | No | root | +| `-s` | `--source` | Local path of the script file or directory to be loaded | Yes | - | +| `-fd` | `--fail_dir` | Specifies the directory to save failed files | No | - | +| `-lpf` | `--lines_per_failed_file` | Specifies the maximum number of lines per failed file | No | 100000. Range: 0 ~ Integer.MAX_VALUE = 2147483647 | +| `-help` | `--help` | Displays help information | No | - | + +### 2.2 Execution Commands + +```Bash +# Unix/OS X +tools/import-schema.sh [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] + +# Windows +tools\import-schema.bat [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] +``` + +### 2.3 Usage Example + +```SQL +-- Before import +IoTDB> show timeseries root.ln.** ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +|Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +``` + +```Bash +# Execute the import command +./import-schema.sh -s /home/dump0_0.csv +``` + +```SQL +-- Verify after successful import +IoTDB> show timeseries root.ln.** ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| root.ln.wf02.wt02.status| null| root.ln| BOOLEAN| RLE| LZ4|null| null| null| null| BASE| +|root.ln.wf02.wt02.hardware| null| root.ln| TEXT| PLAIN| LZ4|null| null| null| null| BASE| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +``` diff --git a/src/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md b/src/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md new file mode 100644 index 000000000..9d1ec84ae --- /dev/null +++ b/src/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md @@ -0,0 +1,72 @@ + +# Metadata Export + +## 1. Overview + +The metadata export tool `export-schema.sh/bat` is located in the `tools` directory. It can export metadata from a specified database in IoTDB into CSV files. + +> Supported since version 1.3.3 + +## 2. Detailed Functionality + +### 2.1 Parameter Description + +| Short Parameter | Full Parameter | Description | Required | Default Value | +|-----------------|----------------|-------------|----------|---------------| +| `-h` | `--host` | Hostname | No | 127.0.0.1 | +| `-p` | `--port` | Port number | No | 6667 | +| `-u` | `--username` | Username | No | root | +| `-pw` | `--password` | Password. Hidden input is supported since V2.0.9-beta | No | root | +| `-t` | `--target` | Specifies the target directory for output files. The directory will be created if it does not exist | Yes | - | +| `-path` | `--path_pattern` | Specifies the path pattern for metadata export | Yes | - | +| `-pf` | `--path_pattern_file` | Specifies the name of the export file | No | - | +| `-lpf` | `--lines_per_file` | Specifies the maximum number of lines per exported dump file | No | `10000` | +| `-timeout` | `--queryTimeout` | Query timeout for the session (ms) | No | -1. Range: -1 ~ Long.MAX_VALUE = 9223372036854775807 | +| `-help` | `--help` | Displays help information | No | - | + +### 2.2 Execution Commands + +```Bash +# Unix/OS X +> tools/export-schema.sh [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] + +# Windows +> tools\export-schema.bat [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] +``` + +### 2.3 Usage Example + +```Bash +# Export metadata under the root.ln path +./export-schema.sh -t /home/ -path "root.ln.**" +``` + +```CSV +# Export result format +Timeseries,Alias,DataType,Encoding,Compression +root.ln.wf02.wt02.status,,BOOLEAN,RLE,LZ4 +root.ln.wf02.wt02.hardware,,TEXT,PLAIN,LZ4 +``` \ No newline at end of file diff --git a/src/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md b/src/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md new file mode 100644 index 000000000..f37cb0ab2 --- /dev/null +++ b/src/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md @@ -0,0 +1,82 @@ + + +# Metadata Import + +## 1. Overview + +The metadata import tool `import-schema.sh/bat` is located in the `tools` directory. It can import CSV files containing metadata creation statements from a specified path into IoTDB. + +> Supported since version 1.3.3 + +## 2. Detailed Functionality + +### 2.1 Parameter Description + +| Short Parameter | Full Parameter | Description | Required | Default Value | +|-----------------|----------------|-------------|----------|---------------| +| `-h` | `--host` | Hostname | No | 127.0.0.1 | +| `-p` | `--port` | Port number | No | 6667 | +| `-u` | `--username` | Username | No | root | +| `-pw` | `--password` | Password | No | root | +| `-s` | `--source` | Local path of the script file or directory to be loaded | Yes | - | +| `-fd` | `--fail_dir` | Specifies the directory to save failed files | No | - | +| `-lpf` | `--lines_per_failed_file` | Specifies the maximum number of lines per failed file | No | 100000. Range: 0 ~ Integer.MAX_VALUE = 2147483647 | +| `-help` | `--help` | Displays help information | No | - | + +### 2.2 Execution Commands + +```Bash +# Unix/OS X +tools/import-schema.sh [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] + +# Windows +tools\import-schema.bat [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] +``` + +### 2.3 Usage Example + +```SQL +-- Before import +IoTDB> show timeseries root.ln.** ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +|Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +``` + +```Bash +# Execute the import command +./import-schema.sh -s /home/dump0_0.csv +``` + +```SQL +-- Verify after successful import +IoTDB> show timeseries root.ln.** ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| root.ln.wf02.wt02.status| null| root.ln| BOOLEAN| RLE| LZ4|null| null| null| null| BASE| +|root.ln.wf02.wt02.hardware| null| root.ln| TEXT| PLAIN| LZ4|null| null| null| null| BASE| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +``` diff --git a/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md new file mode 100644 index 000000000..a6c58535d --- /dev/null +++ b/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Export-Tool.md @@ -0,0 +1,72 @@ + + +# 元数据导出 + +## 1. 功能概述 + +元数据导出工具 `export-schema.sh/bat` 位于tools 目录下，能够将 IoTDB 中指定数据库下的元数据导出为csv文件。 + +> V1.3.3 版本起支持 + +## 2. 功能详解 + +### 2.1 参数介绍 + +| 参数缩写 | 参数全称 | 参数含义 | 是否为必填项 | 默认值 | +| -------------------- |------------------------|-------------------------------------------------|--------|---------------------------------------| +| `-h` | `-- host` | 主机名 | 否 | 127.0.0.1 | +| `-p` | `--port` | 端口号 | 否 | 6667 | +| `-u` | `--username` | 用户名 | 否 | root | +| `-pw` | `--password` | 密码，自 V2.0.9-beta 起支持隐藏输入 | 否 | root | +| `-t` | `--target` | 指定输出文件的目标文件夹，如果路径不存在新建文件夹 | 是 | | +| `-path` | `--path_pattern` | 指定导出元数据的path pattern | 是 | | +| `-pf` | `--path_pattern_file` | 指定导出文件的名称。 | 否 | | +| `-lpf` | `--lines_per_file` | 指定导出的dump文件最大行数 | 否 | `10000` | +| `-timeout` | `--queryTimeout` | 会话查询的超时时间(ms) | 否 | -1范围：-1～Long. max=9223372036854775807 | +| `-help` | `--help` | 显示帮助信息 | 否 | | + +### 2.2 运行命令 + +```Bash +Shell +# Unix/OS X +> tools/export-schema.sh [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] + +# Windows +> tools\export-schema.bat [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] +``` + +### 2.3 运行示例 + +```Bash +# 导出 root.ln路径下的元数据 +./export-schema.sh -t /home/ -path "root.ln.**" + +# 导出结果内容格式如下 +Timeseries,Alias,DataType,Encoding,Compression +root.ln.wf02.wt02.status,,BOOLEAN,RLE,LZ4 +root.ln.wf02.wt02.hardware,,TEXT,PLAIN,LZ4 +``` diff --git a/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md new file mode 100644 index 000000000..6342434a6 --- /dev/null +++ b/src/zh/UserGuide/V1.3.x/Tools-System/Schema-Import-Tool.md @@ -0,0 +1,78 @@ + + +# 元数据导入 + +## 1. 功能概述 + +元数据导入工具 `import-schema.sh/bat` 位于tools 目录下，能够将指定路径下创建元数据的csv文件导入到 IoTDB 中。 + +> V1.3.3 版本起支持 + +## 2. 功能详解 + +### 2.1 参数介绍 + +| 参数缩写 | 参数全称 | 参数含义 | 是否为必填项 | 默认值 | +|------------|---------------------------|---------------------------------| -------------- |-----------------------------------| +| `-h` | `-- host` | 主机名 | 否 | 127.0.0.1 | +| `-p` | `--port` | 端口号 | 否 | 6667 | +| `-u` | `--username` | 用户名 | 否 | root | +| `-pw` | `--password` | 密码 | 否 | root | +| `-s` | `--source` | 待加载的脚本文件(夹)的本地目录路径。 | 是 | | +| `-fd` | `--fail_dir` | 指定保存失败文件的目录 | 否 | | +| `-lpf` | `--lines_per_failed_file` | 指定失败文件最大写入数据的行数 | 否 | 100000范围：0～Integer.Max=2147483647 | +| `-help` | `--help` | 显示帮助信息 | 否 | | + +### 2.2 运行命令 + +```Bash +# Unix/OS X +tools/import-schema.sh [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] + +# Windows +tools\import-schema.bat [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] +``` + +### 2.3 运行示例 + +```Bash +# 导入前 +IoTDB> show timeseries root.ln.** ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +|Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ + +# 执行导入命令 +./import-schema.sh -s /home/dump0_0.csv + +# 导入成功后验证 +IoTDB> show timeseries root.ln.** ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| root.ln.wf02.wt02.status| null| root.ln| BOOLEAN| RLE| LZ4|null| null| null| null| BASE| +|root.ln.wf02.wt02.hardware| null| root.ln| TEXT| PLAIN| LZ4|null| null| null| null| BASE| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +``` diff --git a/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md b/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md new file mode 100644 index 000000000..a6c58535d --- /dev/null +++ b/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Export-Tool.md @@ -0,0 +1,72 @@ + + +# 元数据导出 + +## 1. 功能概述 + +元数据导出工具 `export-schema.sh/bat` 位于tools 目录下，能够将 IoTDB 中指定数据库下的元数据导出为csv文件。 + +> V1.3.3 版本起支持 + +## 2. 功能详解 + +### 2.1 参数介绍 + +| 参数缩写 | 参数全称 | 参数含义 | 是否为必填项 | 默认值 | +| -------------------- |------------------------|-------------------------------------------------|--------|---------------------------------------| +| `-h` | `-- host` | 主机名 | 否 | 127.0.0.1 | +| `-p` | `--port` | 端口号 | 否 | 6667 | +| `-u` | `--username` | 用户名 | 否 | root | +| `-pw` | `--password` | 密码，自 V2.0.9-beta 起支持隐藏输入 | 否 | root | +| `-t` | `--target` | 指定输出文件的目标文件夹，如果路径不存在新建文件夹 | 是 | | +| `-path` | `--path_pattern` | 指定导出元数据的path pattern | 是 | | +| `-pf` | `--path_pattern_file` | 指定导出文件的名称。 | 否 | | +| `-lpf` | `--lines_per_file` | 指定导出的dump文件最大行数 | 否 | `10000` | +| `-timeout` | `--queryTimeout` | 会话查询的超时时间(ms) | 否 | -1范围：-1～Long. max=9223372036854775807 | +| `-help` | `--help` | 显示帮助信息 | 否 | | + +### 2.2 运行命令 + +```Bash +Shell +# Unix/OS X +> tools/export-schema.sh [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] + +# Windows +> tools\export-schema.bat [-h ] [-p ] [-u ] [-pw ] -t + [-path ] [-pf ] [-lpf ] + [-timeout ] [-help] +``` + +### 2.3 运行示例 + +```Bash +# 导出 root.ln路径下的元数据 +./export-schema.sh -t /home/ -path "root.ln.**" + +# 导出结果内容格式如下 +Timeseries,Alias,DataType,Encoding,Compression +root.ln.wf02.wt02.status,,BOOLEAN,RLE,LZ4 +root.ln.wf02.wt02.hardware,,TEXT,PLAIN,LZ4 +``` diff --git a/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md b/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md new file mode 100644 index 000000000..6342434a6 --- /dev/null +++ b/src/zh/UserGuide/dev-1.3/Tools-System/Schema-Import-Tool.md @@ -0,0 +1,78 @@ + + +# 元数据导入 + +## 1. 功能概述 + +元数据导入工具 `import-schema.sh/bat` 位于tools 目录下，能够将指定路径下创建元数据的csv文件导入到 IoTDB 中。 + +> V1.3.3 版本起支持 + +## 2. 功能详解 + +### 2.1 参数介绍 + +| 参数缩写 | 参数全称 | 参数含义 | 是否为必填项 | 默认值 | +|------------|---------------------------|---------------------------------| -------------- |-----------------------------------| +| `-h` | `-- host` | 主机名 | 否 | 127.0.0.1 | +| `-p` | `--port` | 端口号 | 否 | 6667 | +| `-u` | `--username` | 用户名 | 否 | root | +| `-pw` | `--password` | 密码 | 否 | root | +| `-s` | `--source` | 待加载的脚本文件(夹)的本地目录路径。 | 是 | | +| `-fd` | `--fail_dir` | 指定保存失败文件的目录 | 否 | | +| `-lpf` | `--lines_per_failed_file` | 指定失败文件最大写入数据的行数 | 否 | 100000范围：0～Integer.Max=2147483647 | +| `-help` | `--help` | 显示帮助信息 | 否 | | + +### 2.2 运行命令 + +```Bash +# Unix/OS X +tools/import-schema.sh [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] + +# Windows +tools\import-schema.bat [-h ] [-p ] [-u ] [-pw ] -s + [-fd ] [-batch ] [-lpf ] [-help] +``` + +### 2.3 运行示例 + +```Bash +# 导入前 +IoTDB> show timeseries root.ln.** ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +|Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ ++----------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ + +# 执行导入命令 +./import-schema.sh -s /home/dump0_0.csv + +# 导入成功后验证 +IoTDB> show timeseries root.ln.** ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| Timeseries|Alias|Database|DataType|Encoding|Compression|Tags|Attributes|Deadband|DeadbandParameters|ViewType| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +| root.ln.wf02.wt02.status| null| root.ln| BOOLEAN| RLE| LZ4|null| null| null| null| BASE| +|root.ln.wf02.wt02.hardware| null| root.ln| TEXT| PLAIN| LZ4|null| null| null| null| BASE| ++--------------------------+-----+--------+--------+--------+-----------+----+----------+--------+------------------+--------+ +```