Skip to main content
Version: 2.3.0-beta

Clickhouse

Clickhouse source connector

Description

Used to read data from Clickhouse.

Key features

supports query SQL and can achieve projection effect.

tip

Reading data from Clickhouse can also be done using JDBC

Options

nametyperequireddefault value
hoststringyes-
databasestringyes-
sqlstringyes-
usernamestringyes-
passwordstringyes-
schemaconfigNo-
common-optionsno-

host [string]

ClickHouse cluster address, the format is host:port , allowing multiple hosts to be specified. Such as "host1:8123,host2:8123" .

database [string]

The ClickHouse database

sql [string]

The query sql used to search data though Clickhouse server

username [string]

ClickHouse user username

password [string]

ClickHouse user password

schema [Config]

fields [Config]

the schema fields of upstream data

common options

Source plugin common parameters, please refer to Source Common Options for details

Examples

source {

Clickhouse {
host = "localhost:8123"
database = "default"
sql = "select * from test where age = 20 limit 100"
username = "default"
password = ""
result_table_name = "test"
}

}

Changelog

2.2.0-beta 2022-09-26

  • Add ClickHouse Source Connector

2.3.0-beta 2022-10-20

  • [Improve] Clickhouse Source random use host when config multi-host (3108)