Skip to content

Commit 742ebf2

Browse files
authored
Merge pull request #4039 from ClickHouse/confluent-platform
2 parents 8ddcb0d + de80eac commit 742ebf2

File tree

5 files changed

+76
-9
lines changed

5 files changed

+76
-9
lines changed
Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
sidebar_label: 'Kafka Connector Sink on Confluent Cloud'
3+
sidebar_position: 2
4+
slug: /integrations/kafka/cloud/confluent/custom-connector-cloud
5+
description: 'Guide to using the fully managed ClickHouse Connector Sinkon Confluent Cloud'
6+
title: 'Integrating Confluent Cloud with ClickHouse'
7+
keywords: ['Kafka', 'Confluent Cloud']
8+
---
9+
10+
import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.mdx';
11+
import Image from '@theme/IdealImage';
12+
13+
# Integrating Confluent Cloud with ClickHouse
14+
15+
<div class='vimeo-container'>
16+
<iframe src="//www.youtube.com/embed/SQAiPVbd3gg"
17+
width="640"
18+
height="360"
19+
frameborder="0"
20+
allow="autoplay;
21+
fullscreen;
22+
picture-in-picture"
23+
allowfullscreen>
24+
</iframe>
25+
</div>
26+
27+
## Prerequisites {#prerequisites}
28+
We assume you are familiar with:
29+
* [ClickHouse Connector Sink](../kafka-clickhouse-connect-sink.md)
30+
* Confluent Cloud
31+
32+
## The official Kafka connector from ClickHouse with Confluent Cloud {#the-official-kafka-connector-from-clickhouse-with-confluent-cloud}
33+
34+
### Installing on Confluent Cloud {#installing-on-confluent-cloud}
35+
This is meant to be a quick guide to get you started with the ClickHouse Sink Connector on Confluent Cloud.
36+
For more details, please refer to the [official Confluent documentation](https://docs.confluent.io/cloud/current/connectors/bring-your-connector/custom-connector-qs.html#uploading-and-launching-the-connector).
37+
38+
#### Create a Topic {#create-a-topic}
39+
Creating a topic on Confluent Cloud is fairly simple, and there are detailed instructions [here](https://docs.confluent.io/cloud/current/client-apps/topics/manage.html).
40+
41+
#### Important notes {#important-notes}
42+
43+
* The Kafka topic name must be the same as the ClickHouse table name. The way to tweak this is by using a transformer (for example [`ExtractTopic`](https://docs.confluent.io/platform/current/connect/transforms/extracttopic.html)).
44+
* More partitions does not always mean more performance - see our upcoming guide for more details and performance tips.
45+
46+
#### Gather your connection details {#gather-your-connection-details}
47+
<ConnectionDetails />
48+
49+
50+
#### Install Connector {#install-connector}
51+
Install the fully managed ClickHouse Sink Connector on Confluent Cloud following the [official documentation](https://docs.confluent.io/cloud/current/connectors/cc-clickhouse-sink-connector/cc-clickhouse-sink.html).
52+
53+
54+
#### Configure the Connector {#configure-the-connector}
55+
During the configuration of the ClickHouse Sink Connector, you will need to provide the following details:
56+
- hostname of your ClickHouse server
57+
- port of your ClickHouse server (default is 8443)
58+
- username and password for your ClickHouse server
59+
- database name in ClickHouse where the data will be written
60+
- topic name in Kafka that will be used to write data to ClickHouse
61+
62+
The Confluent Cloud UI supports advanced configuration options to adjust poll intervals, batch sizes, and other parameters to optimize performance.
63+
64+
#### Known limitations {#known-limitations}
65+
* See the list of [Connectors limitations in the official docs](https://docs.confluent.io/cloud/current/connectors/cc-clickhouse-sink-connector/cc-clickhouse-sink.html#limitations)

docs/integrations/data-ingestion/kafka/confluent/custom-connector.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: 'Kafka Connector Sink on Confluent Platform'
3-
sidebar_position: 2
3+
sidebar_position: 3
44
slug: /integrations/kafka/cloud/confluent/custom-connector
55
description: 'Using ClickHouse Connector Sink with Kafka Connect and ClickHouse'
66
title: 'Integrating Confluent Cloud with ClickHouse'
@@ -10,7 +10,7 @@ import ConnectionDetails from '@site/docs/_snippets/_gather_your_details_http.md
1010
import Image from '@theme/IdealImage';
1111
import AddCustomConnectorPlugin from '@site/static/images/integrations/data-ingestion/kafka/confluent/AddCustomConnectorPlugin.png';
1212

13-
# Integrating Confluent Cloud with ClickHouse
13+
# Integrating Confluent platform with ClickHouse
1414

1515
<div class='vimeo-container'>
1616
<iframe src="//www.youtube.com/embed/SQAiPVbd3gg"
@@ -27,16 +27,16 @@ import AddCustomConnectorPlugin from '@site/static/images/integrations/data-inge
2727
## Prerequisites {#prerequisites}
2828
We assume you are familiar with:
2929
* [ClickHouse Connector Sink](../kafka-clickhouse-connect-sink.md)
30-
* Confluent Cloud and [Custom Connectors](https://docs.confluent.io/cloud/current/connectors/bring-your-connector/overview.html).
30+
* Confluent Platform and [Custom Connectors](https://docs.confluent.io/cloud/current/connectors/bring-your-connector/overview.html).
3131

32-
## The official Kafka connector from ClickHouse with Confluent Cloud {#the-official-kafka-connector-from-clickhouse-with-confluent-cloud}
32+
## The official Kafka connector from ClickHouse with Confluent Platform {#the-official-kafka-connector-from-clickhouse-with-confluent-platform}
3333

34-
### Installing on Confluent Cloud {#installing-on-confluent-cloud}
35-
This is meant to be a quick guide to get you started with the ClickHouse Sink Connector on Confluent Cloud.
34+
### Installing on Confluent platform {#installing-on-confluent-platform}
35+
This is meant to be a quick guide to get you started with the ClickHouse Sink Connector on Confluent Platform.
3636
For more details, please refer to the [official Confluent documentation](https://docs.confluent.io/cloud/current/connectors/bring-your-connector/custom-connector-qs.html#uploading-and-launching-the-connector).
3737

3838
#### Create a Topic {#create-a-topic}
39-
Creating a topic on Confluent Cloud is fairly simple, and there are detailed instructions [here](https://docs.confluent.io/cloud/current/client-apps/topics/manage.html).
39+
Creating a topic on Confluent Platform is fairly simple, and there are detailed instructions [here](https://docs.confluent.io/cloud/current/client-apps/topics/manage.html).
4040

4141
#### Important Notes {#important-notes}
4242

docs/integrations/data-ingestion/kafka/confluent/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,5 +10,6 @@ title: 'Integrating Confluent Cloud with ClickHouse'
1010

1111
Confluent platform provides two options to integration with ClickHouse
1212

13-
* [ClickHouse Connect Sink on Confluent Cloud](./custom-connector.md) using the custom connectors feature
13+
* [ClickHouse Connect Sink on Confluent Cloud](./confluent-cloud.md)
14+
* [ClickHouse Connect Sink on Confluent Platform](./custom-connector.md) using the custom connectors feature
1415
* [HTTP Sink Connector for Confluent Platform](./kafka-connect-http.md) that integrates Apache Kafka with an API via HTTP or HTTPS

docs/integrations/data-ingestion/kafka/confluent/kafka-connect-http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
sidebar_label: 'HTTP Sink Connector for Confluent Platform'
3-
sidebar_position: 3
3+
sidebar_position: 4
44
slug: /integrations/kafka/cloud/confluent/http
55
description: 'Using HTTP Connector Sink with Kafka Connect and ClickHouse'
66
title: 'Confluent HTTP Sink Connector'

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -839,6 +839,7 @@ const sidebars = {
839839
items: [
840840
"integrations/data-ingestion/kafka/index",
841841
"integrations/data-ingestion/kafka/kafka-clickhouse-connect-sink",
842+
"integrations/data-ingestion/kafka/confluent/confluent-cloud",
842843
"integrations/data-ingestion/kafka/confluent/custom-connector",
843844
"integrations/data-ingestion/kafka/msk/index",
844845
"integrations/data-ingestion/kafka/kafka-vector",

0 commit comments

Comments
 (0)