import ChangeLog from ‘../changelog/connector-file-hadoop.md’;

HdfsFile

Hdfs 文件数据源连接器

支持的引擎

Spark
Flink
SeaTunnel Zeta

主要特性

[x] 多模态
使用二进制文件格式读取和写入任何格式的文件，例如视频、图片等。简而言之，任何文件都可以同步到目标位置。
[x] 批处理
[ ] 流处理
[x] 精确一次
在 pollNext 调用中读取分片中的所有数据。读取的分片将保存在快照中。
[x] 列投影
[x] 并行度
[ ] 支持用户定义分片
[x] 支持多表读
[x] 文件格式类型
- [x] text
- [x] csv
- [x] parquet
- [x] orc
- [x] json
- [x] excel
- [x] xml
- [x] binary
- [x] markdown

描述

从 hdfs 文件系统读取数据。

支持的数据源信息

数据源	支持的版本
HdfsFile	hadoop 2.x 和 3.x

数据源选项

名称	类型	是否必须	默认值	描述
path	string	是	-	源文件路径。
file_format_type	string	是	-	我们支持以下文件类型：`text` `csv` `parquet` `orc` `json` `excel` `xml` `binary` `markdown`。请注意，最终文件名将以文件格式的后缀结束，文本文件的后缀是 `txt`。
fs.defaultFS	string	是	-	以 `hdfs://` 开头的 hadoop 集群地址，例如：`hdfs://hadoopcluster`
read_columns	list	否	-	数据源的读取列列表，用户可以使用它来实现字段投影。支持列投影的文件类型如下所示：[text,json,csv,orc,parquet,excel,xml]。提示：如果用户想在读取 `text` `json` `csv` 文件时使用此功能，必须配置 schema 选项。
hdfs_site_path	string	否	-	`hdfs-site.xml` 的路径，用于加载 namenodes 的 ha 配置
delimiter/field_delimiter	string	否	\001	字段分隔符，用于告诉连接器在读取文本文件时如何分割字段。默认 `\001`，与 hive 的默认分隔符相同
row_delimiter	string	否	\n	行分隔符，用于告诉连接器在读取文本文件时如何分割行。默认 `\n`。
parse_partition_from_path	boolean	否	true	控制是否从文件路径解析分区键和值。例如，如果您从路径 `hdfs://hadoop-cluster/tmp/seatunnel/parquet/name=tyrantlucifer/age=26` 读取文件。文件中的每条记录数据都将添加这两个字段：[name:tyrantlucifer,age:26]。提示：不要在 schema 选项中定义分区字段。
date_format	string	否	yyyy-MM-dd	日期类型格式，用于告诉连接器如何将字符串转换为日期，支持以下格式：`yyyy-MM-dd` `yyyy.MM.dd` `yyyy/MM/dd` 默认 `yyyy-MM-dd`。日期类型格式，用于告诉连接器如何将字符串转换为日期，支持以下格式：`yyyy-MM-dd` `yyyy.MM.dd` `yyyy/MM/dd` 默认 `yyyy-MM-dd`
datetime_format	string	否	yyyy-MM-dd HH:mm:ss	日期时间类型格式，用于告诉连接器如何将字符串转换为日期时间，支持以下格式：`yyyy-MM-dd HH:mm:ss` `yyyy.MM.dd HH:mm:ss` `yyyy/MM/dd HH:mm:ss` `yyyyMMddHHmmss`。默认 `yyyy-MM-dd HH:mm:ss`
time_format	string	否	HH:mm:ss	时间类型格式，用于告诉连接器如何将字符串转换为时间，支持以下格式：`HH:mm:ss` `HH:mm:ss.SSS`。默认 `HH:mm:ss`
remote_user	string	否	-	用于连接到 hadoop 登录名的登录用户。它旨在用于 RPC 中的远程用户，不会有任何凭据。
krb5_path	string	否	/etc/krb5.conf	kerberos 的 krb5 路径
kerberos_principal	string	否	-	kerberos 的主体
kerberos_keytab_path	string	否	-	kerberos 的 keytab 路径
skip_header_row_number	long	否	0	跳过前几行，但仅适用于 txt 和 csv。例如，设置如下：`skip_header_row_number = 2`。然后 Seatunnel 将跳过源文件的前 2 行
schema	config	否	-	上游数据的 schema 字段。更多详情请参考 Schema 特性。
sheet_name	string	否	-	读取工作簿的工作表，仅在 file_format 为 excel 时使用。
xml_row_tag	string	否	-	指定 XML 文件中数据行的标签名称，仅在 file_format 为 xml 时使用。
xml_use_attr_format	boolean	否	-	指定是否使用标签属性格式处理数据，仅在 file_format 为 xml 时使用。
csv_use_header_line	boolean	否	false	是否使用标题行解析文件，仅在 file_format 为 `csv` 且文件包含符合 RFC 4180 的标题行时使用
file_filter_pattern	string	否		过滤模式，用于过滤文件。
filename_extension	string	否	-	过滤文件扩展名，用于过滤具有特定扩展名的文件。示例：`csv` `.txt` `json` `.xml`。
compress_codec	string	否	none	文件的压缩编解码器
archive_compress_codec	string	否	none
encoding	string	否	UTF-8
null_format	string	否	-	仅在 file_format_type 为 text 时使用。null_format 定义哪些字符串可以表示为 null。例如：`\N`
binary_chunk_size	int	否	1024	仅在 file_format_type 为 binary 时使用。读取二进制文件的块大小（以字节为单位）。默认为 1024 字节。较大的值可能会提高大文件的性能，但会使用更多内存。
binary_complete_file_mode	boolean	否	false	仅在 file_format_type 为 binary 时使用。是否将完整文件作为单个块读取，而不是分割成块。启用时，整个文件内容将一次性读入内存。默认为 false。
discovery_mode	string	否	once	文件发现模式，支持：`once`（默认）、`continuous`。continuous 模式下将周期性扫描并处理新/变更文件（无界）。当前实现中 continuous 需要配合 `sync_mode=update`（仅 binary）使用，以避免重复传输。
scan_interval	string	否	10S	仅在 `discovery_mode=continuous` 时使用。周期性扫描间隔，推荐使用简写格式 `10S`、`30S`；同时兼容 ISO-8601 格式 `PT10S`、`PT30S`。
start_mode	string	否	earliest	仅在 `discovery_mode=continuous` 时使用，支持：`earliest`（默认）、`latest`。
sync_mode	string	否	full	文件同步模式，支持：`full`（默认）、`update`。当 `update` 时，对源/目标进行对比，只读取新增/变更文件（目前仅支持 `file_format_type=binary`）。
target_path	string	否	-	仅在 `sync_mode=update` 时使用。目标端基础路径（通常应与 sink 的 `path` 一致），用于对比同相对路径文件。
target_hadoop_conf	map	否	-	仅在 `sync_mode=update` 时使用。目标端 Hadoop 配置（可选），可在其中设置 `fs.defaultFS` 覆盖目标 defaultFS。
update_strategy	string	否	distcp	仅在 `sync_mode=update` 时使用。支持：`distcp`（默认）、`strict`。
compare_mode	string	否	len_mtime	仅在 `sync_mode=update` 时使用。支持：`len_mtime`（默认）、`checksum`（仅在 `update_strategy=strict` 时可用）。
common-options		否	-	数据源插件通用参数，请参阅数据源通用选项了解详情。
file_filter_modified_start	string	否	-	按照最后修改时间过滤文件。要过滤的开始时间(包括改时间),时间格式是：`yyyy-MM-dd HH:mm:ss`
file_filter_modified_end	string	否	-	按照最后修改时间过滤文件。要过滤的结束时间(不包括改时间),时间格式是：`yyyy-MM-dd HH:mm:ss`
enable_file_split	boolean	否	false	开启大文件拆分以提升并行度。仅支持 `text`/`csv`/`json`/`parquet` 且非压缩格式（`compress_codec=none` 且 `archive_compress_codec=none`）。
file_split_size	long	否	134217728	`enable_file_split=true` 时生效，单位字节。`text`/`csv`/`json` 按 `file_split_size` 拆分并对齐到下一个 `row_delimiter`；`parquet` 以 RowGroup 为拆分单位，不会切开 RowGroup。
quote_char	string	否	"	用于包裹 CSV 字段的单字符，可保证包含逗号、换行符或引号的字段被正确解析。
escape_char	string	否	-	用于在 CSV 字段内转义引号或其他特殊字符，使其不会结束字段。
metalake_type	string	否	gravitino	Metalake 服务类型，目前支持 `gravitino`。
recursive_file_scan	boolean	否	true	是否递归扫描子目录。如果设置为 `false`，将忽略子目录，仅扫描指定路径下的文件。
sort_files_by_modification_time	boolean	否	false	是否按修改时间降序排序文件。启用此选项后，在读取不断演化的 schema 时可确保 schema 推断使用最新的文件。

