MySQL :: MySQL 8.4 参考手册 :: 15.2.10 LOAD XML 语句

版本 8.4

8.0 日语

MySQL 8.4 参考手册 / ... / LOAD XML 语句

15.2.10 LOAD XML 语句

Press CTRL+C to copy
 
LOAD XML
    [LOW_PRIORITY | CONCURRENT] [LOCAL]
    INFILE 'file_name'
    [REPLACE | IGNORE]
    INTO TABLE [db_name.]tbl_name
    [CHARACTER SET charset_name]
    [ROWS IDENTIFIED BY '<tagname>']
    [IGNORE number {LINES | ROWS}]
    [(field_name_or_user_var
        [, field_name_or_user_var] ...)]
    [SET col_name={expr | DEFAULT}
        [, col_name={expr | DEFAULT}] ...]

The LOAD XML 语句从 XML 文件读取数据到表中。 file_name 必须作为文字字符串给出。可选的 ROWS IDENTIFIED BY 子句中的 tagname 也必须作为文字字符串给出，并且必须用尖括号（< 和 >）包围。

LOAD XML 充当在 XML 输出模式下运行 mysql 客户端的补充（即，使用 --xml 选项启动客户端）。要将数据从表写入 XML 文件，您可以从系统 shell 调用 mysql 客户端，并使用 --xml 和 -e 选项，如下所示

Press CTRL+C to copy
 
$> mysql --xml -e 'SELECT * FROM mydb.mytable' > file.xml

要将文件读回表，请使用 LOAD XML。默认情况下，<row> 元素被认为等效于数据库表行；这可以使用 ROWS IDENTIFIED BY 子句更改。

此语句支持三种不同的 XML 格式

将列名作为属性，将列值作为属性值

Press CTRL+C to copy
 
<row column1="value1" column2="value2" .../>

将列名作为标签，将列值作为这些标签的内容

Press CTRL+C to copy
 
<row>
  <column1>value1</column1>
  <column2>value2</column2>
</row>

列名是 <field> 标签的 name 属性，值是这些标签的内容
```
Press CTRL+C to copy
 
<row>
  <field name='column1'>value1</field>
  <field name='column2'>value2</field>
</row>
```
这是其他 MySQL 工具（例如 mysqldump）使用的格式。

所有三种格式都可以在同一个 XML 文件中使用；导入例程会自动检测每行的格式并正确解释它。标签根据标签或属性名称以及列名进行匹配。

以下子句对于 LOAD XML 的作用与对于 LOAD DATA 的作用基本相同

LOW_PRIORITY 或 CONCURRENT
LOCAL
REPLACE 或 IGNORE
CHARACTER SET
SET

有关这些子句的更多信息，请参见第 15.2.9 节，“LOAD DATA 语句”。

(field_name_or_user_var, ...) 是一个或多个用逗号分隔的 XML 字段或用户变量的列表。用于此目的的用户变量的名称必须与 XML 文件中字段的名称匹配，并在前面加上 @。您可以使用字段名来仅选择所需的字段。用户变量可以用于存储相应的字段值以供后续重复使用。

IGNORE number LINES 或 IGNORE number ROWS 子句导致跳过 XML 文件中的前 number 行。它类似于 LOAD DATA 语句的 IGNORE ... LINES 子句。

假设我们有一个名为 person 的表，创建方式如下所示

Press CTRL+C to copy
 
USE test;

CREATE TABLE person (
    person_id INT NOT NULL PRIMARY KEY,
    fname VARCHAR(40) NULL,
    lname VARCHAR(40) NULL,
    created TIMESTAMP
);

假设该表最初为空。

现在假设我们有一个简单的 XML 文件 person.xml，其内容如下所示

Press CTRL+C to copy
 
<list>
  <person person_id="1" fname="Kapek" lname="Sainnouine"/>
  <person person_id="2" fname="Sajon" lname="Rondela"/>
  <person person_id="3"><fname>Likame</fname><lname>Örrtmons</lname></person>
  <person person_id="4"><fname>Slar</fname><lname>Manlanth</lname></person>
  <person><field name="person_id">5</field><field name="fname">Stoma</field>
    <field name="lname">Milu</field></person>
  <person><field name="person_id">6</field><field name="fname">Nirtam</field>
    <field name="lname">Sklöd</field></person>
  <person person_id="7"><fname>Sungam</fname><lname>Dulbåd</lname></person>
  <person person_id="8" fname="Sraref" lname="Encmelt"/>
