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

集成 Apache Beam 和 ClickHouse

ClickHouse Supported

Apache Beam 是一个开源的统一编程模型，使开发人员能够定义和执行批处理和流（连续）数据处理管道。Apache Beam 的灵活性体现在其能够支持多种数据处理场景，从 ETL（提取、转换、加载）操作到复杂事件处理和实时分析。本集成利用了 ClickHouse 的官方 JDBC 连接器 作为底层插入层。

集成包​

集成 Apache Beam 和 ClickHouse 所需的集成包在 Apache Beam I/O 连接器 下维护和开发，这是一个包含许多流行数据存储系统和数据库的集成包。org.apache.beam.sdk.io.clickhouse.ClickHouseIO 实现在 Apache Beam 仓库 中。

Apache Beam ClickHouse 包的设置​

包安装​

将以下依赖项添加到您的包管理框架中：

<dependency>
    <groupId>org.apache.beam</groupId>
    <artifactId>beam-sdks-java-io-clickhouse</artifactId>
    <version>${beam.version}</version>
</dependency>
推荐的 Beam 版本

建议从 Apache Beam 版本 2.59.0 开始使用 ClickHouseIO 连接器。早期版本可能无法完全支持连接器的功能。

您可以在 官方 maven 仓库 中找到这些构件。

代码示例​

以下示例将名为 input.csv 的 CSV 文件读取为 PCollection，将其转换为 Row 对象（使用定义的模式），并使用 ClickHouseIO 插入到本地 ClickHouse 实例中：


package org.example;

import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.io.TextIO;
import org.apache.beam.sdk.io.clickhouse.ClickHouseIO;
import org.apache.beam.sdk.schemas.Schema;
import org.apache.beam.sdk.transforms.DoFn;
import org.apache.beam.sdk.transforms.ParDo;
import org.apache.beam.sdk.values.PCollection;
import org.apache.beam.sdk.values.Row;
import org.joda.time.DateTime;

public class Main {

    public static void main(String[] args) {
        // Create a Pipeline object.
        Pipeline p = Pipeline.create();

        Schema SCHEMA =
                Schema.builder()
                        .addField(Schema.Field.of("name", Schema.FieldType.STRING).withNullable(true))
                        .addField(Schema.Field.of("age", Schema.FieldType.INT16).withNullable(true))
                        .addField(Schema.Field.of("insertion_time", Schema.FieldType.DATETIME).withNullable(false))
                        .build();

        // Apply transforms to the pipeline.
        PCollection<String> lines = p.apply("ReadLines", TextIO.read().from("src/main/resources/input.csv"));

        PCollection<Row> rows = lines.apply("ConvertToRow", ParDo.of(new DoFn<String, Row>() {
            @ProcessElement
            public void processElement(@Element String line, OutputReceiver<Row> out) {

                String[] values = line.split(",");
                Row row = Row.withSchema(SCHEMA)
                        .addValues(values[0], Short.parseShort(values[1]), DateTime.now())
                        .build();
                out.output(row);
            }
        })).setRowSchema(SCHEMA);

        rows.apply("Write to ClickHouse",
                        ClickHouseIO.write("jdbc:clickhouse://localhost:8123/default?user=default&password=******", "test_table"));

        // Run the pipeline.
        p.run().waitUntilFinish();
    }
}

支持的数据类型​

ClickHouseApache Beam是否支持备注
TableSchema.TypeName.FLOAT32Schema.TypeName#FLOAT✅
TableSchema.TypeName.FLOAT64Schema.TypeName#DOUBLE✅
TableSchema.TypeName.INT8Schema.TypeName#BYTE✅
TableSchema.TypeName.INT16Schema.TypeName#INT16✅
TableSchema.TypeName.INT32Schema.TypeName#INT32✅
TableSchema.TypeName.INT64Schema.TypeName#INT64✅
TableSchema.TypeName.STRINGSchema.TypeName#STRING✅
TableSchema.TypeName.UINT8Schema.TypeName#INT16✅
TableSchema.TypeName.UINT16Schema.TypeName#INT32✅
TableSchema.TypeName.UINT32Schema.TypeName#INT64✅
TableSchema.TypeName.UINT64Schema.TypeName#INT64✅
TableSchema.TypeName.DATESchema.TypeName#DATETIME✅
TableSchema.TypeName.DATETIMESchema.TypeName#DATETIME✅
TableSchema.TypeName.ARRAYSchema.TypeName#ARRAY✅
TableSchema.TypeName.ENUM8Schema.TypeName#STRING✅
TableSchema.TypeName.ENUM16Schema.TypeName#STRING✅
TableSchema.TypeName.BOOLSchema.TypeName#BOOLEAN✅
TableSchema.TypeName.TUPLESchema.TypeName#ROW✅
TableSchema.TypeName.FIXEDSTRINGFixedBytes✅FixedBytes 是一个表示固定长度的
字节数组的 LogicalType，位于
org.apache.beam.sdk.schemas.logicaltypes 中
Schema.TypeName#DECIMAL❌
Schema.TypeName#MAP❌

ClickHouseIO.Write 参数​

您可以通过以下设置函数调整 ClickHouseIO.Write 配置：

参数设置函数参数类型默认值描述
withMaxInsertBlockSize(long maxInsertBlockSize)1000000要插入的行块的最大大小。
withMaxRetries(int maxRetries)5失败插入的最大重试次数。
withMaxCumulativeBackoff(Duration maxBackoff)Duration.standardDays(1000)重试的最大累积退避持续时间。
withInitialBackoff(Duration initialBackoff)Duration.standardSeconds(5)第一次重试之前的初始退避时间。
withInsertDistributedSync(Boolean sync)true如果为真，则为分布式表同步插入操作。
withInsertQuorum(Long quorum)null确认插入操作所需的副本数量。
withInsertDeduplicate(Boolean deduplicate)true如果为真，则为插入操作启用去重。
withTableSchema(TableSchema schema)null目标 ClickHouse 表的模式。

限制​

在使用该连接器时，请考虑以下限制：

  • 目前仅支持 Sink 操作。该连接器不支持 Source 操作。
  • ClickHouse 在插入到 ReplicatedMergeTree 或建立在 ReplicatedMergeTree 之上的 Distributed 表时执行去重。如果没有复制，成功重试之前插入失败的普通 MergeTree 可能会导致重复。然而，每个块是原子插入的，块大小可以使用 ClickHouseIO.Write.withMaxInsertBlockSize(long) 配置。去重是通过使用插入块的校验和实现的。有关去重的更多信息，请访问 去重 和 去重插入配置。
  • 该连接器不执行任何 DDL 语句，因此目标表必须在插入之前存在。

相关内容​