提供对存储在 Amazon S3、Azure、HDFS 或本地的 Apache Iceberg 表进行只读的表格接口。
icebergS3(url [, NOSIGN | access_key_id, secret_access_key, [session_token]] [,format] [,compression_method])
icebergS3(named_collection[, option=value [,..]])
icebergAzure(connection_string|storage_account_url, container_name, blobpath, [,account_name], [,account_key] [,format] [,compression_method])
icebergAzure(named_collection[, option=value [,..]])
icebergHDFS(path_to_table, [,format] [,compression_method])
icebergHDFS(named_collection[, option=value [,..]])
icebergLocal(path_to_table, [,format] [,compression_method])
icebergLocal(named_collection[, option=value [,..]])
参数描述与表函数 s3、azureBlobStorage、HDFS 和 file 中的参数描述一致。
format 代表 Iceberg 表中数据文件的格式。
返回值
具有指定结构的表，用于读取指定 Iceberg 表中的数据。
SELECT * FROM icebergS3('http://test.s3.amazonaws.com/clickhouse-bucket/test_table', 'test', 'test')
信息
ClickHouse 当前支持通过 icebergS3、icebergAzure、icebergHDFS 和 icebergLocal 表函数以及 IcebergS3、icebergAzure、IcebergHDFS 和 IcebergLocal 表引擎读取 Iceberg 格式的 v1 和 v2。
定义命名集合
以下是配置一个命名集合以存储 URL 和凭证的示例：
<clickhouse>
<named_collections>
<iceberg_conf>
<url>http://test.s3.amazonaws.com/clickhouse-bucket/</url>
<access_key_id>test<access_key_id>
<secret_access_key>test</secret_access_key>
<format>auto</format>
<structure>auto</structure>
</iceberg_conf>
</named_collections>
</clickhouse>
SELECT * FROM icebergS3(iceberg_conf, filename = 'test_table')
DESCRIBE icebergS3(iceberg_conf, filename = 'test_table')
模式演进
目前，借助 CH，您可以读取模式随时间变化的 iceberg 表。我们当前支持读取添加和移除列的表，并支持列顺序的更改。您还可以将一个需要值的列更改为允许 NULL 的列。此外，我们支持简单类型的允许类型转换，例如：
- int -> long
- float -> double
- decimal(P, S) -> decimal(P', S)，其中 P' > P。
目前，不支持更改嵌套结构或数组和映射中元素的类型。
分区剪枝
ClickHouse 在针对 Iceberg 表的 SELECT 查询期间支持分区剪枝，这有助于通过跳过不相关的数据文件来优化查询性能。要启用分区剪枝，请设置 use_iceberg_partition_pruning = 1。有关 iceberg 分区剪枝的更多信息，请访问 https://iceberg.apache.org/spec/#partitioning
时间旅行
ClickHouse 支持 Iceberg 表的时间旅行，允许您使用特定的时间戳或快照 ID 查询历史数据。
处理删除行的表
目前，仅支持具有 位置删除 的 Iceberg 表。
以下删除方法 不支持：
基本用法
SELECT * FROM example_table ORDER BY 1
SETTINGS iceberg_timestamp_ms = 1714636800000
SELECT * FROM example_table ORDER BY 1
SETTINGS iceberg_snapshot_id = 3547395809148285433
注意：您不能在同一查询中同时指定 iceberg_timestamp_ms 和 iceberg_snapshot_id 参数。
重要考虑事项
示例场景
所有场景均在 Spark 中编写，因为 CH 尚不支持写入 Iceberg 表。
场景 1：没有新快照的模式更改
考虑以下操作序列：
-- Create a table with two columns
CREATE TABLE IF NOT EXISTS spark_catalog.db.time_travel_example (
order_number bigint,
product_code string
)
USING iceberg
OPTIONS ('format-version'='2')
- - Insert data into the table
INSERT INTO spark_catalog.db.time_travel_example VALUES
(1, 'Mars')
ts1 = now() // A piece of pseudo code
- - Alter table to add a new column
ALTER TABLE spark_catalog.db.time_travel_example ADD COLUMN (price double)
ts2 = now()
- - Insert data into the table
INSERT INTO spark_catalog.db.time_travel_example VALUES (2, 'Venus', 100)
ts3 = now()
- - Query the table at each timestamp
SELECT * FROM spark_catalog.db.time_travel_example TIMESTAMP AS OF ts1;
+------------+------------+
|order_number|product_code|
+------------+------------+
| 1| Mars|
+------------+------------+
SELECT * FROM spark_catalog.db.time_travel_example TIMESTAMP AS OF ts2;
+------------+------------+
|order_number|product_code|
+------------+------------+
| 1| Mars|
+------------+------------+
SELECT * FROM spark_catalog.db.time_travel_example TIMESTAMP AS OF ts3;
+------------+------------+-----+
|order_number|product_code|price|
+------------+------------+-----+
| 1| Mars| NULL|
| 2| Venus|100.0|
+------------+------------+-----+
在不同时间戳的查询结果：
- 在 ts1 和 ts2：仅显示原始的两列
- 在 ts3：所有三列均显示，第一行的价格为 NULL
场景 2：历史与当前模式差异
当前时刻的时间旅行查询可能显示与当前表不同的模式：
-- Create a table
CREATE TABLE IF NOT EXISTS spark_catalog.db.time_travel_example_2 (
order_number bigint,
product_code string
)
USING iceberg
OPTIONS ('format-version'='2')
-- Insert initial data into the table
INSERT INTO spark_catalog.db.time_travel_example_2 VALUES (2, 'Venus');
-- Alter table to add a new column
ALTER TABLE spark_catalog.db.time_travel_example_2 ADD COLUMN (price double);
ts = now();
-- Query the table at a current moment but using timestamp syntax
SELECT * FROM spark_catalog.db.time_travel_example_2 TIMESTAMP AS OF ts;
+------------+------------+
|order_number|product_code|
+------------+------------+
| 2| Venus|
+------------+------------+
-- Query the table at a current moment
SELECT * FROM spark_catalog.db.time_travel_example_2;
+------------+------------+-----+
|order_number|product_code|price|
+------------+------------+-----+
| 2| Venus| NULL|
+------------+------------+-----+
这是因为 ALTER TABLE 不会创建新快照，而对于当前表，Spark 从最新的元数据文件获取 schema_id 的值，而不是快照。
场景 3：历史与当前模式差异
第二个情况是，在进行时间旅行时无法获取写入任何数据之前的表状态：
-- Create a table
CREATE TABLE IF NOT EXISTS spark_catalog.db.time_travel_example_3 (
order_number bigint,
product_code string
)
USING iceberg
OPTIONS ('format-version'='2');
ts = now();
-- Query the table at a specific timestamp
SELECT * FROM spark_catalog.db.time_travel_example_3 TIMESTAMP AS OF ts; -- Finises with error: Cannot find a snapshot older than ts.
在 Clickhouse 中，其行为与 Spark 一致。您可以将 Spark 的 Select 查询心里替换为 Clickhouse 的 Select 查询，它的工作方式是一样的。
在 ClickHouse 中使用 iceberg 表函数时，系统需要定位描述 Iceberg 表结构的正确 metadata.json 文件。以下是该解析过程的工作原理：
候选搜索（按优先顺序）
- 直接路径指定：
- 如果您设置了
iceberg_metadata_file_path，系统将使用该确切路径并与 Iceberg 表目录路径组合。
- 当提供此设置时，将忽略所有其他解析设置。
- 表 UUID 匹配：
- 如果指定了
iceberg_metadata_table_uuid，系统将：
- 仅查看
metadata 目录中的 .metadata.json 文件
- 筛选包含与您指定的 UUID（不区分大小写）匹配的
table-uuid 字段的文件
- 默认搜索：
- 如果未提供上述任何一个设置，
metadata 目录中的所有 .metadata.json 文件将成为候选文件
选择最新文件
在使用上述规则识别候选文件后，系统确定哪个是最新的：
-
如果启用 iceberg_recent_metadata_file_by_last_updated_ms_field：
-
将选择 last-updated-ms 值最大的文件
-
否则：
-
将选择版本号最高的文件
-
（版本在格式为 V.metadata.json 或 V-uuid.metadata.json 的文件名中显示为 V）
注意：所有提到的设置都是表函数设置（不是全局或查询级别的设置），必须按下面所示指定：
SELECT * FROM iceberg('s3://bucket/path/to/iceberg_table',
SETTINGS iceberg_metadata_table_uuid = 'a90eed4c-f74b-4e5b-b630-096fb9d09021');
注意：虽然 Iceberg Catalogs 通常处理元数据解析，但 ClickHouse 中的 iceberg 表函数直接将存储在 S3 中的文件解释为 Iceberg 表，这就是理解这些解析规则的重要原因。
Iceberg 表引擎和表函数支持元数据缓存，存储清单文件、清单列表和元数据 json 的信息。缓存存储在内存中。此功能由设置 use_iceberg_metadata_files_cache 控制，默认启用。
表函数 iceberg 现在是 icebergS3 的别名。
虚拟列
_path — 文件路径。类型：LowCardinality(String)。_file — 文件名称。类型：LowCardinality(String)。_size — 文件大小（以字节为单位）。类型：Nullable(UInt64)。如果文件大小未知，则值为 NULL。_time — 文件最后修改时间。类型：Nullable(DateTime)。如果时间未知，则值为 NULL。_etag — 文件的 etag。类型：LowCardinality(String)。如果 etag 未知，则值为 NULL。
写入 iceberg 表
从版本 25.7 开始，ClickHouse 支持对用户的 Iceberg 表进行修改。
目前这是一个实验性功能，因此您首先需要启用它：
SET allow_experimental_insert_into_iceberg = 1;
创建表
要创建您自己的空 Iceberg 表，请使用与读取相同的命令，但显式指定模式。
写入支持来自 iceberg 规范的所有数据格式，如 Parquet、Avro、ORC。
CREATE TABLE iceberg_writes_example
(
x Nullable(String),
y Nullable(Int32)
)
ENGINE = IcebergLocal('/home/scanhex12/iceberg_example/')
注意：要创建版本提示文件，请启用 iceberg_use_version_hint 设置。
如果您想压缩 metadata.json 文件，请在 iceberg_metadata_compression_method 设置中指定编解码器名称。
INSERT
创建新表后，您可以使用普通的 ClickHouse 语法插入数据。
INSERT INTO iceberg_writes_example VALUES ('Pavel', 777), ('Ivanov', 993);
SELECT *
FROM iceberg_writes_example
FORMAT VERTICAL;
Row 1:
──────
x: Pavel
y: 777
Row 2:
──────
x: Ivanov
y: 993
DELETE
在 ClickHouse 中，也支持在适合读取合并的格式中删除额外行。
此查询将创建一个包含位置删除文件的新快照。
注意：如果您希望将来用其他 Iceberg 引擎（如 Spark）读取您的表，您需要禁用设置 output_format_parquet_use_custom_encoder 和 output_format_parquet_parallel_encoding。
这是因为 Spark 通过 parquet 字段 ID 读取这些文件，而 ClickHouse 在启用这些标志时目前不支持写入字段 ID。
我们计划在未来修复这种行为。
ALTER TABLE iceberg_writes_example DELETE WHERE x != 'Ivanov';
SELECT *
FROM iceberg_writes_example
FORMAT VERTICAL;
Row 1:
──────
x: Ivanov
y: 993
模式演进
ClickHouse 允许您添加、删除或修改简单类型（非元组、非数组、非映射）的列。
ALTER TABLE iceberg_writes_example MODIFY COLUMN y Nullable(Int64);
SHOW CREATE TABLE iceberg_writes_example;
┌─statement─────────────────────────────────────────────────┐
1. │ CREATE TABLE default.iceberg_writes_example ↴│
│↳( ↴│
│↳ `x` Nullable(String), ↴│
│↳ `y` Nullable(Int64) ↴│
│↳) ↴│
│↳ENGINE = IcebergLocal('/home/scanhex12/iceberg_example/') │
└───────────────────────────────────────────────────────────┘
ALTER TABLE iceberg_writes_example ADD COLUMN z Nullable(Int32);
SHOW CREATE TABLE iceberg_writes_example;
┌─statement─────────────────────────────────────────────────┐
1. │ CREATE TABLE default.iceberg_writes_example ↴│
│↳( ↴│
│↳ `x` Nullable(String), ↴│
│↳ `y` Nullable(Int64), ↴│
│↳ `z` Nullable(Int32) ↴│
│↳) ↴│
│↳ENGINE = IcebergLocal('/home/scanhex12/iceberg_example/') │
└───────────────────────────────────────────────────────────┘
SELECT *
FROM iceberg_writes_example
FORMAT VERTICAL;
Row 1:
──────
x: Ivanov
y: 993
z: ᴺᵁᴸᴸ
ALTER TABLE iceberg_writes_example DROP COLUMN z;
SHOW CREATE TABLE iceberg_writes_example;
┌─statement─────────────────────────────────────────────────┐
1. │ CREATE TABLE default.iceberg_writes_example ↴│
│↳( ↴│
│↳ `x` Nullable(String), ↴│
│↳ `y` Nullable(Int64) ↴│
│↳) ↴│
│↳ENGINE = IcebergLocal('/home/scanhex12/iceberg_example/') │
└───────────────────────────────────────────────────────────┘
SELECT *
FROM iceberg_writes_example
FORMAT VERTICAL;
Row 1:
──────
x: Ivanov
y: 993
ClickHouse 支持 Iceberg 表的压缩。当前，它可以在更新元数据时将位置删除文件合并为数据文件。之前的快照 ID 和时间戳保持不变，因此时间旅行功能仍然可以使用相同的值。
如何使用它：
SET allow_experimental_iceberg_compaction = 1
OPTIMIZE TABLE iceberg_writes_example;
SELECT *
FROM iceberg_writes_example
FORMAT VERTICAL;
Row 1:
──────
x: Ivanov
y: 993
带有目录的表
上述所有写入功能也可与 REST 和 Glue 目录一起使用。
要使用它们，请创建一个具有 IcebergS3 引擎的表，并提供必要的设置：
CREATE TABLE `database_name.table_name` ENGINE = IcebergS3('http://minio:9000/warehouse-rest/table_name/', 'minio_access_key', 'minio_secret_key')
SETTINGS storage_catalog_type="rest", storage_warehouse="demo", object_storage_endpoint="http://minio:9000/warehouse-rest", storage_region="us-east-1", storage_catalog_url="http://rest:8181/v1",
另请参见
