HDFS

Name

SinceVersion 1.2

hdfs

Description

HDFS表函数(table-valued-function,tvf),可以让用户像访问关系表格式数据一样,读取并访问 HDFS 上的文件内容。目前支持csv/csv_with_names/csv_with_names_and_types/json/parquet/orc文件格式。

syntax

  1. hdfs(
  2. "uri" = "..",
  3. "fs.defaultFS" = "...",
  4. "hadoop.username" = "...",
  5. "format" = "csv",
  6. "keyn" = "valuen"
  7. ...
  8. );

参数说明

访问hdfs相关参数:

  • uri:(必填) 访问hdfs的uri。如果uri路径不存在或文件都是空文件,hdfs tvf将返回空集合。
  • fs.defaultFS:(必填)
  • hadoop.username: (必填)可以是任意字符串,但不能为空
  • hadoop.security.authentication:(选填)
  • hadoop.username:(选填)
  • hadoop.kerberos.principal:(选填)
  • hadoop.kerberos.keytab:(选填)
  • dfs.client.read.shortcircuit:(选填)
  • dfs.domain.socket.path:(选填)

访问 HA 模式 HDFS 相关参数:

  • dfs.nameservices:(选填)
  • dfs.ha.namenodes.your-nameservices:(选填)
  • dfs.namenode.rpc-address.your-nameservices.your-namenode:(选填)
  • dfs.client.failover.proxy.provider.your-nameservices:(选填)

文件格式相关参数

  • format:(必填) 目前支持 csv/csv_with_names/csv_with_names_and_types/json/parquet/orc/avro

  • column_separator:(选填) 列分割符, 默认为,

  • line_delimiter:(选填) 行分割符,默认为\n

  • compress_type: (选填) 目前支持 UNKNOWN/PLAIN/GZ/LZO/BZ2/LZ4FRAME/DEFLATE。 默认值为 UNKNOWN, 将会根据 uri 的后缀自动推断类型。

    下面6个参数是用于json格式的导入,具体使用方法可以参照:Json Load

  • read_json_by_line: (选填) 默认为 "true"

  • strip_outer_array: (选填) 默认为 "false"

  • json_root: (选填) 默认为空

  • json_paths: (选填) 默认为空

  • num_as_string: (选填) 默认为 false

  • fuzzy_parse: (选填) 默认为 false

    SinceVersion dev下面2个参数是用于csv格式的导入

  • trim_double_quotes: 布尔类型,选填,默认值为 false,为 true 时表示裁剪掉 csv 文件每个字段最外层的双引号

  • skip_lines: 整数类型,选填,默认值为0,含义为跳过csv文件的前几行。当设置format设置为 csv_with_namescsv_with_names_and_types 时,该参数会失效

其他参数:

  • path_partition_keys:(选填)指定文件路径中携带的分区列名,例如/path/to/city=beijing/date=”2023-07-09”, 则填写path_partition_keys="city,date",将会自动从路径中读取相应列名和列值进行导入。

Examples

读取并访问 HDFS 存储上的csv格式文件

  1. MySQL [(none)]> select * from hdfs(
  2. "uri" = "hdfs://127.0.0.1:842/user/doris/csv_format_test/student.csv",
  3. "fs.defaultFS" = "hdfs://127.0.0.1:8424",
  4. "hadoop.username" = "doris",
  5. "format" = "csv");
  6. +------+---------+------+
  7. | c1 | c2 | c3 |
  8. +------+---------+------+
  9. | 1 | alice | 18 |
  10. | 2 | bob | 20 |
  11. | 3 | jack | 24 |
  12. | 4 | jackson | 19 |
  13. | 5 | liming | 18 |
  14. +------+---------+------+

读取并访问 HA 模式的 HDFS 存储上的csv格式文件

  1. MySQL [(none)]> select * from hdfs(
  2. "uri" = "hdfs://127.0.0.1:842/user/doris/csv_format_test/student.csv",
  3. "fs.defaultFS" = "hdfs://127.0.0.1:8424",
  4. "hadoop.username" = "doris",
  5. "format" = "csv",
  6. "dfs.nameservices" = "my_hdfs",
  7. "dfs.ha.namenodes.my_hdfs" = "nn1,nn2",
  8. "dfs.namenode.rpc-address.my_hdfs.nn1" = "nanmenode01:8020",
  9. "dfs.namenode.rpc-address.my_hdfs.nn2" = "nanmenode02:8020",
  10. "dfs.client.failover.proxy.provider.my_hdfs" = "org.apache.hadoop.hdfs.server.namenode.ha.ConfiguredFailoverProxyProvider");
  11. +------+---------+------+
  12. | c1 | c2 | c3 |
  13. +------+---------+------+
  14. | 1 | alice | 18 |
  15. | 2 | bob | 20 |
  16. | 3 | jack | 24 |
  17. | 4 | jackson | 19 |
  18. | 5 | liming | 18 |
  19. +------+---------+------+

可以配合desc function使用

  1. MySQL [(none)]> desc function hdfs(
  2. "uri" = "hdfs://127.0.0.1:8424/user/doris/csv_format_test/student_with_names.csv",
  3. "fs.defaultFS" = "hdfs://127.0.0.1:8424",
  4. "hadoop.username" = "doris",
  5. "format" = "csv_with_names");

Keywords

  1. hdfs, table-valued-function, tvf

Best Practice

关于HDFS tvf的更详细使用方法可以参照 S3 tvf, 唯一不同的是访问存储系统的方式不一样。