</list>

此示例文件表示了前面讨论的每种可接受的 XML 格式。

要将 person.xml 中的数据导入 person 表，可以使用以下语句

Press CTRL+C to copy
 
mysql> LOAD XML LOCAL INFILE 'person.xml'
    ->   INTO TABLE person
    ->   ROWS IDENTIFIED BY '<person>';

Query OK, 8 rows affected (0.00 sec)
Records: 8  Deleted: 0  Skipped: 0  Warnings: 0

这里，我们假设 person.xml 位于 MySQL 数据目录中。如果找不到该文件，则会导致以下错误

Press CTRL+C to copy
 
ERROR 2 (HY000): File '/person.xml' not found (Errcode: 2)

ROWS IDENTIFIED BY '<person>' 子句表示 XML 文件中的每个 <person> 元素都被视为要导入数据的表中的一行。在本例中，这是 test 数据库中的 person 表。

正如服务器响应所示，已将 8 行导入 test.person 表。这可以通过简单的 SELECT 语句进行验证

Press CTRL+C to copy
 
mysql> SELECT * FROM person;
+-----------+--------+------------+---------------------+
| person_id | fname  | lname      | created             |
+-----------+--------+------------+---------------------+
|         1 | Kapek  | Sainnouine | 2007-07-13 16:18:47 |
|         2 | Sajon  | Rondela    | 2007-07-13 16:18:47 |
|         3 | Likame | Örrtmons   | 2007-07-13 16:18:47 |
|         4 | Slar   | Manlanth   | 2007-07-13 16:18:47 |
|         5 | Stoma  | Nilu       | 2007-07-13 16:18:47 |
|         6 | Nirtam | Sklöd      | 2007-07-13 16:18:47 |
|         7 | Sungam | Dulbåd     | 2007-07-13 16:18:47 |
|         8 | Sreraf | Encmelt    | 2007-07-13 16:18:47 |
+-----------+--------+------------+---------------------+
8 rows in set (0.00 sec)

这表明，正如本节前面所述，任何或所有 3 种允许的 XML 格式都可能出现在同一个文件中，并且可以使用 LOAD XML 读取。

刚刚显示的导入操作的逆操作（即，将 MySQL 表数据转储到 XML 文件）可以使用系统 shell 中的 mysql 客户端完成，如下所示

Press CTRL+C to copy
 
$> mysql --xml -e "SELECT * FROM test.person" > person-dump.xml
$> cat person-dump.xml
<?xml version="1.0"?>

<resultset statement="SELECT * FROM test.person" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <row>
	<field name="person_id">1</field>
	<field name="fname">Kapek</field>
	<field name="lname">Sainnouine</field>
  </row>

  <row>
	<field name="person_id">2</field>
	<field name="fname">Sajon</field>
	<field name="lname">Rondela</field>
  </row>

  <row>
	<field name="person_id">3</field>
	<field name="fname">Likema</field>
	<field name="lname">Örrtmons</field>
  </row>

  <row>
	<field name="person_id">4</field>
	<field name="fname">Slar</field>
	<field name="lname">Manlanth</field>
  </row>

  <row>
	<field name="person_id">5</field>
	<field name="fname">Stoma</field>
	<field name="lname">Nilu</field>
  </row>

  <row>
	<field name="person_id">6</field>
	<field name="fname">Nirtam</field>
	<field name="lname">Sklöd</field>
  </row>

  <row>
	<field name="person_id">7</field>
	<field name="fname">Sungam</field>
	<field name="lname">Dulbåd</field>
  </row>

  <row>
	<field name="person_id">8</field>
	<field name="fname">Sreraf</field>
	<field name="lname">Encmelt</field>
  </row>
</resultset>

注意

