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

file 表函数

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

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

语法​

参数​

参数描述
path从 user_files_path 的相对路径。支持只读模式下的以下 通配符：*、?、{abc,def}（'abc' 和 'def' 是字符串）和 {N..M}（N 和 M 是数字）。
path_to_archivezip/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 风格分区创建的虚拟列

设置​

设置描述
engine_file_empty_if_not_exists允许从不存在的文件中选择空数据。默认情况下禁用。
engine_file_truncate_on_insert允许在插入之前截断文件。默认情况下禁用。
engine_file_allow_create_multiple_files如果格式有后缀，允许在每次插入时创建新文件。默认情况下禁用。
engine_file_skip_empty_files允许在读取时跳过空文件。默认情况下禁用。
storage_file_read_method从存储文件读取数据的方法，选项包括：read、pread、mmap（仅适用于 clickhouse-local）。默认值：pread 对于 clickhouse-server，mmap 对于 clickhouse-local。