Advanced Analytica Advanced Analytica: IBOM
← All connectors
ClickHouse logo

Source connector

ClickHouse

Set up ClickHouse as a source and move its data into your chosen destination.

Version 0.4.0 community alpha

ClickHouse

Overview

The ClickHouse source supports Full Refresh and Incremental syncs. Choose whether the connector copies new or updated data, or all configured rows. This applies to your selected tables and columns whenever a sync runs.

The ClickHouse source connector builds on the source-jdbc code base and uses the ClickHouse JDBC driver. See the ClickHouse JDBC documentation for more information.

Resulting schema

The ClickHouse source preserves the schema in your warehouse. However, the connected destination may alter it. See the destination’s documentation for details.

Features

FeatureSupportedNotes
Full Refresh SyncYes
Incremental SyncYes
Replicate Incremental DeletesComing soon
Logical Replication (WAL)Coming soon
SSL SupportYes
SSH Tunnel ConnectionYes
NamespacesYesEnabled by default

Get started

Requirements

  1. ClickHouse Server 21.3.10.1 or later.
  2. A dedicated, read-only Airbyte user with access to every table needed for replication.

Setup guide

1. Confirm Airbyte can access your database

Access depends on your network setup. Use the check connection tool in the UI to confirm Airbyte can connect to your ClickHouse instance.

This optional step gives you better permission control and auditing. You can also connect Airbyte using an existing database user.

Run these commands against your database to create a dedicated user:

CREATE USER 'airbyte'@'%' IDENTIFIED BY 'your_password_here';

Then grant the user access to the relevant schema:

GRANT SELECT ON <database name>.* TO 'airbyte'@'%';

You can restrict this grant to specific tables instead of the entire database. To replicate multiple ClickHouse databases, run the command again for every relevant schema. You’ll need multiple sources connecting to the same db, with one source for each schema.

Your database user is now ready to use with Airbyte.

Connect through an SSH Tunnel

Airbyte can connect to a Clickhouse instance through an SSH Tunnel. Use this option when a direct database connection isn’t possible or breaches security policy. For example, the database may not have a public IP address.

With an SSH tunnel, Airbyte connects to an intermediate server (also called a bastion sever). This server has direct database access. Airbyte connects to the bastion, which then connects directly to the database server.

This feature needs additional configuration when you create the source. The following steps explain each configuration field.

  1. Configure the source fields as usual, except SSH Tunnel Method.
  2. SSH Tunnel Method defaults to No Tunnel (a direct connection). For an SSH Tunnel, choose SSH Key Authentication or Password Authentication.
    1. Choose Key Authentication when using an RSA private key to establish the SSH Tunnel. See below for information about generating this key.
    2. Choose Password Authentication when using a password to establish the SSH Tunnel.
  3. SSH Tunnel Jump Server Host identifies the intermediate (bastion) server that Airbyte connects to. Enter its hostname or IP Address.
  4. SSH Connection Port is the bastion server port used for the SSH connection. The default SSH port is 22. Keep this default unless you’ve explicitly changed the port.
  5. SSH Login Username is the username Airbyte uses to connect to the bastion server. It isn’t the Clickhouse username.
  6. When using Password Authentication, set SSH Login Username to the previous step’s User password. When using SSH Key Authentication, leave this field blank. This isn’t the Clickhouse password. It’s the OS-user password Airbyte uses to run commands on the bastion.
  7. When using SSH Key Authentication, set SSH Private Key to the RSA Private Key used for the SSH connection. Include the key file’s full contents, starting with -----BEGIN RSA PRIVATE KEY----- and ending with -----END RSA PRIVATE KEY-----.

IP allow list

If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Changelog

Expand to review
VersionDatePull RequestSubject
0.4.02026-07-1081633Breaking: Declare temporal column typing as breaking. Connections with schema evolution errors must follow the migration guide
0.3.12026-06-2972484Add JSON Schema format hints for temporal types (DateTime, Date) and fix documentation URL
0.3.02026-01-2775298Fold source-clickhouse-strict-encrypt into source-clickhouse
0.2.62025-11-0366714Revert JDBC driver upgrade
0.2.52025-09-2566482Upgrade ClickHouse JDBC driver from 0.3.2-patch10 to 0.9.0
0.2.42025-07-1062912Convert to new gradle build flow
0.2.32024-12-1849901Use a base image: airbyte/java-connector-base:1.0.0
0.2.22024-02-1335235Adopt CDK 0.20.4
0.2.12024-01-2434453bump CDK version
0.1.172023-03-2220760Removed redundant date-time datatypes formatting
0.1.162023-03-0623455For network isolation, source connector accepts a list of hosts it is allowed to connect to
0.1.152022-12-1420346Consolidate date/time values mapping for JDBC sources
0.1.142022-09-2717031Added custom jdbc url parameters field
0.1.132022-09-0116238Emit state messages more frequently
0.1.122022-08-1814356DB Sources: only show a table can sync incrementally if at least one column can be used as a cursor field
0.1.102022-04-1211514Bump mina-sshd from 2.7.0 to 2.8.0
0.1.92022-02-09#10214Fix exception in case password field is not provided
0.1.82022-02-1410256Add -XX:+ExitOnOutOfMemoryError JVM option
0.1.72021-12-24#8958Add support for JdbcType.ARRAY
0.1.62021-12-15#8429Update titles and descriptions
0.1.52021-12-01#8371Fixed incorrect handling “\n” in ssh key
0.1.420.10.2021#7327Added support for connection via SSH tunnel(aka Bastion server).
0.1.320.10.2021#7127Added SSL connections support.
0.1.213.08.2021#4699Added json config validator.

Changelog: source-clickhouse-strict-encrypt

Expand to review
VersionDatePull RequestSubject
0.2.62025-11-0366714Revert JDBC driver upgrade
0.2.52025-09-2566482Upgrade ClickHouse JDBC driver from 0.3.2-patch10 to 0.9.0
0.2.42025-07-1062913Convert to new gradle build flow
0.2.02023-12-1833485Remove LEGACY state
0.1.172022-03-2220760Removed redundant date-time datatypes formatting
0.1.162023-03-0623455For network isolation, source connector accepts a list of hosts it is allowed to connect to
0.1.152022-12-1420346Consolidate date/time values mapping for JDBC sources
2022-10-1315535Update incremental query to avoid data missing when new data is inserted at the same time as a sync starts under non-CDC incremental mode
0.1.142022-09-2717031Added custom jdbc url parameters field
0.1.132022-09-0116238Emit state messages more frequently
0.1.92022-08-1814356DB Sources: only show a table can sync incrementally if at least one column can be used as a cursor field
0.1.62022-02-09#10214Fix exception in case password field is not provided
0.1.52022-02-1410256Add -XX:+ExitOnOutOfMemoryError JVM option
0.1.32021-12-29#9182 #8958Add support for JdbcType.ARRAY. Fixed tests
0.1.22021-12-01#8371Fixed incorrect handling “\n” in ssh key
0.1.120.10.2021#7327Added support for connection via SSH tunnel(aka Bastion server).
0.1.020.10.2021#7127Added source-clickhouse-strict-encrypt that supports SSL connections only.
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.