src/zh/UserGuide/Master/Table/Tools-System/Schema-Import-Tool_apache.md

<!--

    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at
    
        http://www.apache.org/licenses/LICENSE-2.0
    
    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.

-->

# 元数据导入

## 1. 功能概述

元数据导入工具 `import-schema.sh/bat` 位于tools 目录下，能够将指定路径下创建元数据的脚本文件导入到 IoTDB 中。

## 2. 功能详解

### 2.1 参数介绍

| 参数缩写            | 参数全称                      | 参数含义                                           | 是否为必填项 | 默认值                               |
| --------------------- | ------------------------------- |------------------------------------------------| -------------- |-----------------------------------|
| `-h`            | `-- host`                 | 主机名                                            | 否           | 127.0.0.1                         |
| `-p`            | `--port`                  | 端口号                                            | 否           | 6667                              |
| `-u`            | `--username`              | 用户名                                            | 否           | root                              |
| `-pw`           | `--password`              | 密码，自 V2.0.9-beta 起支持隐藏输入                       | 否           | root                              |
| `-sql_dialect` | `--sql_dialect`           | 选择 server 是树模型还是表模型，当前支持 tree 和 table 类型       | 否           | tree                              |
| `-db`           | `--database`              | 将要导入的目标数据库                                     | `是`     | -                                 |
| `-table`        | `--table`                 | 将要导入的目标表，只在`-sql_dialect`为 table 类型下生效。        | 否          | -                                 |
| `-s`            | `--source`                | 待加载的脚本文件(夹)的本地目录路径。                            | 是           |                                   |
| `-fd`           | `--fail_dir`              | 指定保存失败文件的目录                                    | 否           |                                   |
| `-lpf`          | `--lines_per_failed_file` | 指定失败文件最大写入数据的行数，只在`-sql_dialect`为 table 类型下生效。 | 否          | 100000范围：0～Integer.Max=2147483647 |
| `-help`         | `--help`                  | 显示帮助信息                                         | 否           |                                   |
| `-usessl`      | `--use_ssl`                | 使用 SSL 协议，自 V2.0.9-beta 起支持                    | 否      | -                                    |
| `-ts`          | `--trust_store`            | 信任库。支持隐藏输入，自 V2.0.9-beta 起支持                   | 否      | -                                    |
| `-tpw`         | `--trust_store_password`   | 信任库密码。支持隐藏输入，自 V2.0.9-beta 起支持                 | 否        | -                                    |

### 2.2 运行命令

```Bash
# Unix/OS X
tools/import-schema.sh [-sql_dialect<sql_dialect>] -db<database> -table<table> 
     [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
       -s <source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>]
      
# Windows
# V2.0.4.x 版本之前
tools\import-schema.bat [-sql_dialect<sql_dialect>] -db<database> -table<table>  
        [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
       -s <source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] 
       
# V2.0.4.x 版本及之后        
tools\windows\schema\import-schema.bat [-sql_dialect<sql_dialect>] -db<database> -table<table>  
        [-h <host>] [-p <port>] [-u <username>] [-pw <password>]
       -s <source> [-fd <fail_dir>] [-lpf <lines_per_failed_file>] 
```

### 2.3 运行示例


将 `/home `下的文件 `dump_database1.sql` 导入到 `database2 `中，文件内容如下：

```sql
DROP TABLE IF EXISTS table1;
CREATE TABLE table1(
        time TIMESTAMP TIME,
        region STRING TAG,
        plant_id STRING TAG,
        device_id STRING TAG,
        model_id STRING ATTRIBUTE,
        maintenance STRING ATTRIBUTE,
        temperature FLOAT FIELD,
        humidity FLOAT FIELD,
        status BOOLEAN FIELD,
        arrival_time TIMESTAMP FIELD
);
DROP TABLE IF EXISTS table2;
CREATE TABLE table2(
        time TIMESTAMP TIME,
        region STRING TAG,
        plant_id STRING TAG,
        device_id STRING TAG,
        model_id STRING ATTRIBUTE,
        maintenance STRING ATTRIBUTE,
        temperature FLOAT FIELD,
        humidity FLOAT FIELD,
        status BOOLEAN FIELD,
        arrival_time TIMESTAMP FIELD
);
```

执行脚本：

```Bash
./import-schema.sh -sql_dialect table -s /home/dump_database1.sql -db database2 

# database2 不存在时，提示错误信息如下
The target database database2 does not exist

# database2 存在时，提示成功
Import completely!
```

验证导入元数据：

```Bash
# 导入前
IoTDB:database2> show tables
+---------+-------+
|TableName|TTL(ms)|
+---------+-------+
+---------+-------+
Empty set.

# 导入后
IoTDB:database2> show tables details
+---------+-------+------+-------+
|TableName|TTL(ms)|Status|Comment|
+---------+-------+------+-------+
|   table2|    INF| USING|   null|
|   table1|    INF| USING|   null|
+---------+-------+------+-------+

IoTDB:database2> desc table1
+------------+---------+---------+
|  ColumnName| DataType| Category|
+------------+---------+---------+
|        time|TIMESTAMP|     TIME|
|      region|   STRING|      TAG|
|    plant_id|   STRING|      TAG|
|   device_id|   STRING|      TAG|
|    model_id|   STRING|ATTRIBUTE|
| maintenance|   STRING|ATTRIBUTE|
| temperature|    FLOAT|    FIELD|
|    humidity|    FLOAT|    FIELD|
|      status|  BOOLEAN|    FIELD|
|arrival_time|TIMESTAMP|    FIELD|
+------------+---------+---------+
 
IoTDB:database2> desc table2
+------------+---------+---------+
|  ColumnName| DataType| Category|
+------------+---------+---------+
|        time|TIMESTAMP|     TIME|
|      region|   STRING|      TAG|
|    plant_id|   STRING|      TAG|
|   device_id|   STRING|      TAG|
|    model_id|   STRING|ATTRIBUTE|
| maintenance|   STRING|ATTRIBUTE|
| temperature|    FLOAT|    FIELD|
|    humidity|    FLOAT|    FIELD|
|      status|  BOOLEAN|    FIELD|
|arrival_time|TIMESTAMP|    FIELD|
+------------+---------+---------+
```