ClickHouse

Interact with ClickHouse, the high-performance columnar OLAP database, for high-throughput ingestion and OLAP queries.

What’s inside

ClickHouse component, URI syntax: clickhouse:database

Please refer to the above links for usage and configuration details.

Maven coordinates

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-clickhouse-starter</artifactId>
</dependency>

Spring Boot Auto-Configuration

The starter supports 9 options, which are listed below.

Name	Description	Default	Type
camel.component.clickhouse.autowired-enabled	Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.	true	Boolean
camel.component.clickhouse.client	The shared ClickHouse client to use for all endpoints, of type com.clickhouse.client.api.Client. When set, the endpoint-level connection options (serverUrl, username, password, ssl) are ignored. The option is a com.clickhouse.client.api.Client type.		Client
camel.component.clickhouse.compression	Whether to compress the insert request payload sent to the server (LZ4).	false	Boolean
camel.component.clickhouse.enabled	Whether to enable auto configuration of the clickhouse component. This is enabled by default.		Boolean
camel.component.clickhouse.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.clickhouse.password	The password used to authenticate to ClickHouse.		String
camel.component.clickhouse.server-url	The ClickHouse HTTP endpoint URL, e.g. http://localhost:8123. Can be overridden per endpoint. Required unless a shared Client bean is autowired or configured on the component.		String
camel.component.clickhouse.ssl	Whether to connect to ClickHouse over a secure (HTTPS) connection.	false	Boolean
camel.component.clickhouse.username	The username used to authenticate to ClickHouse.	default	String

Name

Description

Default

Type

camel.component.clickhouse.autowired-enabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

Boolean

camel.component.clickhouse.client

The shared ClickHouse client to use for all endpoints, of type com.clickhouse.client.api.Client. When set, the endpoint-level connection options (serverUrl, username, password, ssl) are ignored. The option is a com.clickhouse.client.api.Client type.

Client

camel.component.clickhouse.compression

Whether to compress the insert request payload sent to the server (LZ4).

false

Boolean

camel.component.clickhouse.enabled

Whether to enable auto configuration of the clickhouse component. This is enabled by default.

Boolean

camel.component.clickhouse.lazy-start-producer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

Boolean

camel.component.clickhouse.password

The password used to authenticate to ClickHouse.

String

camel.component.clickhouse.server-url

The ClickHouse HTTP endpoint URL, e.g. http://localhost:8123. Can be overridden per endpoint. Required unless a shared Client bean is autowired or configured on the component.

String

camel.component.clickhouse.ssl

Whether to connect to ClickHouse over a secure (HTTPS) connection.

false

Boolean

camel.component.clickhouse.username

The username used to authenticate to ClickHouse.

default

String