--xml 选项使 mysql 客户端对它的输出使用 XML 格式；-e 选项使客户端立即执行该选项后面的 SQL 语句。请参见第 6.5.1 节，“mysql — The MySQL 命令行客户端”。

您可以通过创建 person 表的副本并将转储文件导入新表来验证转储是否有效，例如

Press CTRL+C to copy
 
mysql> USE test;
mysql> CREATE TABLE person2 LIKE person;
Query OK, 0 rows affected (0.00 sec)

mysql> LOAD XML LOCAL INFILE 'person-dump.xml'
    ->   INTO TABLE person2;
Query OK, 8 rows affected (0.01 sec)
Records: 8  Deleted: 0  Skipped: 0  Warnings: 0

mysql> SELECT * FROM person2;
+-----------+--------+------------+---------------------+
| person_id | fname  | lname      | created             |
+-----------+--------+------------+---------------------+
|         1 | Kapek  | Sainnouine | 2007-07-13 16:18:47 |
|         2 | Sajon  | Rondela    | 2007-07-13 16:18:47 |
|         3 | Likema | Örrtmons   | 2007-07-13 16:18:47 |
|         4 | Slar   | Manlanth   | 2007-07-13 16:18:47 |
|         5 | Stoma  | Nilu       | 2007-07-13 16:18:47 |
|         6 | Nirtam | Sklöd      | 2007-07-13 16:18:47 |
|         7 | Sungam | Dulbåd     | 2007-07-13 16:18:47 |
|         8 | Sreraf | Encmelt    | 2007-07-13 16:18:47 |
+-----------+--------+------------+---------------------+
8 rows in set (0.00 sec)

不需要 XML 文件中的每个字段都与相应表中的列匹配。没有对应列的字段将被跳过。您可以通过首先清空 person2 表并删除 created 列，然后使用与之前使用的相同的 LOAD XML 语句来看到这一点，如下所示

Press CTRL+C to copy
 
mysql> TRUNCATE person2;
Query OK, 8 rows affected (0.26 sec)

mysql> ALTER TABLE person2 DROP COLUMN created;
Query OK, 0 rows affected (0.52 sec)
Records: 0  Duplicates: 0  Warnings: 0

mysql> SHOW CREATE TABLE person2\G
*************************** 1. row ***************************
       Table: person2
