跳到主要内容
跳到主要内容

file 表函数

一个提供类似表的接口以从文件中 SELECT 和插入数据的表引擎，类似于 s3 表函数。使用 file() 处理本地文件，使用 s3() 处理对象存储中的桶，例如 S3、GCS 或 MinIO。

file 函数可以用于 SELECT 和 INSERT 查询，以读取或写入文件。

语法

参数

  • path — 从 user_files_path 的相对路径。支持只读模式下的以下 通配符：*、?、{abc,def}（其中 'abc' 和 'def' 是字符串）和 {N..M}（其中 N 和 M 是数字）。
  • path_to_archive - 相对路径到一个 zip/tar/7z 压缩包。支持与 path 相同的通配符。
  • format — 文件的 格式。
  • structure — 表结构。格式：'column1_name column1_type, column2_name column2_type, ...'。
  • compression — 在 SELECT 查询中使用时的现有压缩类型，或在 INSERT 查询中使用时的所需压缩类型。支持的压缩类型有 gz、br、xz、zst、lz4 和 bz2。

返回值

一个用于从文件中读取或写入数据的表。

写入文件的示例​

写入 TSV 文件​

结果是数据写入文件 test.tsv：

分区写入多个 TSV 文件​

如果在将数据插入类型为 file() 的表函数时指定了 PARTITION BY 表达式，则将为每个分区创建一个单独的文件。将数据分成独立文件有助于提高读取操作的性能。

结果是数据写入三个文件：test_1.tsv、test_2.tsv 和 test_3.tsv。

从文件读取的示例​

从 CSV 文件 SELECT​

首先，在服务器配置中设置 user_files_path 并准备文件 test.csv：

然后，从 test.csv 读取数据到表并选择其前两行：

从文件插入数据到表​

从 archive1.zip 或/和 archive2.zip 中读取 table.csv 的数据：

路径中的通配符​

路径可以使用通配符。文件必须匹配整个路径模式，而不仅仅是后缀或前缀。有一个例外是，如果路径指向一个现有目录且不使用通配符，则会隐式添加一个 *，以便选择目录中的所有文件。

  • * — 表示任意多个字符（不包括 /）但包括空字符串。
  • ? — 表示任意单个字符。
  • {some_string,another_string,yet_another_one} — 替换任意字符串 'some_string', 'another_string', 'yet_another_one'。字符串可以包含 / 符号。
  • {N..M} — 表示任何数字 >= N 和 <= M。
  • ** - 表示递归表示文件夹中的所有文件。

具有 {} 的构造类似于 remote 和 hdfs 表函数。

示例

假设有以下相对路径的文件：

  • some_dir/some_file_1
  • some_dir/some_file_2
  • some_dir/some_file_3
  • another_dir/some_file_1
  • another_dir/some_file_2
  • another_dir/some_file_3

查询所有文件的总行数：

达到相同效果的替代路径表达式：

使用隐式 * 查询 some_dir 中的总行数：

备注

如果文件列表包含前导零的数字范围，使用大括号构造每个数字单独或者使用 ?。

示例

查询名为 file000、file001、...、file999 的文件的总行数：

示例

递归查询目录 big_dir/ 中所有文件的总行数：

示例

递归查询 big_dir/ 中任意文件夹下所有名为 file002 的文件的总行数：

虚拟列​

  • _path — 文件路径。类型：LowCardinality(String)。
  • _file — 文件名。类型：LowCardinality(String)。
  • _size — 文件大小（字节）。类型：Nullable(UInt64)。如果文件大小未知，则值为 NULL。
  • _time — 文件的最后修改时间。类型：Nullable(DateTime)。如果时间未知，则值为 NULL。

Hive 风格的分区​

当设置 use_hive_partitioning 为 1 时，ClickHouse 将检测路径中的 Hive 风格分区 (/name=value/)，并允许在查询中使用分区列作为虚拟列。这些虚拟列将拥有与分区路径相同的名称，但以 _ 开头。

示例

使用使用 Hive 风格分区创建的虚拟列

设置​

另见