Skip to main content
Skip to main content
Edit this page

Connect BladePipe to ClickHouse

Community Maintained

BladePipe is a real-time end-to-end data integration tool with sub-second latency, boosting seamless data flow across platforms.

ClickHouse is one of BladePipe's pre-built connectors, allowing users to integrate data from various sources into ClickHouse automatically. This page will show how to load data into ClickHouse in real time step by step.

Supported sources​

Currently BladePipe supports for data integration to ClickHouse from the following sources:

  • MySQL/MariaDB/AuroraMySQL
  • Oracle
  • PostgreSQL/AuroraPostgreSQL
  • MongoDB
  • Kafka
  • PolarDB-MySQL
  • OceanBase
  • TiDB

More sources are to be supported.

Download and run BladePipe​

  1. Log in to BladePipe Cloud.

  2. Follow the instructions in Install Worker (Docker) or Install Worker (Binary) to download and install a BladePipe Worker.

Note

Alternatively, you can download and deploy BladePipe Enterprise.

Add ClickHouse as a target​

Note
  1. BladePipe supports ClickHouse version 20.12.3.3 or above.
  2. To use ClickHouse as a target, make sure that the user has SELECT, INSERT and common DDL permissions.

  1. In BladePipe, click "DataSource" > "Add DataSource".

  2. Select ClickHouse, and fill out the settings by providing your ClickHouse host and port, username and password, and click "Test Connection".

  3. Click "Add DataSource" at the bottom, and a ClickHouse instance is added.

Add MySQL as a source​

In this tutorial, we use a MySQL instance as the source, and explain the process of loading MySQL data to ClickHouse.

Note

To use MySQL as a source, make sure that the user has the required permissions.

  1. In BladePipe, click "DataSource" > "Add DataSource".

  2. Select MySQL, and fill out the settings by providing your MySQL host and port, username and password, and click "Test Connection".

  3. Click "Add DataSource" at the bottom, and a MySQL instance is added.

Create a pipeline​

  1. In BladePipe, click "DataJob" > "Create DataJob".

  2. Select the added MySQL and ClickHouse instances and click "Test Connection" to ensure BladePipe is connected to the instances. Then, select the databases to be moved.

  3. Select "Incremental" for DataJob Type, together with the "Full Data" option.

  4. Select the tables to be replicated.

  5. Select the columns to be replicated.

  6. Confirm the DataJob creation, and the DataJob runs automatically.

Verify the data​

  1. Stop data write in MySQL instance and wait for ClickHouse to merge data.
Note

Due to the unpredictable timing of ClickHouse's automatic merging, you can manually trigger a merging by running the OPTIMIZE TABLE xxx FINAL; command. Note that there is a chance that this manual merging may not always succeed.

Alternatively, you can run the CREATE VIEW xxx_v AS SELECT * FROM xxx FINAL; command to create a view and perform queries on the view to ensure the data is fully merged.

  1. Create a Verification DataJob. Once the Verification DataJob is completed, review the results to confirm that the data in ClickHouse is the same as the data in MySQL.