> ## Documentation Index
> Fetch the complete documentation index at: https://private-7c7dfe99-postgresql-tls-support.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
> Apache Superset is an open-source data exploration and visualization platform.
# Connect Superset to ClickHouse
export const ClickHouseSupportedBadge = () => {
return ;
};
export const Image = ({img, alt, size = "lg"}) => {
const normalizedSize = ["sm", "md", "lg"].includes(size) ? size : "lg";
return ;
};
Apache Superset is an open-source data exploration and visualization platform written in Python. Superset connects to ClickHouse using a Python driver provided by ClickHouse. Let's see how it works...
Goal
In this guide you will build a dashboard in Superset with data from a ClickHouse database. The dashboard will look like this:
**Add some data**
If you don't have a dataset to work with you can add one of the examples. This guide uses the [UK Price Paid](/get-started/sample-datasets/uk-price-paid) dataset, so you might choose that one. There are several others to look at in the same documentation category.
To connect to ClickHouse with HTTP(S) you need this information:
| Parameter(s) | Description |
| ------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `HOST` and `PORT` | Typically, the port is 8443 when using TLS or 8123 when not using TLS. |
| `DATABASE NAME` | Out of the box, there is a database named `default`, use the name of the database that you want to connect to. |
| `USERNAME` and `PASSWORD` | Out of the box, the username is `default`. Use the username appropriate for your use case. |
The details for your ClickHouse Cloud service are available in the ClickHouse Cloud console.
Select a service and click **Connect**:
Choose **HTTPS**. Connection details are displayed in an example `curl` command.
If you're using self-managed ClickHouse, the connection details are set by your ClickHouse administrator.
1. Superset uses the `clickhouse-connect` driver to connect to ClickHouse. The details of `clickhouse-connect` are at [https://pypi.org/project/clickhouse-connect/](https://pypi.org/project/clickhouse-connect/) and it can be installed with the following command:
```console theme={null}
pip install clickhouse-connect
```
**Docker Compose Setup**
For Docker-based installations, see the [Superset database configuration guide](https://superset.apache.org/user-docs/6.0.0/configuration/databases/) for instructions on adding `clickhouse-connect` to your container.
2. Start (or restart) Superset.
1. Within Superset, select **Data** from the top menu and then **Databases** from the drop-down menu. Add a new database by clicking the **+ Database** button:
2. In the first step, select **ClickHouse Connect** as the type of database:
3. In the second step:
* Set SSL on or off.
* Enter the connection information that you collected earlier
* Specify the **DISPLAY NAME**: this can be any name you prefer. If you will be connecting to multiple ClickHouse databases then make the name more descriptive.
4. Click the **CONNECT** and then **FINISH** buttons to complete the setup wizard, and you should see your database in the list of databases.
1. To interact with your ClickHouse data with Superset, you need to define a ***dataset***. From the top menu in Superset, select **Data**, then **Datasets** from the drop-down menu.
2. Click the button for adding a dataset. Select your new database as the datasource and you should see the tables defined in your database:
3. Click the **ADD** button at the bottom of the dialog window and your table appears in the list of datasets. You're ready to build a dashboard and analyze your ClickHouse data!
If you're familiar with Superset, then you will feel right at home with this next section. If you're new to Superset, well...it's like a lot of the other cool visualization tools out there in the world - it doesn't take long to get started, but the details and nuances get learned over time as you use the tool.
1. You start with a dashboard. From the top menu in Superset, select **Dashboards**. Click the button in the upper-right to add a new dashboard. The following dashboard is named **UK property prices**:
2. To create a new chart, select **Charts** from the top menu and click the button to add a new chart. You will be shown a lot of options. The following example shows a **Pie Chart** chart using the **uk\_price\_paid** dataset from the **CHOOSE A DATASET** drop-down:
3. Superset pie charts need a **Dimension** and a **Metric**, the rest of the settings are optional. You can pick your own fields for the dimension and metric, this example uses the ClickHouse field `district` as the dimension and `AVG(price)` as the metric.
5. If you prefer doughnut charts over pie, then you can set that and other options under **CUSTOMIZE**:
6. Click the **SAVE** button to save the chart, then select **UK property prices** under the **ADD TO DASHBOARD** drop-down, then **SAVE & GO TO DASHBOARD** saves the chart and adds it to the dashboard:
7. That's it. Building dashboards in Superset based on data in ClickHouse opens up a whole world of blazing fast data analytics!