file_format_type [string]

文件类型，支持以下文件类型：

text csv parquet orc json excel xml binary markdown

如果您将文件类型指定为 markdown，SeaTunnel 可以解析 markdown 文件并提取结构化数据。 markdown 解析器提取各种元素，包括标题、段落、列表、代码块、表格等。每个元素都转换为具有以下架构的行：

element_id：元素的唯一标识符
element_type：元素类型（Heading、Paragraph、ListItem 等）
heading_level：标题级别（1-6，非标题元素为 null）
text：元素的文本内容
page_number：页码（默认：1）
position_index：文档中的位置索引
parent_id：父元素的 ID
child_ids：子元素 ID 的逗号分隔列表

当 markdown_rag_metadata_enabled 设置为 true 时，SeaTunnel 会在 child_ids 之后追加以下 RAG 元数据字段：

source_uri：源文件路径或 URI
document_id：由 source_uri 派生的稳定文档标识符
chunk_id：由文档标识、chunk 顺序和内容哈希派生的稳定 chunk 标识符
chunk_index：解析后文档中的一基 chunk 顺序
content_hash：已输出 text 值的 SHA-256 哈希

该选项默认值为 false，因此只有显式启用后才会改变原始 Markdown schema。

注意：Markdown 格式仅支持读取，不支持写入。

