ClickHouse

This page describes how to integrate WarpStream with ClickHouse, ingest data from WarpStream into ClickHouse, and query the data in ClickHouse.

A video walkthrough can be found below:

Prerequisites

1. WarpStream account - get access to WarpStream by registering here.
2. ClickHouse account - get access to ClickHouse by registering here.
3. A WarpStream cluster is up and running.

Step 1: Create a topic in your WarpStream cluster

Obtain the Bootstrap Broker from the WarpStream console by navigating to your cluster and clicking the Connect tab. If you don't have SASL credentials, you can also create a set of credentials from the console.

Store these values as environment variables for easy reference:

export BOOTSTRAP_HOST=<YOUR_BOOTSTRAP_BROKER> \
SASL_USERNAME=<YOUR_SASL_USERNAME> \
SASL_PASSWORD=<YOUR_SASL_PASSWORD>;

Then, if you don't already have an available topic, create one using the WarpStream CLI or in the UI, then follow Step 2:

warpstream kcmd -bootstrap-host $BOOTSTRAP_HOST -tls -username $SASL_USERNAME -password $SASL_PASSWORD -type create-topic -topic clickhouse_demo

You should see the following output in your Terminal:

Created topic clickhouse_demo.

Step 2: Produce some records

Using the WarpStream CLI, produce several messages to your topic:

warpstream kcmd -bootstrap-host $BOOTSTRAP_HOST -tls -username $SASL_USERNAME -password $SASL_PASSWORD -type produce -topic clickhouse_demo --records '{"action": "click", "user_id": "user_0", "page_id": "home"},,{"action": "hover", "user_id": "user_0", "page_id": "home"},,{"action": "scroll", "user_id": "user_0", "page_id": "home"},,{"action": "click", "user_id": "user_1", "page_id": "home"},,{"action": "click", "user_id": "user_1", "page_id": "home"},,{"action": "click", "user_id": "user_2", "page_id": "home"}'

Note that the WarpStream CLI uses double commas (,,) as a delimiter between JSON records.

Step 3: Connect ClickHouse to WarpStream

In the ClickHouse dashboard, navigate to "Data sources" and then click "Get started":

ClickHouse Data sources

Select WarpStream from the list of options:

Fill in the fields using the data you generated in Step 1:

Next, select the incoming data format (JSON or AVRO) and then the topic. For this example, we use JSON format, and we have topics 'products' and 'reviews'. We'll use 'products', and ClickHouse will display a record from the Producer to confirm.

The data is then parsed, and you will then have the opportunity to make additional changes to the table that will be produced:

Step 4: Query your data in ClickHouse

We now see our WarpStream pipe ingesting data into ClickHouse. Next, select 'SQL Console' in the left-hand navigation to interact with your new ClickHouse table.

We can now take full advantage of ClickHouse's power with WarpStream data. A simple SQL SELECT command is illustrated below:

Next Steps

Congratulations! You've set up a stream processing pipeline between WarpStream and ClickHouse and performed a basic SQL query. This is just the beginning of what you can do.

Next, check out the WarpStream docs for configuring the WarpStream Agent, or review the ClickHouse docs to learn more about what is possible with WarpStream and ClickHouse!