Skip to content

Commit c912c03

Browse files
SamyOubouazizSamyOubouaziz
committed
feat(dwh): add connect BI tools page MTA-5801
1 parent 38ebab6 commit c912c03

File tree

1 file changed

+141
-4
lines changed

1 file changed

+141
-4
lines changed

‎pages/data-warehouse/how-to/connect-bi-tools.mdx‎

Lines changed: 141 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,147 @@ meta:
55
content:
66
h1: How to Connect Your Deployment to BI Tools
77
paragraph: Learn how to connect your Scaleway Data Warehouse for ClickHouse® deployment to Business Intelligence (BI) tools.
8-
tags: connect bi-tools deployment data warehouse clickhouse
8+
tags: connect bi-tools deployment data warehouse ClickHouse® integrate integration
99
dates:
10-
validation: 2025-05-07
11-
posted: 2025-05-07
10+
validation: 2025-05-19
11+
posted: 2025-05-19
1212
categories:
1313
- data-warehouse
14-
---
14+
---
15+
16+
This page explains how to integrate your Data Warehouse for ClickHouse® deployment with your preferred Business Intelligence (BI) tools.
17+
18+
<Macro id="requirements">
19+
20+
- A Scaleway account logged into the [console](https://console.scaleway.com)
21+
- [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization
22+
- [Signed up to the private beta](https://www.scaleway.com/fr/betas/) and received a confirmation email.
23+
- Created a [Data Warehouse deployment](/data-warehouse/how-to/create-deployment/)
24+
25+
## PowerBI
26+
27+
## Tableau
28+
29+
Tableau is a powerful data visualization and business intelligence tool that enables users to transform complex data into interactive and shareable dashboards and reports, providing actionable insights through intuitive drag-and-drop interfaces.
30+
31+
### Download and install the ClickHouse® connector for Tableau
32+
33+
5. Download and install [Tableau Desktop](https://www.tableau.com/products/desktop/download).
34+
35+
6. Follow the instructions for `clickhouse-tableau-connector-jdbc` to [download the compatible version](https://github.com/ClickHouse/clickhouse-java/releases/) of the ClickHouse® JDBC driver.
36+
37+
4. Store the JDBC driver in the `Drivers` folder. If the directory does not exist, create it:
38+
- macOS/Linux: `~/Library/Tableau/Drivers`
39+
- Windows: `C:\Program Files\Tableau\Drivers`
40+
41+
### Configure a ClickHouse® data source in Tableau
42+
43+
1. Start or restart Tableau.
44+
45+
2. From the **Connect** left-side menu, click on **More** under the **To a Server** section.
46+
47+
3. Select **ClickHouse® by ClickHouse®** from the connectors list.
48+
49+
4. Enter the following connection parameters:
50+
51+
6. Enter your connection details:
52+
53+
| Setting | Value |
54+
| -------- |--------------------------------------------------------|
55+
| Server | Your ClickHouse® host (with no prefixes or suffix) |
56+
| Port | 8443 |
57+
| Database | default |
58+
| Username | default |
59+
| Password | Password set at deployment creation |
60+
61+
<Message type="note">
62+
Make sure to enable the SSL if you are using ClickHouse® Cloud.
63+
</Message>
64+
65+
7. Click **Sign In**. A new Tableau workbook appears.
66+
67+
8. Select **default** from the **Schema** dropdown menu in the left side panel. A list of tables appear.
68+
69+
9. Your Data Warehouse for ClickHouse® is now integrated into your Tableau platform.
70+
71+
Refer to the official [ClickHouse®](https://clickhouse.com/docs/integrations/tableau) and [Tableau](https://exchange.tableau.com/products/1064) documentation portals for more information.
72+
73+
## Metabase
74+
75+
Metabase is an open-source business intelligence tool that allows users to create and share customizable dashboards and reports from various data sources.
76+
77+
Integrating ClickHouse® into Metabase enhances query performance and scalability, for faster data analysis on large datasets, and provides robust support for complex queries and real-time analytics.
78+
79+
### Download the ClickHouse® plugin for Metabase
80+
81+
1. Download the latest version of the plugin (JAR file named `clickhouse.metabase-driver.jar`) from the (official CLickHouse® GitHub repository)[https://github.com/clickhouse/metabase-clickhouse-driver/releases/latest].
82+
83+
2. Save `clickhouse.metabase-driver.jar` in your Metabase plugins folder.
84+
<Message type="note">
85+
If you do not have a If you do not have a **plugins** folder, create it in the same directory as the `metabase.jar` file. Refer to the [official Metabase documentation](https://www.metabase.com/docs/latest/developers-guide/drivers/basics) for more information on plugins.
86+
</Message>
87+
88+
3. Start (or restart) Metabase to load the new plugin.
89+
90+
4. Access your Metabase server.
91+
<Message type="note">
92+
On the initial startup, if prompted to select a database, select **I'll add my data later**.
93+
</Message>
94+
95+
### Connect Metabase to ClickHouse®
96+
97+
1. Click on the gear icon in the top-right corner and select **Admin Settings** to visit your Metabase admin page.
98+
99+
2. Click **Add a database**. Alternately, you can click the **Add database** button from the **Databases** tab.
100+
101+
3. If your driver installation worked, you will see ClickHouse® in the dropdown menu for Database type.
102+
103+
4. Enter a display name for your database.
104+
105+
5. Enter the credentials Data Warehouse for ClickHouse® deployment. Toggle on **Use a secure connection (SSL)**if your ClickHouse® server is configured to use SSL.
106+
107+
6. Click **Connect database** to finish.
108+
109+
Your Data Warehouse for ClickHouse® is now integrated into your Metabase platform.
110+
111+
Refer to the official [ClickHouse®](https://clickhouse.com/docs/integrations/metabase) and [Metabase](https://www.metabase.com/docs/latest/databases/connections/clickhouse) documentation portals for more information.
112+
113+
## PowerBI
114+
115+
Power BI Desktop is a robust data visualization tool that allows users to create dynamic reports and dashboards from various data sources. Before connecting your Data Warehouse for ClickHouse® deployment, Make sure you have downloaded and installed [Power BI Desktop](https://www.microsoft.com/en-us/download/details.aspx?id=58494) (version **2.137.751.0** or newer).
116+
117+
### Install the ODBC Driver
118+
119+
1. Download the most recent [ClickHouse ODBC release](https://github.com/ClickHouse/clickhouse-odbc/releases).
120+
121+
2. Execute the `.msi` installer and follow the steps in the wizard.
122+
<Message type="note">
123+
The installation of **Debug symbols** is optional.
124+
</Message>
125+
126+
3. Once the installation is complete, open **ODBC Data Sources (64-bit)** from the **Start menu**.
127+
128+
4. Make sure the ClickHouse ODBC Driver is listed.
129+
130+
### Connect PowerBI to ClickHouse®
131+
132+
1. Open PowerBI Desktop.
133+
134+
2. Click **Get Data** in the Toolbar of the home screen.
135+
136+
3. Select ClickHouse® from the list, then click **Connect**.
137+
138+
4. Enter the information below, then click **OK**.
139+
140+
| Setting | Value |
141+
| -------- |--------------------------------------------------------|
142+
| Server | Your ClickHouse® host (with no prefixes/suffixes) |
143+
| Port | 8443 |
144+
| Database | default |
145+
| Data Connectivity mode | DirectQuery |
146+
147+
5. Enter your **user name** and **password**, then click **Connect.
148+
149+
Your Data Warehouse for ClickHouse® deployment is now integrated into PowerBI Desktop.
150+
151+
Refer to the official [ClickHouse®](https://clickhouse.com/docs/integrations/powerbi) and [PowerBI](https://learn.microsoft.com/en-us/power-query/connectors/clickhouse) documentation portals for more information.

0 commit comments

Comments
 (0)