delimiter/field_delimiter [string]

delimiter 参数将在 2.3.5 版本后弃用，请使用 field_delimiter 代替。

row_delimiter [string]

仅在 file_format 为 text 时需要配置。

行分隔符，用于告诉连接器如何分割行。

默认 \n。

file_filter_pattern [string]

文件过滤模式，用于过滤文件。若只想根据文件名称筛选，则直接写文件名称的正则；若同时想根据文件目录进行过滤，则表达式以path起始。

该模式遵循标准正则表达式。详情请参考正则表达式。以下是一些示例。

若path为/data/seatunnel,且文件结构示例：

/data/seatunnel/20241001/report.txt
/data/seatunnel/20241007/abch202410.csv
/data/seatunnel/20241002/abcg202410.csv
/data/seatunnel/20241005/old_data.csv
/data/seatunnel/20241012/logo.png

匹配规则示例：

示例 1：匹配所有 .txt 文件，正则表达式：

.*.txt

此示例匹配的结果是：

/data/seatunnel/20241001/report.txt

示例 2：匹配所有以 abc 开头的文件，正则表达式：

abc.*

此示例匹配的结果是：

/data/seatunnel/20241007/abch202410.csv
/data/seatunnel/20241002/abcg202410.csv

示例 3：匹配20241007文件夹下所有以 abc 开头的文件，且第四个字符为 h 或 g，正则表达式：

/data/seatunnel/20241007/abc[h,g].*

此示例匹配的结果是：

/data/seatunnel/20241007/abch202410.csv

示例 4：匹配以 202410 开头的第三级文件夹和以 .csv 结尾的文件，正则表达式：