Create Table: CREATE TABLE `person2` (
  `person_id` int NOT NULL,
  `fname` varchar(40) DEFAULT NULL,
  `lname` varchar(40) DEFAULT NULL,
  PRIMARY KEY (`person_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

mysql> LOAD XML LOCAL INFILE 'person-dump.xml'
    ->   INTO TABLE person2;
Query OK, 8 rows affected (0.01 sec)
Records: 8  Deleted: 0  Skipped: 0  Warnings: 0

mysql> SELECT * FROM person2;
+-----------+--------+------------+
| person_id | fname  | lname      |
+-----------+--------+------------+
|         1 | Kapek  | Sainnouine |
|         2 | Sajon  | Rondela    |
|         3 | Likema | Örrtmons   |
|         4 | Slar   | Manlanth   |
|         5 | Stoma  | Nilu       |
|         6 | Nirtam | Sklöd      |
|         7 | Sungam | Dulbåd     |
|         8 | Sreraf | Encmelt    |
+-----------+--------+------------+
8 rows in set (0.00 sec)

XML 文件中每行内字段的顺序不影响 LOAD XML 的操作；字段顺序可以在各行之间变化，并且不需要与表中相应列的顺序相同。

如前所述，您可以使用一个 (field_name_or_user_var, ...) 列表，其中包含一个或多个 XML 字段（仅选择所需的字段）或用户变量（将相应的字段值存储以供以后使用）。当您想将数据从 XML 文件插入到名称与 XML 字段名称不匹配的表列中时，用户变量特别有用。为了查看此方法的工作原理，我们首先创建一个名为 individual 的表，其结构与 person 表的结构匹配，但列名不同

Press CTRL+C to copy
 
mysql> CREATE TABLE individual (
    ->     individual_id INT NOT NULL PRIMARY KEY,
    ->     name1 VARCHAR(40) NULL,
    ->     name2 VARCHAR(40) NULL,
    ->     made TIMESTAMP
    -> );
Query OK, 0 rows affected (0.42 sec)

在这种情况下，您不能简单地将 XML 文件直接加载到表中，因为字段和列名不匹配

Press CTRL+C to copy
 
mysql> LOAD XML INFILE '../bin/person-dump.xml' INTO TABLE test.individual;
ERROR 1263 (22004): Column set to default value; NULL supplied to NOT NULL column 'individual_id' at row 1

发生这种情况是因为 MySQL 服务器会查找与目标表的列名匹配的字段名。您可以通过将字段值选择到用户变量中，然后使用 SET 将目标表的列设置为这些变量的值来解决此问题。您可以用单个语句执行这两项操作，如下所示

Press CTRL+C to copy
 
mysql> LOAD XML INFILE '../bin/person-dump.xml'
    ->     INTO TABLE test.individual (@person_id, @fname, @lname, @created)
    ->     SET individual_id=@person_id, name1=@fname, name2=@lname, made=@created;
Query OK, 8 rows affected (0.05 sec)
Records: 8  Deleted: 0  Skipped: 0  Warnings: 0

mysql> SELECT * FROM individual;
+---------------+--------+------------+---------------------+
| individual_id | name1  | name2      | made                |
+---------------+--------+------------+---------------------+
|             1 | Kapek  | Sainnouine | 2007-07-13 16:18:47 |
|             2 | Sajon  | Rondela    | 2007-07-13 16:18:47 |
|             3 | Likema | Örrtmons   | 2007-07-13 16:18:47 |
|             4 | Slar   | Manlanth   | 2007-07-13 16:18:47 |
|             5 | Stoma  | Nilu       | 2007-07-13 16:18:47 |
|             6 | Nirtam | Sklöd      | 2007-07-13 16:18:47 |
|             7 | Sungam | Dulbåd     | 2007-07-13 16:18:47 |
|             8 | Srraf  | Encmelt    | 2007-07-13 16:18:47 |
+---------------+--------+------------+---------------------+
8 rows in set (0.00 sec)

用户变量的名称必须与 XML 文件中相应字段的名称匹配，并添加必需的 @ 前缀来指示它们是变量。用户变量不需要按与相应字段相同的顺序列出或赋值。

使用 ROWS IDENTIFIED BY '<tagname>' 子句，可以将数据从同一个 XML 文件导入到具有不同定义的数据库表中。对于此示例，假设您有一个名为 address.xml 的文件，其中包含以下 XML

Press CTRL+C to copy
 
<?xml version="1.0"?>

<list>
  <person person_id="1">
    <fname>Robert</fname>
    <lname>Jones</lname>
    <address address_id="1" street="Mill Creek Road" zip="45365" city="Sidney"/>
    <address address_id="2" street="Main Street" zip="28681" city="Taylorsville"/>
  </person>

  <person person_id="2">
    <fname>Mary</fname>
    <lname>Smith</lname>
    <address address_id="3" street="River Road" zip="80239" city="Denver"/>
    <!-- <address address_id="4" street="North Street" zip="37920" city="Knoxville"/> -->
  </person>

</list>

您可以在本节前面定义的 test.person 表中再次使用，清除表中所有现有记录，然后显示其结构，如下所示

Press CTRL+C to copy
 
mysql< TRUNCATE person;
Query OK, 0 rows affected (0.04 sec)

mysql< SHOW CREATE TABLE person\G
*************************** 1. row ***************************
       Table: person
Create Table: CREATE TABLE `person` (
  `person_id` int(11) NOT NULL,
  `fname` varchar(40) DEFAULT NULL,
  `lname` varchar(40) DEFAULT NULL,
  `created` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
  PRIMARY KEY (`person_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci
1 row in set (0.00 sec)

现在使用以下 CREATE TABLE 语句在 test 数据库中创建一个 address 表

Press CTRL+C to copy
 
CREATE TABLE address (
    address_id INT NOT NULL PRIMARY KEY,
    person_id INT NULL,
    street VARCHAR(40) NULL,
    zip INT NULL,
    city VARCHAR(40) NULL,
    created TIMESTAMP
);

要将 XML 文件中的数据导入 person 表，请执行以下 LOAD XML 语句，该语句指定行应由 <person> 元素指定，如下所示；

Press CTRL+C to copy
 
mysql> LOAD XML LOCAL INFILE 'address.xml'
    ->   INTO TABLE person
    ->   ROWS IDENTIFIED BY '<person>';
Query OK, 2 rows affected (0.00 sec)
Records: 2  Deleted: 0  Skipped: 0  Warnings: 0

您可以使用 SELECT 语句验证记录是否已导入

Press CTRL+C to copy
 
mysql> SELECT * FROM person;
+-----------+--------+-------+---------------------+
| person_id | fname  | lname | created             |
+-----------+--------+-------+---------------------+
|         1 | Robert | Jones | 2007-07-24 17:37:06 |
|         2 | Mary   | Smith | 2007-07-24 17:37:06 |
+-----------+--------+-------+---------------------+
2 rows in set (0.00 sec)

由于 XML 文件中的 <address> 元素在 person 表中没有对应列，因此它们将被跳过。

要将 <address> 元素中的数据导入 address 表，请使用以下所示的 LOAD XML 语句

Press CTRL+C to copy
 
mysql> LOAD XML LOCAL INFILE 'address.xml'
    ->   INTO TABLE address
    ->   ROWS IDENTIFIED BY '<address>';
Query OK, 3 rows affected (0.00 sec)
Records: 3  Deleted: 0  Skipped: 0  Warnings: 0

您可以看到，使用如下所示的 SELECT 语句已导入数据

Press CTRL+C to copy
 
mysql> SELECT * FROM address;
+------------+-----------+-----------------+-------+--------------+---------------------+
| address_id | person_id | street          | zip   | city         | created             |
+------------+-----------+-----------------+-------+--------------+---------------------+
|          1 |         1 | Mill Creek Road | 45365 | Sidney       | 2007-07-24 17:37:37 |
|          2 |         1 | Main Street     | 28681 | Taylorsville | 2007-07-24 17:37:37 |
|          3 |         2 | River Road      | 80239 | Denver       | 2007-07-24 17:37:37 |
+------------+-----------+-----------------+-------+--------------+---------------------+
3 rows in set (0.00 sec)

包含在 XML 注释中的 <address> 元素中的数据未导入。但是，由于 address 表中有一个 person_id 列，因此每个 <address> 的父 <person> 元素的 person_id 属性的值确实被导入到 address 表中。

安全注意事项。 与 LOAD DATA 语句一样，从客户端主机到服务器主机的 XML 文件传输是由 MySQL 服务器启动的。理论上，可以构建一个修补后的服务器，它会告诉客户端程序传输服务器选择的文件，而不是客户端在 LOAD XML 语句中命名的文件。这样的服务器可以访问客户端主机上的任何文件，只要客户端用户对该文件具有读访问权限。

在 Web 环境中，客户端通常从 Web 服务器连接到 MySQL。可以对 MySQL 服务器运行任何命令的用户可以使用 LOAD XML LOCAL 来读取 Web 服务器进程具有读访问权限的任何文件。在此环境中，相对于 MySQL 服务器的客户端实际上是 Web 服务器，而不是由连接到 Web 服务器的用户运行的远程程序。

您可以通过使用 --local-infile=0 或 --local-infile=OFF 启动服务器来禁用从客户端加载 XML 文件。此选项也可以在启动 mysql 客户端时使用，以禁用客户端会话期间的 LOAD XML。

要防止客户端从服务器加载 XML 文件，请不要对相应的 MySQL 用户帐户授予 FILE 权限，或者如果客户端用户帐户已经拥有此权限，则撤销此权限。

重要

撤销 FILE 权限（或一开始不授予此权限）只会阻止用户执行 LOAD XML 语句（以及 LOAD_FILE() 函数）；它不会阻止用户执行 LOAD XML LOCAL。要禁止此语句，您必须使用 --local-infile=OFF 启动服务器或客户端。

换句话说，FILE 权限只影响客户端是否可以读取服务器上的文件；它与客户端是否可以读取本地文件系统上的文件无关。

PREV HOME UP NEXT