Skip to content

chore: fix image links in clickhouse docs #2854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 4, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ import ConnectionDetails from '@site/docs/en/_snippets/_gather_your_details_http

## Goal

In this guide you will build a dashboard in Superset with data from a ClickHouse database. The dashboard will look like this:
In this guide you will build a dashboard in Superset with data from a ClickHouse database. The dashboard will look like this:

<img src={require('./images/superset_12.png').default} class="image" alt="New Dashboard" />
<p/>
![New Dashboard](./images/superset_12.png)

:::tip Add some data
If you do not have a dataset to work with you can add one of the examples. This guide uses the [UK Price Paid](/docs/en/getting-started/example-datasets/uk-price-paid.md) dataset, so you might choose that one. There are several others to look at in the same documentation category.
If you do not have a dataset to work with you can add one of the examples. This guide uses the [UK Price Paid](/docs/en/getting-started/example-datasets/uk-price-paid.md) dataset, so you might choose that one. There are several others to look at in the same documentation category.
:::

## 1. Gather your connection details
Expand All @@ -39,18 +38,18 @@ If you do not have a dataset to work with you can add one of the examples. This

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:

<img src={require('./images/superset_01.png').default} class="image" alt="Add a new database" />
![Add a new database](./images/superset_01.png)

2. In the first step, select **ClickHouse Connect** as the type of database:

<img src={require('./images/superset_02.png').default} class="image" alt="Select ClickHouse" />
![Select Clickhouse](./images/superset_02.png)

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.

<img src={require('./images/superset_03.png').default} class="image" alt="Test the connection" />
![Test the connection](./images/superset_03.png)

4. Click the **CONNECT** and then **FINISH** buttons to complete the setup wizard, and you should see your database in the list of databases.

Expand All @@ -60,7 +59,7 @@ If you do not have a dataset to work with you can add one of the examples. This

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:

<img src={require('./images/superset_04.png').default} class="image" alt="New dataset" />
![New dataset](./images/superset_04.png)


3. Click the **ADD** button at the bottom of the dialog window and your table appears in the list of datasets. You are ready to build a dashboard and analyze your ClickHouse data!
Expand All @@ -72,28 +71,28 @@ If you are familiar with Superset, then you will feel right at home with this ne

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**:

<img src={require('./images/superset_05.png').default} class="image" alt="New dashboard" />
![New dashboard](./images/superset_05.png)

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:

<img src={require('./images/superset_06.png').default} class="image" alt="New chart" />
![New chart](./images/superset_06.png)

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.
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.

<img src={require('./images/superset_08.png').default} class="image" alt="The SUM metric" />
<img src={require('./images/superset_09.png').default} class="image" alt="The SUM metric" />
![The SUM metric](./images/superset_08.png)
![The SUM metric](./images/superset_09.png)

5. If you prefer donut charts over pie, then you can set that and other options under **CUSTOMIZE**:

<img src={require('./images/superset_10.png').default} class="image" alt="Add Chart to Dashboard" />
![Add Chart to Dashboard](./images/superset_10.png)

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:

<img src={require('./images/superset_11.png').default} class="image" alt="Add Chart to Dashboard" />
![Add Chart to Dashboard](./images/superset_11.png)

7. That's it. Building dashboards in Superset based on data in ClickHouse opens up a whole world of blazing fast data analytics!

<img src={require('./images/superset_12.png').default} class="image" alt="New Dashboard" />
![New Dashboard](./images/superset_12.png)

## Related Content

Expand Down
Loading