/data/seatunnel/202410\d*/.*.csv

此示例匹配的结果是：

/data/seatunnel/20241007/abch202410.csv
/data/seatunnel/20241002/abcg202410.csv
/data/seatunnel/20241005/old_data.csv

compress_codec [string]

文件的压缩编解码器及其支持的详细信息如下所示：

txt: lzo none
json: lzo none
csv: lzo none
orc/parquet: 自动识别压缩类型，无需额外设置。

archive_compress_codec [string]

归档文件的压缩编解码器及其支持的详细信息如下所示：

archive_compress_codec	file_format	archive_compress_suffix
ZIP	txt,json,excel,xml	.zip
TAR	txt,json,excel,xml	.tar
TAR_GZ	txt,json,excel,xml	.tar.gz
GZ	txt,json,excel,xml	.gz
NONE	all	.*

注意：gz 压缩的 excel 文件需要压缩原始文件或指定文件后缀，例如 e2e.xls ->e2e_test.xls.gz

encoding [string]

仅在 file_format_type 为 json,text,csv,xml 时使用。要读取的文件的编码。此参数将由 Charset.forName(encoding) 解析。

binary_chunk_size [int]

仅在 file_format_type 为 binary 时使用。

读取二进制文件的块大小（以字节为单位）。默认为 1024 字节。较大的值可能会提高大文件的性能，但会使用更多内存。

binary_complete_file_mode [boolean]

仅在 file_format_type 为 binary 时使用。

是否将完整文件作为单个块读取，而不是分割成块。启用时，整个文件内容将一次性读入内存。默认为 false。

discovery_mode [string]

文件发现模式，支持：once（默认）、continuous。

once：启动时枚举一次文件并结束（有界）。
continuous：作业保持运行，周期性扫描路径并在运行时处理新增/变更文件（无界）。

当前实现中，discovery_mode=continuous 需要配合 sync_mode=update（仅 binary）使用，以避免重复传输。

scan_interval [string]

仅在 discovery_mode=continuous 时使用。周期性扫描间隔，取值必须大于 0。推荐使用简写格式 10S、30S（大小写不敏感，例如 10s）；同时兼容 ISO-8601 格式 PT10S、PT30S。默认 10S。

start_mode [string]

仅在 discovery_mode=continuous 时使用，支持：earliest（默认）、latest。

earliest：启动时读取已有文件。
latest：仅处理作业启动后修改的新文件。

sync_mode [string]

文件同步模式，支持：full（默认）update。

当 sync_mode=update 时，会在读取端对源/目标进行对比，只读取新增/变更文件（目前仅支持 file_format_type=binary）。

target_path [string]

仅在 sync_mode=update 时使用。

目标端基础路径（通常应与 sink 的 path 保持一致），用于对比同相对路径的目标文件是否存在/是否需要更新。

target_hadoop_conf [map]

仅在 sync_mode=update 时使用。

用于访问目标文件系统的 Hadoop 配置（可选）。当不配置时默认复用 source 端的文件系统配置。

可在该 map 中指定 fs.defaultFS 来覆盖目标端 defaultFS，例如："fs.defaultFS" = "hdfs://nn2:9000"。

update_strategy [string]

仅在 sync_mode=update 时使用。支持：distcp（默认）strict。

distcp：更接近 distcp -update 的语义：
- 目标文件不存在 → COPY
- 长度不同 → COPY
- mtime(source) > mtime(target) → COPY
- 否则 → SKIP
strict：严格一致性，配合 compare_mode 判断是否 SKIP。

compare_mode [string]

仅在 sync_mode=update 时使用。支持：len_mtime（默认）checksum。

len_mtime：len 与 mtime 都相同才 SKIP，否则 COPY。
checksum：要求 len 相同且 Hadoop getFileChecksum 相同才 SKIP，否则 COPY（仅在 update_strategy=strict 时生效）。

enable_file_split [boolean]

