导出查询结果集

本文档介绍如何使用 SELECT INTO OUTFILE 命令进行查询结果的导出操作。

SELECT INTO OUTFILE 是一个同步命令,命令返回即表示操作结束,同时会返回一行结果来展示导出的执行结果。

示例

导出到HDFS

将简单查询结果导出到文件 hdfs://path/to/result.txt,指定导出格式为 CSV。

1. SELECT * FROM tbl
2. INTO OUTFILE "hdfs://path/to/result_"
3. FORMAT AS CSV
4. PROPERTIES
5. (
6. "broker.name" = "my_broker",
7. "column_separator" = ",",
8. "line_delimiter" = "\n"
9. );

导出到本地文件

导出到本地文件时需要先在fe.conf中配置enable_outfile_to_local=true

1. select * from tbl1 limit 10
2. INTO OUTFILE "file:///home/work/path/result_";

更多用法可查看OUTFILE文档。

并发导出

默认情况下,查询结果集的导出是非并发的,也就是单点导出。如果用户希望查询结果集可以并发导出,需要满足以下条件:

  1. session variable ‘enable_parallel_outfile’ 开启并发导出: set enable_parallel_outfile = true;
  2. 导出方式为 S3 , 或者 HDFS, 而不是使用 broker
  3. 查询可以满足并发导出的需求,比如顶层不包含 sort 等单点节点。(后面会举例说明,哪种属于不可并发导出结果集的查询)

满足以上三个条件,就能触发并发导出查询结果集了。并发度 = be_instacne_num * parallel_fragment_exec_instance_num

如何验证结果集被并发导出

用户通过 session 变量设置开启并发导出后,如果想验证当前查询是否能进行并发导出,则可以通过下面这个方法。

1. explain select xxx from xxx where xxx  into outfile "s3://xxx" format as csv properties ("AWS_ENDPOINT" = "xxx", ...);

对查询进行 explain 后,Doris 会返回该查询的规划,如果你发现 RESULT FILE SINK 出现在 PLAN FRAGMENT 1 中,就说明导出并发开启成功了。 如果 RESULT FILE SINK 出现在 PLAN FRAGMENT 0 中,则说明当前查询不能进行并发导出 (当前查询不同时满足并发导出的三个条件)。

1. 并发导出的规划示例:
2. +-----------------------------------------------------------------------------+
3. | Explain String                                                              |
4. +-----------------------------------------------------------------------------+
5. | PLAN FRAGMENT 0                                                             |
6. |  OUTPUT EXPRS:<slot 2> | <slot 3> | <slot 4> | <slot 5>                     |
7. |   PARTITION: UNPARTITIONED                                                  |
8. |                                                                             |
9. |   RESULT SINK                                                               |
10. |                                                                             |
11. |   1:EXCHANGE                                                                |
12. |                                                                             |
13. | PLAN FRAGMENT 1                                                             |
14. |  OUTPUT EXPRS:`k1` + `k2`                                                   |
15. |   PARTITION: HASH_PARTITIONED: `default_cluster:test`.`multi_tablet`.`k1`   |
16. |                                                                             |
17. |   RESULT FILE SINK                                                          |
18. |   FILE PATH: s3://ml-bd-repo/bpit_test/outfile_1951_                        |
19. |   STORAGE TYPE: S3                                                          |
20. |                                                                             |
21. |   0:OlapScanNode                                                            |
22. |      TABLE: multi_tablet                                                    |
23. +-----------------------------------------------------------------------------+

返回结果

导出命令为同步命令。命令返回,即表示操作结束。同时会返回一行结果来展示导出的执行结果。

如果正常导出并返回,则结果如下:

1. mysql> select * from tbl1 limit 10 into outfile "file:///home/work/path/result_";
2. +------------+-----------+----------+--------------------------------------------------------------------+
3. | FileNumber | TotalRows | FileSize | URL                                                                |
4. +------------+-----------+----------+--------------------------------------------------------------------+
5. |          1 |         2 |        8 | file:///192.168.1.10/home/work/path/result_{fragment_instance_id}_ |
6. +------------+-----------+----------+--------------------------------------------------------------------+
7. 1 row in set (0.05 sec)
  • FileNumber:最终生成的文件个数。
  • TotalRows:结果集行数。
  • FileSize:导出文件总大小。单位字节。
  • URL:如果是导出到本地磁盘,则这里显示具体导出到哪个 Compute Node。

如果进行了并发导出,则会返回多行数据。

1. +------------+-----------+----------+--------------------------------------------------------------------+
2. | FileNumber | TotalRows | FileSize | URL                                                                |
3. +------------+-----------+----------+--------------------------------------------------------------------+
4. |          1 |         3 |        7 | file:///192.168.1.10/home/work/path/result_{fragment_instance_id}_ |
5. |          1 |         2 |        4 | file:///192.168.1.11/home/work/path/result_{fragment_instance_id}_ |
6. +------------+-----------+----------+--------------------------------------------------------------------+
7. 2 rows in set (2.218 sec)

如果执行错误,则会返回错误信息,如:

1. mysql> SELECT * FROM tbl INTO OUTFILE ...
2. ERROR 1064 (HY000): errCode = 2, detailMessage = Open broker writer failed ...

注意事项

  • 如果不开启并发导出,查询结果是由单个 BE 节点,单线程导出的。因此导出时间和导出结果集大小正相关。开启并发导出可以降低导出的时间。
  • 导出命令不会检查文件及文件路径是否存在。是否会自动创建路径、或是否会覆盖已存在文件,完全由远端存储系统的语义决定。
  • 如果在导出过程中出现错误,可能会有导出文件残留在远端存储系统上。Doris 不会清理这些文件。需要用户手动清理。
  • 导出命令的超时时间同查询的超时时间。可以通过 SET query_timeout=xxx 进行设置。
  • 对于结果集为空的查询,依然会产生一个文件。
  • 文件切分会保证一行数据完整的存储在单一文件中。因此文件的大小并不严格等于 max_file_size。
  • 对于部分输出为非可见字符的函数,如 BITMAP、HLL 类型,输出为 \N,即 NULL。
  • 目前部分地理信息函数,如 ST_Point 的输出类型为 VARCHAR,但实际输出值为经过编码的二进制字符。当前这些函数会输出乱码。对于地理函数,请使用 ST_AsText 进行输出。

更多帮助

关于 OUTFILE 使用的更多详细语法及最佳实践,请参阅 OUTFILE 命令手册,你也可以在 MySql 客户端命令行下输入 HELP OUTFILE 获取更多帮助信息。