开启大文件拆分功能，默认 false。仅支持 csv/text/json/parquet 且非压缩格式（compress_codec=none 且 archive_compress_codec=none）。

text/csv/json：按 file_split_size 拆分并对齐到下一个 row_delimiter，避免切开一行/一条记录。
parquet：以 RowGroup 为逻辑拆分单位，不会切开 RowGroup。

使用建议

适合：读取少量大文件，并希望通过更高并行度提升吞吐。
不建议：读取大量小文件，或并行度较低的场景（拆分会带来额外的枚举/调度开销）。

限制说明

不支持压缩文件（compress_codec != none）或归档文件（archive_compress_codec != none），会自动回退为不拆分。
对于 text/csv/json，实际 split 的大小可能略大于 file_split_size（因为需要对齐到下一个 row_delimiter）。

file_split_size [long]

enable_file_split=true 时生效，单位字节。默认 128MB（134217728）。

调优建议

建议从默认值（128MB）开始：如果并行度未充分利用可适当调小；如果 split 数量过多可适当调大。
经验公式：file_split_size ≈ file_size / 期望并行度。

quote_char [string]

用于包裹 CSV 字段的单字符，可保证包含逗号、换行符或引号的字段被正确解析。

escape_char [string]

用于在 CSV 字段内转义引号或其他特殊字符，使其不会结束字段。

sort_files_by_modification_time [boolean]

是否按修改时间降序排序文件。默认值为 false。

启用后，文件将按修改时间排序（最新的在前）。适用于以下场景：

读取具有不断演化的 schema 的文件，且希望 schema 推断使用最新的文件
需要按时间顺序处理文件

schema [config]

仅在文件格式类型为 text、json、excel、xml 或 csv（或其他无法从元数据中读取 schema 的格式）时需要配置。

上游数据的 schema 信息。更多详情请参考 Schema 特性。

metadata_table_id [string]

元数据服务中的表标识符，用于获取表结构。对于 Gravitino，格式应为 {catalog}.{database}.{table}，例如 mysql-catalog.test_db.users。

当指定此参数时，连接器将从外部元数据服务获取表结构，而不是使用手动定义的 columns。

当使用 Gravitino 作为元数据源时，Gravitino 的列类型会自动转换为 SeaTunnel 数据类型。详细的类型映射信息请参考 Gravitino 类型映射。

更多信息请参考元数据 SPI。

recursive_file_scan [boolean]

是否递归扫描子目录。如果设置为 false，将忽略子目录，仅扫描指定路径下的文件。

提示

如果您使用 spark/flink，为了使用此连接器，您必须确保您的 spark/flink 集群已经集成了 hadoop。测试过的 hadoop 版本是 2.x。如果您使用 SeaTunnel Engine，则在下载和安装 SeaTunnel Engine 时会自动集成 hadoop jar。您可以检查 ${SEATUNNEL_HOME}/lib 下的 jar 包来确认这一点。

任务示例

简单示例

此示例定义了一个 SeaTunnel 同步任务，从 Hdfs 读取数据并将其发送到 Hdfs。

# 定义运行时环境
env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  HdfsFile {
  schema {
    fields {
      name = string
      age = int
    }
  }
  path = "/apps/hive/demo/student"
  file_format_type = "json"
  fs.defaultFS = "hdfs://namenode001"
  }
  # 如果您想获取有关如何配置 seatunnel 的更多信息和查看完整的数据源插件列表，
  # 请访问 https://seatunnel.apache.org/docs/connectors/source
}

transform {
  # 如果您想获取有关如何配置 seatunnel 的更多信息和查看完整的转换插件列表，
    # 请访问 https://seatunnel.apache.org/docs/transforms
}

sink {
    HdfsFile {
      fs.defaultFS = "hdfs://hadoopcluster"
      path = "/tmp/hive/warehouse/test2"
      file_format_type = "orc"
    }
  # 如果您想获取有关如何配置 seatunnel 的更多信息和查看完整的接收器插件列表，
  # 请访问 https://seatunnel.apache.org/docs/connectors/sink
}

增量同步（sync_mode=update，仅 binary）

sync_mode=update 会对比 source 与 target_path，仅读取新增/变更文件（目前仅支持 file_format_type=binary）。多数情况下，target_path 需要与 sink 的 path 对齐（同一文件系统、相同相对路径）。

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  HdfsFile {
    path = "/seatunnel/update/src/"
    file_format_type = "binary"
    fs.defaultFS = "hdfs://namenode001"

    sync_mode = "update"
    target_path = "/seatunnel/update/dst/"
    update_strategy = "distcp"
    compare_mode = "len_mtime"
  }
}

sink {
  HdfsFile {
    fs.defaultFS = "hdfs://namenode001"
    path = "/seatunnel/update/dst/"
    tmp_path = "/seatunnel/update/tmp/"
    file_format_type = "binary"
  }
}

持续发现（discovery_mode=continuous）

discovery_mode=continuous 会让作业保持运行，并按间隔持续扫描路径发现新/变更文件（长跑作业，推荐使用 job.mode="STREAMING"）。

注意： discovery_mode=continuous 当前需要配合 sync_mode="update"（仅支持 binary）使用，以避免重复传输而不引入无限增长的“已处理状态”。同时 target_path 通常应与 sink 的 path 保持一致（同一文件系统、相同相对路径）。

env {
  parallelism = 1
  job.mode = "STREAMING"
}

source {
  HdfsFile {
    path = "/seatunnel/watch/src/"
    file_format_type = "binary"
    fs.defaultFS = "hdfs://namenode001"

    discovery_mode = "continuous"
    scan_interval = "10S"
    start_mode = "latest"

    sync_mode = "update"
    target_path = "/seatunnel/watch/dst/"
    update_strategy = "distcp"
    compare_mode = "len_mtime"
  }
}

sink {
  HdfsFile {
    fs.defaultFS = "hdfs://namenode001"
    path = "/seatunnel/watch/dst/"
    tmp_path = "/seatunnel/watch/tmp/"
    file_format_type = "binary"
  }
}

过滤文件

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  HdfsFile {
    path = "/apps/hive/demo/student"
    file_format_type = "json"
    fs.defaultFS = "hdfs://namenode001"
    // 文件示例 abcD2024.csv
    file_filter_pattern = "abc[DX]*.*"
  }
}

sink {
  Console {
  }
}

多表配置

env {
  parallelism = 1
  job.mode = "BATCH"
}

source {
  HdfsFile {
    tables_configs = [
      {
        schema = {
          table = "student"
        }
        path = "/apps/hive/demo/student"
        file_format_type = "json"
        fs.defaultFS = "hdfs://namenode001"
      },
      {
        schema = {
          table = "teacher"
        }
        path = "/apps/hive/demo/teacher"
        file_format_type = "json"
        fs.defaultFS = "hdfs://namenode001"
      }
    ]
  }
}

sink {
    HdfsFile {
      fs.defaultFS = "hdfs://hadoopcluster"
      path = "/tmp/hive/warehouse/${table_name}"
      file_format_type = "orc"
    }
}

HdfsFile

支持的引擎

主要特性

描述

支持的数据源信息

数据源选项

file_format_type [string]

delimiter/field_delimiter [string]

row_delimiter [string]

file_filter_pattern [string]

compress_codec [string]

archive_compress_codec [string]

encoding [string]

binary_chunk_size [int]

binary_complete_file_mode [boolean]

discovery_mode [string]

scan_interval [string]

start_mode [string]

sync_mode [string]

target_path [string]

target_hadoop_conf [map]

update_strategy [string]

compare_mode [string]

enable_file_split [boolean]

file_split_size [long]

quote_char [string]

escape_char [string]

sort_files_by_modification_time [boolean]

schema [config]

metadata_table_id [string]

recursive_file_scan [boolean]

提示

任务示例

简单示例

增量同步（sync_mode=update，仅 binary）

持续发现（discovery_mode=continuous）

过滤文件

多表配置

变更日志